{ "openapi": "3.1.0", "info": { "title": "CurrentClient Public API", "description": "The supported public surface of the CurrentClient API. Endpoints not listed here are internal and may change without notice.", "version": "4d88e38" }, "paths": { "/api/v1/contacts/": { "get": { "tags": [ "contacts" ], "summary": "Read Contacts", "description": "Get contact records", "operationId": "read_contacts_api_v1_contacts__get", "parameters": [ { "in": "query", "name": "limit", "description": "Pagination page size", "schema": { "title": "Pagination Limit", "description": "Pagination page size", "anyOf": [ { "type": "integer", "maximum": 200, "minimum": 10 }, { "type": "null" } ], "default": 100 }, "style": "form" }, { "in": "query", "name": "cursor", "description": "Pagination cursor provided by previous paginated response", "schema": { "title": "Pagination Cursor", "description": "Pagination cursor provided by previous paginated response", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "useSegment", "description": "Segment results based on the saved segment using the provided segment ID", "schema": { "title": "Use Segment", "description": "Segment results based on the saved segment using the provided segment ID", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "versions", "description": "Return all versions of all contacts", "schema": { "title": "All versions", "description": "Return all versions of all contacts", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "useFilter", "description": "Filter results using Field:Operator:Value [ Regex: ([A-Za-z0-9:]+):(eq|ne|like|notlike|contains|beginswith|isin|between|notcontains|gt|gte|lt|lte|exists|notexists):([\\w\\d\\s.,_@/#&+-]*) ]", "schema": { "title": "Use Filter", "description": "Filter results using Field:Operator:Value [ Regex: ([A-Za-z0-9:]+):(eq|ne|like|notlike|contains|beginswith|isin|between|notcontains|gt|gte|lt|lte|exists|notexists):([\\w\\d\\s.,_@/#&+-]*) ]", "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "([A-Za-z0-9:]+):(eq|ne|like|notlike|contains|beginswith|isin|between|notcontains|gt|gte|lt|lte|exists|notexists):([\\w\\d\\s.,_@/#&+-]*)" } }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "userId", "description": "Admin Only: Id for the owner of the resource", "schema": { "title": "User Id", "description": "Admin Only: Id for the owner of the resource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactsPaginated" } } } }, "400": { "description": "Invalid user request", "content": { "application/json": { "example": { "detail": "A message for why the request is invalid" } } } }, "500": { "description": "Server error", "content": { "application/json": { "example": { "detail": "A message for why the server failed" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "JWTBearer": [] } ] }, "post": { "tags": [ "contacts" ], "summary": "Create Contacts", "description": "Create contact record", "operationId": "create_contacts_api_v1_contacts__post", "parameters": [ { "in": "query", "name": "userId", "description": "Admin Only: Id for the owner of the resource", "schema": { "title": "User Id", "description": "Admin Only: Id for the owner of the resource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "sync", "schema": { "title": "Sync from CRM", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "isVerifyNumbers", "schema": { "title": "Verify numbers", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "title": "Contacts In", "type": "array", "items": { "$ref": "#/components/schemas/ContactCreate" } } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Create Contacts Api V1 Contacts Post", "type": "array", "items": { "$ref": "#/components/schemas/Contact-Output" } } } } }, "400": { "description": "Invalid user request", "content": { "application/json": { "example": { "detail": "A message for why the request is invalid" } } } }, "500": { "description": "Server error", "content": { "application/json": { "example": { "detail": "A message for why the server failed" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "JWTBearer": [] } ] } }, "/api/v1/contacts/{id}": { "get": { "tags": [ "contacts" ], "summary": "Read Contact", "description": "Get contact record", "operationId": "read_contact_api_v1_contacts__id__get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "title": "Id", "type": "string" }, "style": "simple" }, { "in": "query", "name": "versions", "description": "Include all the versions for the contact", "schema": { "title": "Versions", "description": "Include all the versions for the contact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "userId", "description": "Admin Only: Id for the owner of the resource", "schema": { "title": "User Id", "description": "Admin Only: Id for the owner of the resource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "teamMemberUserId", "description": "Admin Only: Team Member User Id for the owner of the resource", "schema": { "title": "Team Member User Id", "description": "Admin Only: Team Member User Id for the owner of the resource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact-Output" } } } }, "400": { "description": "Invalid user request", "content": { "application/json": { "example": { "detail": "A message for why the request is invalid" } } } }, "500": { "description": "Server error", "content": { "application/json": { "example": { "detail": "A message for why the server failed" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "JWTBearer": [] } ] }, "put": { "tags": [ "contacts" ], "summary": "Update Contact", "description": "Update contact record", "operationId": "update_contact_api_v1_contacts__id__put", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "title": "Id", "type": "string" }, "style": "simple" }, { "in": "query", "name": "inPlace", "description": "Update the record in place, dont version it", "schema": { "title": "In Place Update", "description": "Update the record in place, dont version it", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "style": "form" }, { "in": "query", "name": "connectSync", "description": "Update the record in place with the sync info, dont version it", "schema": { "title": "Connect sync id", "description": "Update the record in place with the sync info, dont version it", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "style": "form" }, { "in": "query", "name": "isAddTag", "description": "Add the tags, dont replace", "schema": { "title": "Add tag", "description": "Add the tags, dont replace", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "style": "form" }, { "in": "query", "name": "userId", "description": "Admin Only: Id for the owner of the resource", "schema": { "title": "User Id", "description": "Admin Only: Id for the owner of the resource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdate" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdate" } } } }, "400": { "description": "Invalid user request", "content": { "application/json": { "example": { "detail": "A message for why the request is invalid" } } } }, "500": { "description": "Server error", "content": { "application/json": { "example": { "detail": "A message for why the server failed" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "JWTBearer": [] } ] } }, "/api/v1/inboxes/": { "get": { "tags": [ "inboxes" ], "summary": "List Inboxes", "description": "Get list of inboxes", "operationId": "list_inboxes_api_v1_inboxes__get", "parameters": [ { "in": "query", "name": "cursor", "description": "Pagination cursor provided by previous paginated response", "schema": { "title": "Pagination Cursor", "description": "Pagination cursor provided by previous paginated response", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "showHidden", "description": "Show hidden inboxes", "schema": { "title": "Show Hidden", "description": "Show hidden inboxes", "type": "boolean", "default": false }, "style": "form" }, { "in": "query", "name": "showMuted", "description": "Show muted inboxes", "schema": { "title": "Show Muted", "description": "Show muted inboxes", "type": "boolean", "default": true }, "style": "form" }, { "in": "query", "name": "showWorkspace", "description": "Show inboxes for the entire workspace", "schema": { "title": "Show Workspace", "description": "Show inboxes for the entire workspace", "type": "boolean", "default": false }, "style": "form" }, { "in": "query", "name": "userId", "description": "Admin Only: Id for the owner of the resource", "schema": { "title": "User Id", "description": "Admin Only: Id for the owner of the resource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "teamMemberUserId", "description": "Admin Only: Team Member User Id for the owner of the resource", "schema": { "title": "Team Member User Id", "description": "Admin Only: Team Member User Id for the owner of the resource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "workspaceId", "description": "Workspace Id to get data for", "schema": { "title": "Workspace Id", "description": "Workspace Id to get data for", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InboxPagination" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "JWTBearer": [] } ] } }, "/api/v1/profile": { "get": { "tags": [ "profiles" ], "summary": "Read Userprofile", "description": "Get user profile record", "operationId": "read_userprofile_api_v1_profile_get", "parameters": [ { "in": "query", "name": "userId", "description": "Admin Only: Id for the owner of the user", "schema": { "title": "User Owner Id", "description": "Admin Only: Id for the owner of the user", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "style": "form" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserProfile" } } } }, "400": { "description": "Invalid user request", "content": { "application/json": { "example": { "detail": "A message for why the request is invalid" } } } }, "401": { "description": "Unauthorized request", "content": { "application/json": { "example": { "detail": "A message for why the request is invalid" } } } }, "403": { "description": "Unauthorized request", "content": { "application/json": { "example": { "detail": "A message for why the request is invalid" } } } }, "500": { "description": "Server error", "content": { "application/json": { "example": { "detail": "A message for why the server failed" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "JWTBearer": [] } ] } }, "/api/v1/calls": { "get": { "summary": "List calls", "description": "Returns calls visible to the authenticated caller, most recent first.", "operationId": "listCalls", "parameters": [ { "in": "query", "name": "contactNumber", "schema": { "type": [ "string", "null" ] }, "style": "form" }, { "in": "query", "name": "cursor", "schema": { "type": [ "string", "null" ] }, "style": "form" }, { "in": "query", "name": "direction", "schema": { "anyOf": [ { "$ref": "#/components/schemas/Direction" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "dispositionId", "schema": { "type": [ "string", "null" ] }, "style": "form" }, { "in": "query", "name": "isAgentCall", "schema": { "type": [ "boolean", "null" ] }, "style": "form" }, { "in": "query", "name": "isContact", "schema": { "type": [ "boolean", "null" ] }, "style": "form" }, { "in": "query", "name": "isVoicemail", "schema": { "type": [ "boolean", "null" ] }, "style": "form" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "format": "uint16", "default": 100, "maximum": 65535, "minimum": 0 }, "style": "form" }, { "in": "query", "name": "search", "schema": { "type": [ "string", "null" ] }, "style": "form" }, { "in": "query", "name": "since", "schema": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "until", "schema": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "userNumber", "schema": { "type": [ "string", "null" ] }, "style": "form" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Paginated_for_Call" } } } } }, "security": [ { "JWTBearer": [] } ] } }, "/api/v1/messages": { "get": { "summary": "List messages", "description": "Returns messages visible to the authenticated caller, most recent first.", "operationId": "listMessages", "parameters": [ { "in": "query", "name": "contactNumber", "schema": { "type": [ "string", "null" ] }, "style": "form" }, { "in": "query", "name": "cursor", "schema": { "type": [ "string", "null" ] }, "style": "form" }, { "in": "query", "name": "includeGroups", "schema": { "type": [ "boolean", "null" ] }, "style": "form" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "format": "uint16", "default": 100, "maximum": 65535, "minimum": 0 }, "style": "form" }, { "in": "query", "name": "order", "description": "PRO-4251: `asc` for oldest-first, `desc` (default) for newest-first.", "schema": { "description": "PRO-4251: `asc` for oldest-first, `desc` (default) for newest-first.", "anyOf": [ { "$ref": "#/components/schemas/MessageOrder" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "search", "schema": { "type": [ "string", "null" ] }, "style": "form" }, { "in": "query", "name": "since", "schema": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "until", "schema": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "style": "form" }, { "in": "query", "name": "userNumber", "schema": { "type": [ "string", "null" ] }, "style": "form" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Paginated_for_Message" } } } } }, "security": [ { "JWTBearer": [] } ] } }, "/api/v1/messages/send": { "post": { "summary": "Send a message", "description": "Sends an outbound message from one of the caller's inboxes.", "operationId": "sendMessage", "parameters": [ { "in": "query", "name": "setStatus", "schema": { "anyOf": [ { "$ref": "#/components/schemas/Status" }, { "type": "null" } ] }, "style": "form" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendMessageRequest" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } } }, "security": [ { "JWTBearer": [] } ] } }, "/api/v1/team-members": { "get": { "summary": "List team members", "description": "Returns the team members visible to the authenticated caller's workspace.", "operationId": "listTeamMembers", "parameters": [ { "in": "query", "name": "isActive", "schema": { "type": [ "boolean", "null" ] }, "style": "form" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Paginated_for_TeamMemberExtra" } } } } }, "security": [ { "JWTBearer": [] } ] } } }, "components": { "securitySchemes": { "JWTBearer": { "type": "http", "scheme": "bearer" }, "CcAdminJWTBearer": { "type": "http", "scheme": "bearer" } }, "schemas": { "Body_create_upload_api_v1_uploads__post": { "title": "Body_create_upload_api_v1_uploads__post", "type": "object", "properties": { "contacts": { "title": "Contacts", "type": "array", "items": { "$ref": "#/components/schemas/ContactCreate" } }, "tagIds": { "title": "Tagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } } }, "Body_tag_contacts_api_v1_contacts_tag__action__post": { "title": "Body_tag_contacts_api_v1_contacts_tag__action__post", "type": "object", "properties": { "contactIds": { "title": "Contactids", "type": "array", "items": { "type": "string" } }, "tagIds": { "title": "Tagids", "type": "array", "items": { "type": "string" } } }, "required": [ "contactIds", "tagIds" ] }, "Body_upload_contact_image_api_v1_contacts__id__upload_image_post": { "title": "Body_upload_contact_image_api_v1_contacts__id__upload_image_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Contact-Input": { "title": "Contact", "description": "Contact\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AvatarUrl": { "title": "Avatarurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BirthDate": { "title": "Birthdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactId": { "title": "Contactid", "type": "string" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "CustomFields": { "title": "Customfields", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerName": { "title": "Enrichcallername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerType": { "title": "Enrichcallertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichLookupAt": { "title": "Enrichlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichMeta": { "title": "Enrichmeta", "anyOf": [ {}, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "HouseholdId": { "title": "Householdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdTitle": { "title": "Householdtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsArchived": { "title": "Isarchived", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastContactedTime": { "title": "Lastcontactedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "type": "string" }, "LastSubmittedTime": { "title": "Lastsubmittedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "MiddleName": { "title": "Middlename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierName": { "title": "Numbercarriername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierType": { "anyOf": [ { "$ref": "#/components/schemas/NumberCarrierTypeEnum" }, { "type": "null" } ] }, "NumberLookupAt": { "title": "Numberlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberMeta": { "title": "Numbermeta", "anyOf": [ {}, { "type": "null" } ] }, "Numbers": { "title": "Numbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContactNumber" } }, { "type": "null" } ] }, "OwnerId": { "title": "Ownerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceId": { "title": "Ownersourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceName": { "title": "Ownersourcename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "type": "string" }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceMeta": { "title": "Sourcemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SourceSyncFlow": { "title": "Sourcesyncflow", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UploadId": { "title": "Uploadid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "Version": { "title": "Version", "type": "integer" }, "Versions": { "title": "Versions", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContactVersion" } }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Phone", "FirstName", "LastName", "UserId", "Version", "ContactId", "CreatedAt" ] }, "Contact-Output": { "title": "Contact", "description": "Contact\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AvatarUrl": { "title": "Avatarurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BirthDate": { "title": "Birthdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactId": { "title": "Contactid", "type": "string" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "CustomFields": { "title": "Customfields", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerName": { "title": "Enrichcallername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerType": { "title": "Enrichcallertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichLookupAt": { "title": "Enrichlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichMeta": { "title": "Enrichmeta", "anyOf": [ {}, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "HouseholdId": { "title": "Householdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdTitle": { "title": "Householdtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsArchived": { "title": "Isarchived", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastContactedTime": { "title": "Lastcontactedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "type": "string" }, "LastSubmittedTime": { "title": "Lastsubmittedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "MiddleName": { "title": "Middlename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierName": { "title": "Numbercarriername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierType": { "anyOf": [ { "$ref": "#/components/schemas/NumberCarrierTypeEnum" }, { "type": "null" } ] }, "NumberLookupAt": { "title": "Numberlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberMeta": { "title": "Numbermeta", "anyOf": [ {}, { "type": "null" } ] }, "Numbers": { "title": "Numbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContactNumber" } }, { "type": "null" } ] }, "OwnerId": { "title": "Ownerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceId": { "title": "Ownersourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceName": { "title": "Ownersourcename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "type": "string" }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceMeta": { "title": "Sourcemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SourceSyncFlow": { "title": "Sourcesyncflow", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UploadId": { "title": "Uploadid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "Version": { "title": "Version", "type": "integer" }, "Versions": { "title": "Versions", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContactVersion" } }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Phone", "FirstName", "LastName", "UserId", "Version", "ContactId", "CreatedAt" ] }, "ContactAccessResponse": { "title": "ContactAccessResponse", "description": "Contact access response model", "type": "object", "properties": { "enabled": { "title": "Enabled", "type": "boolean" } }, "required": [ "enabled" ] }, "ContactCreate": { "title": "ContactCreate", "description": "Create\n\nProperties to receive on contact creation", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AvatarUrl": { "title": "Avatarurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BirthDate": { "title": "Birthdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CustomFields": { "title": "Customfields", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerName": { "title": "Enrichcallername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerType": { "title": "Enrichcallertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichLookupAt": { "title": "Enrichlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichMeta": { "title": "Enrichmeta", "anyOf": [ {}, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "HouseholdId": { "title": "Householdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdTitle": { "title": "Householdtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsArchived": { "title": "Isarchived", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastContactedTime": { "title": "Lastcontactedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "type": "string" }, "LastSubmittedTime": { "title": "Lastsubmittedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "MiddleName": { "title": "Middlename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierName": { "title": "Numbercarriername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierType": { "anyOf": [ { "$ref": "#/components/schemas/NumberCarrierTypeEnum" }, { "type": "null" } ] }, "NumberLookupAt": { "title": "Numberlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberMeta": { "title": "Numbermeta", "anyOf": [ {}, { "type": "null" } ] }, "Numbers": { "title": "Numbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContactNumber" } }, { "type": "null" } ] }, "OwnerId": { "title": "Ownerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceId": { "title": "Ownersourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceName": { "title": "Ownersourcename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "type": "string" }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceMeta": { "title": "Sourcemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SourceSyncFlow": { "title": "Sourcesyncflow", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UploadId": { "title": "Uploadid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Phone", "FirstName", "LastName" ] }, "ContactEnrichResponse": { "title": "ContactEnrichResponse", "description": "Response from enriching a contact with carrier and CNAM data", "type": "object", "properties": { "ContactId": { "title": "Contactid", "type": "string" }, "EnrichCallerName": { "title": "Enrichcallername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerType": { "title": "Enrichcallertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichLookupAt": { "title": "Enrichlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierName": { "title": "Numbercarriername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierType": { "title": "Numbercarriertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "type": "string" } }, "required": [ "ContactId", "Phone" ] }, "ContactImageUpdate": { "title": "ContactImageUpdate", "description": "ContactImageUpdate", "type": "object", "properties": { "AvatarUrl": { "title": "Avatarurl", "type": "string" } }, "required": [ "AvatarUrl" ] }, "ContactNumber": { "title": "ContactNumber", "description": "ContactNumber\n\nNumbers on the contact record", "type": "object", "properties": { "IsDoNotContact": { "title": "Isdonotcontact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPreferred": { "title": "Ispreferred", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ {}, { "type": "null" } ] }, "Phone": { "title": "Phone", "type": "string" } } }, "ContactUpdate": { "title": "ContactUpdate", "description": "Update\n\nProperties to receive on contact update", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AvatarUrl": { "title": "Avatarurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BirthDate": { "title": "Birthdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CustomFields": { "title": "Customfields", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerName": { "title": "Enrichcallername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerType": { "title": "Enrichcallertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichLookupAt": { "title": "Enrichlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichMeta": { "title": "Enrichmeta", "anyOf": [ {}, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdId": { "title": "Householdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdTitle": { "title": "Householdtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsArchived": { "title": "Isarchived", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastContactedTime": { "title": "Lastcontactedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastSubmittedTime": { "title": "Lastsubmittedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "MiddleName": { "title": "Middlename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierName": { "title": "Numbercarriername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierType": { "anyOf": [ { "$ref": "#/components/schemas/NumberCarrierTypeEnum" }, { "type": "null" } ] }, "NumberLookupAt": { "title": "Numberlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberMeta": { "title": "Numbermeta", "anyOf": [ {}, { "type": "null" } ] }, "Numbers": { "title": "Numbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContactNumber" } }, { "type": "null" } ] }, "OwnerId": { "title": "Ownerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceId": { "title": "Ownersourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceName": { "title": "Ownersourcename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceMeta": { "title": "Sourcemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SourceSyncFlow": { "title": "Sourcesyncflow", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UploadId": { "title": "Uploadid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ContactVersion": { "title": "ContactVersion", "description": "Version\n\nProperties to share for a Versioned contact", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AvatarUrl": { "title": "Avatarurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BirthDate": { "title": "Birthdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CustomFields": { "title": "Customfields", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerName": { "title": "Enrichcallername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichCallerType": { "title": "Enrichcallertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichLookupAt": { "title": "Enrichlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EnrichMeta": { "title": "Enrichmeta", "anyOf": [ {}, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdId": { "title": "Householdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdTitle": { "title": "Householdtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsArchived": { "title": "Isarchived", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastContactedTime": { "title": "Lastcontactedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastSubmittedTime": { "title": "Lastsubmittedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "MiddleName": { "title": "Middlename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierName": { "title": "Numbercarriername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberCarrierType": { "anyOf": [ { "$ref": "#/components/schemas/NumberCarrierTypeEnum" }, { "type": "null" } ] }, "NumberLookupAt": { "title": "Numberlookupat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberMeta": { "title": "Numbermeta", "anyOf": [ {}, { "type": "null" } ] }, "Numbers": { "title": "Numbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ContactNumber" } }, { "type": "null" } ] }, "OwnerId": { "title": "Ownerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceId": { "title": "Ownersourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OwnerSourceName": { "title": "Ownersourcename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceMeta": { "title": "Sourcemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SourceSyncFlow": { "title": "Sourcesyncflow", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UploadId": { "title": "Uploadid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "Version": { "title": "Version", "type": "integer" }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Version" ] }, "ContactWebhookUpdate": { "title": "ContactWebhookUpdate", "description": "Contact webhook update model", "type": "object", "properties": { "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "SourceType": { "title": "Sourcetype", "type": "string" }, "Updates": { "title": "Updates", "type": "object", "additionalProperties": true } }, "required": [ "SourceType", "SourceId", "Updates" ] }, "ContactsPaginated": { "title": "ContactsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Contact-Output" } } }, "required": [ "meta", "records" ] }, "CrmsTypeEnum": { "title": "CrmsTypeEnum", "description": "Types of crms", "type": "string", "enum": [ "AGENCYBLOC", "AGENTCORE", "FINDASH", "HUBSPOT", "MEDICAREPRO", "PRACTIFI", "QUIVR", "RADIUSBOB", "REDTAIL", "SLANT", "WEALTHBOX", "XLR8", "SALESFORCE" ] }, "CustomField": { "title": "CustomField", "description": "CustomField\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "CrmTargetFieldKey": { "title": "Crmtargetfieldkey", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CustomFieldId": { "title": "Customfieldid", "type": "string" }, "FieldKey": { "title": "Fieldkey", "type": "string" }, "IsCreateTags": { "title": "Iscreatetags", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsCrmSync": { "title": "Iscrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHighlight": { "title": "Ishighlight", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHousehold": { "title": "Ishousehold", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Name": { "title": "Name", "type": "string" }, "Type": { "title": "Type", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Name", "Type", "UserId", "CustomFieldId", "FieldKey", "CreatedAt" ] }, "CustomFieldCreate": { "title": "CustomFieldCreate", "description": "Create\n\nProperties to receive on customfield creation", "type": "object", "properties": { "CrmTargetFieldKey": { "title": "Crmtargetfieldkey", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsCreateTags": { "title": "Iscreatetags", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsCrmSync": { "title": "Iscrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHighlight": { "title": "Ishighlight", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHousehold": { "title": "Ishousehold", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Name": { "title": "Name", "type": "string" }, "Type": { "title": "Type", "type": "string" } }, "required": [ "Name", "Type" ] }, "CustomFieldUpdate": { "title": "CustomFieldUpdate", "description": "Update\n\nProperties to receive on customfield update", "type": "object", "properties": { "CrmTargetFieldKey": { "title": "Crmtargetfieldkey", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsCreateTags": { "title": "Iscreatetags", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsCrmSync": { "title": "Iscrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHighlight": { "title": "Ishighlight", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHousehold": { "title": "Ishousehold", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CustomFieldsPaginated": { "title": "CustomFieldsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } } }, "required": [ "meta", "records" ] }, "DatabaseQueryFilter": { "title": "DatabaseQueryFilter", "description": "DatabaseQueryFilter\n\nA filter object that identifies field, op and value\n\nExample:\n {\n \"field\": \"Tags\",\n \"op\": \"eq\",\n \"value\": \"123\"\n }", "type": "object", "properties": { "field": { "title": "Field", "type": "string" }, "operator": { "$ref": "#/components/schemas/DatabaseQueryFilterOperatorEnum" }, "value": { "title": "Value" } }, "required": [ "field", "operator", "value" ] }, "DatabaseQueryFilterGroup-Input": { "title": "DatabaseQueryFilterGroup", "description": "A group of filters that are ANDed together. Groups are ORed.", "type": "object", "properties": { "filters": { "title": "Filters", "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilter" } } }, "required": [ "filters" ] }, "DatabaseQueryFilterGroup-Output": { "title": "DatabaseQueryFilterGroup", "description": "A group of filters that are ANDed together. Groups are ORed.", "type": "object", "properties": { "filters": { "title": "Filters", "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilter" } } }, "required": [ "filters" ] }, "DatabaseQueryFilterOperatorEnum": { "title": "DatabaseQueryFilterOperatorEnum", "description": "Operators for comparison", "type": "string", "enum": [ "eq", "ne", "like", "notlike", "contains", "notcontains", "beginswith", "isin", "between", "exists", "notexists", "gt", "gte", "lt", "lte" ] }, "HTTPValidationError": { "title": "HTTPValidationError", "type": "object", "properties": { "detail": { "title": "Detail", "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } } }, "HistoryEvent": { "title": "HistoryEvent", "description": "HistoryEvent\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "EventName": { "title": "Eventname", "type": "string" }, "EventRecordId": { "title": "Eventrecordid", "type": "string" }, "EventRecordType": { "$ref": "#/components/schemas/HistoryEventRecordTypeEnum" }, "EventTime": { "title": "Eventtime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "HistoryEventId": { "title": "Historyeventid", "type": "string" }, "Meta": { "title": "Meta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "EventRecordType", "EventRecordId", "EventName", "UserId", "HistoryEventId", "CreatedTime" ] }, "HistoryEventCreate": { "title": "HistoryEventCreate", "description": "Create\n\nProperties to receive on historyevent creation", "type": "object", "properties": { "EventName": { "title": "Eventname", "type": "string" }, "EventRecordId": { "title": "Eventrecordid", "type": "string" }, "EventRecordType": { "$ref": "#/components/schemas/HistoryEventRecordTypeEnum" }, "EventTime": { "title": "Eventtime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] } }, "required": [ "EventRecordType", "EventRecordId", "EventName" ] }, "HistoryEventRecordTypeEnum": { "title": "HistoryEventRecordTypeEnum", "description": "Actions for tagging", "type": "string", "enum": [ "CONTACT", "UPLOAD", "TAG", "SEGMENT", "NOTE" ] }, "HistoryEventsPaginated": { "title": "HistoryEventsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/HistoryEvent" } } }, "required": [ "meta", "records" ] }, "Note": { "title": "Note", "description": "Note\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "ContactId": { "title": "Contactid", "type": "string" }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "Message": { "title": "Message", "type": "string" }, "NoteId": { "title": "Noteid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Message", "UserId", "ContactId", "NoteId", "CreatedTime" ] }, "NoteCreate": { "title": "NoteCreate", "description": "Create\n\nProperties to receive on note creation", "type": "object", "properties": { "Message": { "title": "Message", "type": "string" } }, "required": [ "Message" ] }, "NoteUpdate": { "title": "NoteUpdate", "description": "Update\n\nProperties to receive on note update", "type": "object", "properties": { "Message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "NotesPaginated": { "title": "NotesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Note" } } }, "required": [ "meta", "records" ] }, "NumberCarrierTypeEnum": { "title": "NumberCarrierTypeEnum", "description": "Twilio carrier types\nhttps://www.twilio.com/docs/lookup/tutorials/carrier-and-caller-name", "type": "string", "enum": [ "mobile", "landline", "voip", "invalid", "error" ] }, "PruneContactsIn": { "title": "PruneContactsIn", "description": "PruneContactsIn\n\nPayload to receive on prune contacts", "type": "object", "properties": { "PruneTime": { "title": "Prunetime", "type": "string" }, "SourceType": { "title": "Sourcetype", "type": "string" } }, "required": [ "PruneTime", "SourceType" ] }, "PruneTagsIn": { "title": "PruneTagsIn", "description": "PruneTagsIn\n\nPayload to receive on prune tags", "type": "object", "properties": { "PruneTime": { "title": "Prunetime", "type": "string" }, "SourceType": { "title": "Sourcetype", "type": "string" } }, "required": [ "PruneTime", "SourceType" ] }, "QuickSyncContactIn": { "title": "QuickSyncContactIn", "description": "QuickSyncContactIn\n\nPayload to receive on quick sync contact", "type": "object", "properties": { "AttachConversationId": { "title": "Attachconversationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactSourceId": { "title": "Contactsourceid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "required": [ "ContactSourceId" ] }, "ResponseMetaBase": { "title": "ResponseMetaBase", "description": "Base\n\nResponse meta values, hold the cursor, total count and whatever else", "type": "object", "properties": { "calls": { "title": "Calls", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "cursor": { "title": "Cursor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "limit": { "title": "Limit", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "stats": { "title": "Stats", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ] }, "total": { "title": "Total", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } } }, "Segment": { "title": "Segment", "description": "Segment\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FilterGroups": { "title": "Filtergroups", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilterGroup-Output" } }, { "type": "null" } ] }, "Filters": { "title": "Filters", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilter" } }, { "type": "null" } ] }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "SegmentId": { "title": "Segmentid", "type": "string" }, "SourceSegmentId": { "title": "Sourcesegmentid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TYPE": { "title": "Type", "type": "string", "default": "SEGMENT" }, "Title": { "title": "Title", "type": "string" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Title", "UserId", "SegmentId", "CreatedAt" ] }, "SegmentCreate": { "title": "SegmentCreate", "description": "Create\n\nProperties to receive on segment creation", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FilterGroups": { "title": "Filtergroups", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilterGroup-Input" } }, { "type": "null" } ] }, "Filters": { "title": "Filters", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilter" } }, { "type": "null" } ] }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "SourceSegmentId": { "title": "Sourcesegmentid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" } }, "required": [ "Title" ] }, "SegmentUpdate-Input": { "title": "SegmentUpdate", "description": "Update\n\nProperties to receive on segment update", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FilterGroups": { "title": "Filtergroups", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilterGroup-Input" } }, { "type": "null" } ] }, "Filters": { "title": "Filters", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilter" } }, { "type": "null" } ] }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "SegmentUpdate-Output": { "title": "SegmentUpdate", "description": "Update\n\nProperties to receive on segment update", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FilterGroups": { "title": "Filtergroups", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilterGroup-Output" } }, { "type": "null" } ] }, "Filters": { "title": "Filters", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/DatabaseQueryFilter" } }, { "type": "null" } ] }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "SegmentsPaginated": { "title": "SegmentsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Segment" } } }, "required": [ "meta", "records" ] }, "StatDay": { "title": "StatDay", "description": "StatDay\n\nStat summary for a month", "type": "object", "properties": { "CountContacts": { "title": "Countcontacts", "type": "integer", "default": 0 }, "CountSegments": { "title": "Countsegments", "type": "integer", "default": 0 }, "CountTags": { "title": "Counttags", "type": "integer", "default": 0 }, "CountUploads": { "title": "Countuploads", "type": "integer", "default": 0 }, "UpdatedAt": { "title": "Updatedat", "type": "string", "default": "" } } }, "StatSummary": { "title": "StatSummary", "description": "StatSummary\n\nStat summary", "type": "object", "properties": { "CountContacts": { "title": "Countcontacts", "type": "integer", "default": 0 }, "CountSegments": { "title": "Countsegments", "type": "integer", "default": 0 }, "CountTags": { "title": "Counttags", "type": "integer", "default": 0 }, "CountUploads": { "title": "Countuploads", "type": "integer", "default": 0 }, "UpdatedAt": { "title": "Updatedat", "type": "string", "default": "" } } }, "Tag": { "title": "Tag", "description": "Tag\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Color": { "title": "Color", "anyOf": [ { "type": "string", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "type": "string" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsMutable": { "title": "Ismutable", "type": "boolean" }, "IsPinned": { "title": "Ispinned", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TagId": { "title": "Tagid", "type": "string" }, "Title": { "title": "Title", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Title", "Description", "UserId", "TagId", "CreatedAt", "IsMutable" ] }, "TagActionEnum": { "title": "TagActionEnum", "description": "Actions for tagging", "type": "string", "enum": [ "add", "remove" ] }, "TagActionResponse": { "title": "TagActionResponse", "description": "Response after tagging contacts\n\nList of completed contact updates and list of failed updates", "type": "object", "properties": { "failed": { "title": "Failed", "type": "array", "items": {} }, "updated": { "title": "Updated", "type": "array", "items": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string" }, { "$ref": "#/components/schemas/ContactUpdate" } ] } } } }, "required": [ "updated", "failed" ] }, "TagCreate": { "title": "TagCreate", "description": "Create\n\nProperties to receive on tag creation", "type": "object", "properties": { "Color": { "title": "Color", "anyOf": [ { "type": "string", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsPinned": { "title": "Ispinned", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" } }, "required": [ "Title", "Description" ] }, "TagUpdate": { "title": "TagUpdate", "description": "Update\n\nProperties to receive on tag update", "type": "object", "properties": { "Color": { "title": "Color", "anyOf": [ { "type": "string", "pattern": "^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsPinned": { "title": "Ispinned", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastSyncTime": { "title": "Lastsynctime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceType": { "title": "Sourcetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "TagsPaginated": { "title": "TagsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Tag" } } }, "required": [ "meta", "records" ] }, "Upload": { "title": "Upload", "description": "Upload\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Count": { "title": "Count", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "CountDuplicateRecords": { "title": "Countduplicaterecords", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CountNewRecords": { "title": "Countnewrecords", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CountTagRecords": { "title": "Counttagrecords", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsComplete": { "title": "Iscomplete", "type": "boolean" }, "Status": { "$ref": "#/components/schemas/UploadStatusEnum" }, "TagIds": { "title": "Tagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UploadId": { "title": "Uploadid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "UploadTimestamp": { "title": "Uploadtimestamp", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId", "Count", "UploadId", "UploadTimestamp", "Status", "IsComplete" ] }, "UploadDuplicate": { "title": "UploadDuplicate", "description": "UploadDuplicate\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "ExistingContact": { "$ref": "#/components/schemas/Contact-Output" }, "IsIgnored": { "title": "Isignored", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMerged": { "title": "Ismerged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsRestored": { "title": "Isrestored", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsRestoredMerged": { "title": "Isrestoredmerged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UploadDuplicateId": { "title": "Uploadduplicateid", "type": "string" }, "UploadId": { "title": "Uploadid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "UploadedContact": { "$ref": "#/components/schemas/ContactCreate" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "ExistingContact", "UploadedContact", "UserId", "UploadId", "UploadDuplicateId", "CreatedAt" ] }, "UploadDuplicateCreate": { "title": "UploadDuplicateCreate", "description": "Create\n\nProperties to receive on uploadduplicate creation", "type": "object", "properties": { "ExistingContact": { "$ref": "#/components/schemas/Contact-Input" }, "UploadedContact": { "$ref": "#/components/schemas/ContactCreate" } }, "required": [ "ExistingContact", "UploadedContact" ] }, "UploadDuplicateTriageStatusEnum": { "title": "UploadDuplicateTriageStatusEnum", "description": "Upload duplicate triage status for comparison", "type": "string", "enum": [ "NOTMERGED", "MERGED", "IGNORED", "RESTORED", "RESTOREDMERGED" ] }, "UploadDuplicatesPaginated": { "title": "UploadDuplicatesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/UploadDuplicate" } } }, "required": [ "meta", "records" ] }, "UploadStatusEnum": { "title": "UploadStatusEnum", "description": "Upload status for comparison", "type": "string", "enum": [ "CREATED", "CREATE_ERROR", "UPLOADED", "UPLOAD_ERROR", "QUEUED", "QUEUE_ERROR", "PROCESSING", "PROCESSING_ERROR", "COMPLETED" ] }, "UploadUpdate": { "title": "UploadUpdate", "description": "Update\n\nProperties to receive on upload update", "type": "object", "properties": { "CountAddDuplicateRecords": { "title": "Countaddduplicaterecords", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CountAddNewRecords": { "title": "Countaddnewrecords", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CountAddTagRecords": { "title": "Countaddtagrecords", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsComplete": { "title": "Iscomplete", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/UploadStatusEnum" }, { "type": "null" } ] } } }, "UploadsPaginated": { "title": "UploadsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Upload" } } }, "required": [ "meta", "records" ] }, "ValidationError": { "title": "ValidationError", "type": "object", "properties": { "type": { "title": "Error Type", "type": "string" }, "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "title": "Location", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "msg": { "title": "Message", "type": "string" } }, "required": [ "loc", "msg", "type" ] }, "Agent": { "title": "Agent", "type": "object", "properties": { "can_have_next": { "title": "Can Have Next", "type": "boolean", "default": false }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ] }, "AgentNode": { "title": "AgentNode", "description": "Transfer to an agent", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "agent", "default": "agent" }, "agent_id": { "title": "Agent Id", "type": "string" }, "id": { "title": "Id", "type": "string" }, "next": { "title": "Next", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "agent_id" ] }, "AnnouncementNode": { "title": "AnnouncementNode", "description": "Say text", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "announce", "default": "announce" }, "announcement": { "title": "Announcement", "discriminator": { "mapping": { "play": "#/components/schemas/PlaybackAnnouncement", "say": "#/components/schemas/VoiceAnnouncement" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/PlaybackAnnouncement" }, { "$ref": "#/components/schemas/VoiceAnnouncement" } ] }, "id": { "title": "Id", "type": "string" }, "next": { "title": "Next", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "announcement" ] }, "AudioPlayback": { "title": "AudioPlayback", "description": "AudioPlayback\n\nA payload of a request to play audio to a call", "type": "object", "properties": { "Url": { "title": "Url", "type": "string" } }, "required": [ "Url" ] }, "BasicEmail": { "title": "BasicEmail", "description": "BasicEmail\n\nFields for sending out a basic email.", "type": "object", "properties": { "BodyContent": { "title": "Bodycontent", "type": "string" }, "HeaderCtaDisplay": { "title": "Headerctadisplay", "type": "string" }, "HeaderCtaLink": { "title": "Headerctalink", "type": "string" }, "HeaderDescription": { "title": "Headerdescription", "type": "string" }, "HeaderTitle": { "title": "Headertitle", "type": "string" }, "SendBCC": { "title": "Sendbcc", "anyOf": [ { "type": "array", "items": { "type": "string", "format": "email" } }, { "type": "null" } ] }, "SendCC": { "title": "Sendcc", "anyOf": [ { "type": "array", "items": { "type": "string", "format": "email" } }, { "type": "null" } ] }, "SendFrom": { "title": "Sendfrom", "type": "string" }, "SendSubject": { "title": "Sendsubject", "type": "string" }, "SendTo": { "title": "Sendto", "type": "array", "items": { "type": "string", "format": "email" } } }, "required": [ "SendFrom", "SendTo", "SendSubject", "HeaderTitle", "HeaderDescription", "HeaderCtaDisplay", "HeaderCtaLink", "BodyContent" ] }, "Body_claim_number_api_v1_numbers_claim_post": { "title": "Body_claim_number_api_v1_numbers_claim_post", "type": "object", "properties": { "phoneNumber": { "title": "Phone number", "description": "Phone number with a leading +1", "type": "string", "pattern": "^\\+[1-9]\\d{1,14}$" }, "userEmail": { "title": "User Email", "description": "User email of the user this phone is registered to", "type": "string" }, "userId": { "title": "User Id", "description": "User Id of the user this phone is registered to", "type": "string" } } }, "Body_create_conversation_api_v1_public_conversations_webhook_post": { "title": "Body_create_conversation_api_v1_public_conversations_webhook_post", "type": "object", "properties": { "Author": { "title": "Author", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Body": { "title": "Body", "type": "string", "default": "" }, "ChatServiceSid": { "title": "Chatservicesid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationSid": { "title": "Conversationsid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EventType": { "title": "Eventtype", "type": "string" }, "Media": { "title": "Media", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageSid": { "title": "Messagesid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessagingBinding.Address": { "title": "Messagingbinding.Address", "type": "array", "default": [], "items": { "type": "string" } }, "MessagingBinding.AuthorAddress": { "title": "Messagingbinding.Authoraddress", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessagingBinding.ProxyAddress": { "title": "Messagingbinding.Proxyaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ParticipantSid": { "title": "Participantsid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "EventType" ] }, "Body_incoming_webhook_api_v1_public_messages_incoming__userId__post": { "title": "Body_incoming_webhook_api_v1_public_messages_incoming__userId__post", "type": "object", "properties": { "Body": { "title": "Body", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "DateCreated": { "title": "Datecreated", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "From": { "title": "From", "type": "string" }, "MessageSid": { "title": "Messagesid", "type": "string" }, "NumMedia": { "title": "Nummedia", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 0 }, "NumSegments": { "title": "Numsegments", "type": "string" }, "OtherRecipients0": { "title": "Otherrecipients0", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsStatus": { "title": "Smsstatus", "type": "string" }, "To": { "title": "To", "type": "string" } }, "required": [ "To", "From", "MessageSid", "NumSegments", "SmsStatus" ] }, "Body_status_webhook_api_v1_public_messages_status__userId___messageId__post": { "title": "Body_status_webhook_api_v1_public_messages_status__userId___messageId__post", "type": "object", "properties": { "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageStatus": { "title": "Messagestatus", "type": "string" } }, "required": [ "MessageStatus" ] }, "Body_upload_recording_prompt_api_v1_recording_prompts_upload_post": { "title": "Body_upload_recording_prompt_api_v1_recording_prompts_upload_post", "type": "object", "properties": { "audio": { "title": "Audio", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "audio" ] }, "Body_upload_voicemail_file_api_v1_inboxes_upload_voicemail_post": { "title": "Body_upload_voicemail_file_api_v1_inboxes_upload_voicemail_post", "type": "object", "properties": { "audio": { "title": "Audio", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "audio" ] }, "Call": { "title": "Call", "description": "Call\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "AgentInteractions": { "title": "AgentInteractions", "description": "List of AI agent interactions on this call. Each entry contains agentId, conversationId, dialplanId, nextNodeId, and firmName.", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ] }, "AnsweredBy": { "title": "AnsweredBy", "description": "Twilio AMD result for outbound calls: 'human', 'machine_start', 'machine_end_silence', 'machine_end_beep', 'machine_end_other', 'fax', or 'unknown'. None when AMD was not run.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AnsweredByMemberId": { "title": "Answeredbymemberid", "description": "The id of the member that answered a call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ArchiverIds": { "title": "Archiverids", "description": "Dictionary to store archiver ids - key is ArchiverId, value is ArchiverType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "CallAnalysisStatus": { "title": "CallAnalysisStatus", "description": "Status of the ai summary", "anyOf": [ { "$ref": "#/components/schemas/CallAnalysisStatusEnum" }, { "type": "null" } ] }, "CallAnalysisSummary": { "title": "CallAnalysisSummary", "description": "Analysis generated for the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallAnalysisTranscript": { "title": "CallAnalysisTranscript", "description": "Transcript generated for the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallDurationTime": { "title": "CallDurationTime", "description": "Time in seconds of the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallEndedTime": { "title": "Callendedtime", "description": "The time the call ended", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CallId": { "title": "Callid", "type": "string" }, "CallSid": { "title": "CallSid", "description": "Specific call sid for the call, useful for twilio api", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallerMemberId": { "title": "Caller Member Id", "description": "Member id for the caller", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "1234-abcd-4567-ABCD" }, "CallerName": { "title": "Caller Name", "description": "Name of the caller for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "Jen Framer" }, "Comments": { "title": "Comments", "description": "Comments about the call", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CallComment" } }, { "type": "null" } ] }, "ContactId": { "title": "Contact Id", "description": "Id of the contact for outbounds", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "1234-abcd-4567-ABCD" }, "ContactName": { "title": "Contact Name", "description": "Name of the contact for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "Ray Dalio" }, "ContactNumber": { "title": "Contact Number", "description": "Phone number in E.164 format", "type": "string", "example": "+18008675309" }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmIds": { "title": "Crmids", "description": "Dictionary to store CRM ids - key is CrmId, value is CrmType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Direction": { "$ref": "#/components/schemas/CallDirectionEnum" }, "DispositionId": { "title": "DispositionId", "description": "Workspace disposition assigned to this call (PRO-4164). Null until set; filterable via the calls list endpoint.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsAgentCall": { "title": "IsAgentCall", "description": "Whether an AI agent handled this call", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsForwarded": { "title": "IsForwarded", "description": "If the call is forwarded", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMissedCall": { "title": "Ismissedcall", "description": "Explicitly set to True when the call is confirmed missed by the application layer (is_done=True). Prevents premature missed-call notifications from intermediate DynamoDB stream events during parallel dial.", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsOutsideHours": { "title": "IsOutsideHours", "description": "If the call is outside business hours", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsRecorded": { "title": "IsRecorded", "description": "If the call is recorded", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsVoicemail": { "title": "IsVoicemail", "description": "True when this call was routed to voicemail", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "description": "Key values of meta data for this call, will be published as attributes to topic on callbacks", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Note": { "title": "Note", "description": "Note about the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NotetakerIds": { "title": "Notetakerids", "description": "Dictionary to store notetaker ids", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "NumberForwardedTo": { "title": "NumberForwardedTo", "description": "If the call is forwarded, this is the number it went to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Participants": { "title": "Participants", "description": "List of participants currently in the call", "type": "array", "items": { "$ref": "#/components/schemas/CallParticipant" } }, "RecordingDurationTime": { "title": "RecordingDurationTime", "description": "Time in seconds of the call recording", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RecordingSid": { "title": "RecordingSid", "description": "Specific recording sid for the call, useful for twilio api", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RecordingStatus": { "title": "RecordingStatus", "description": "Status of the recording", "anyOf": [ { "$ref": "#/components/schemas/RecordingStatusEnum" }, { "type": "null" } ] }, "RecordingUrl": { "title": "RecordingUrl", "description": "Url to the call recording", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "$ref": "#/components/schemas/CallStatusEnum" }, "StatusCallSid": { "title": "Statuscallsid", "description": "The Twilio CallSid that produced the current StatusSequence.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusSequence": { "title": "Statussequence", "description": "Highest Twilio SequenceNumber processed for status updates. Stored as a DynamoDB N type for correct numeric comparison.", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "StatusWeight": { "title": "Statusweight", "description": "Numeric weight of the current Status, used to prevent cross-CallSid status regressions.", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "description": "Tags for the message", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "TranscriptionStatus": { "title": "TranscriptionStatus", "description": "Status of the transcription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "TranscriptionText", "description": "Text of the voicemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TransferredAtTime": { "title": "Transferredattime", "description": "Epoch timestamp when the call was transferred", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TransferredToMemberId": { "title": "Transferredtomemberid", "description": "The id of the member that the call was transferred to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TransferredToNumber": { "title": "Transferredtonumber", "description": "The phone number that the call was transferred to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string", "example": "1234-abcd-4567-ABCD" }, "UserNumber": { "title": "Number for the app user", "description": "Number with a leading +1", "type": "string", "example": "+18008675309", "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "CallId" ] }, "CallAnalysisStatusEnum": { "title": "CallAnalysisStatusEnum", "description": "CallAnalysisStatusEnum\n\nAi summary status of the call", "type": "string", "enum": [ "queued", "processing", "completed", "error" ] }, "CallAnalytics": { "title": "CallAnalytics", "description": "CallAnalytics\n\nWorkspace call-analytics aggregation (PRO-4168). Powers the analytics\ndashboard and answers the five Radian driver questions via per-member\nrollups plus top-contact and time-pattern breakdowns.", "type": "object", "properties": { "ByDayOfWeek": { "title": "Bydayofweek", "type": "object", "additionalProperties": { "type": "integer" }, "default": {} }, "ByDisposition": { "title": "Bydisposition", "type": "object", "additionalProperties": { "type": "integer" }, "default": {} }, "ByHourOfDay": { "title": "Byhourofday", "type": "object", "additionalProperties": { "type": "integer" }, "default": {} }, "CountTotal": { "title": "Counttotal", "type": "integer", "default": 0 }, "Members": { "title": "Members", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/CallAnalyticsMemberEntry" } }, "TopContacts": { "title": "Topcontacts", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/CallAnalyticsContactEntry" } } } }, "CallAnalyticsContactEntry": { "title": "CallAnalyticsContactEntry", "description": "CallAnalyticsContactEntry\n\nA contact and how many calls involved them, for top-contacts-by-volume.", "type": "object", "properties": { "CallCount": { "title": "Callcount", "type": "integer", "default": 0 }, "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactNumber": { "title": "Contactnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CallAnalyticsMemberEntry": { "title": "CallAnalyticsMemberEntry", "description": "CallAnalyticsMemberEntry\n\nPer team-member call rollup (PRO-4168). Answers the Radian driver\nquestions:\n\n- OutboundInitiated ....... Q4 outgoing calls initiated (dialed)\n- OutboundInitiatedByWeek . Q4 broken out per ISO week (YYYY-Www)\n- OutboundConnected ....... Q5 outgoing calls that actually connected\n- InboundAnswered ......... Q1 inbound calls this member answered\n- InboundAnsweredByMonth .. Q1 broken out per month (YYYY-MM)\n- InboundAnsweredTalkTimeSeconds .. Q2 talk time of ANSWERED calls only\n- OutboundConnectedTalkTimeSeconds talk time of CONNECTED outbound only\n- TalkTimeSeconds ......... combined total (answered + connected)\n- AvgHandleTimeSeconds .... Q3 answered-only AHT (answered talk / answered)\n\n\"Initiated\" is every outbound record (the call was at least dialed);\n\"connected\"/\"answered\" require the legs to have bridged. Conflating the\ntwo \u2014 or conflating answered talk time with connected talk time \u2014 is the\nbug the reconciliation test guards against. Q2 (\"duration of ANSWERED\ncalls\") is InboundAnsweredTalkTimeSeconds, NOT the combined total.", "type": "object", "properties": { "AvgHandleTimeSeconds": { "title": "Avghandletimeseconds", "type": "number", "default": 0.0 }, "ConnectRate": { "title": "Connectrate", "type": "number", "default": 0.0 }, "InboundAnswered": { "title": "Inboundanswered", "type": "integer", "default": 0 }, "InboundAnsweredByMonth": { "title": "Inboundansweredbymonth", "type": "object", "additionalProperties": { "type": "integer" }, "default": {} }, "InboundAnsweredTalkTimeSeconds": { "title": "Inboundansweredtalktimeseconds", "type": "integer", "default": 0 }, "MemberId": { "title": "Memberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MemberName": { "title": "Membername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutboundConnected": { "title": "Outboundconnected", "type": "integer", "default": 0 }, "OutboundConnectedTalkTimeSeconds": { "title": "Outboundconnectedtalktimeseconds", "type": "integer", "default": 0 }, "OutboundInitiated": { "title": "Outboundinitiated", "type": "integer", "default": 0 }, "OutboundInitiatedByWeek": { "title": "Outboundinitiatedbyweek", "type": "object", "additionalProperties": { "type": "integer" }, "default": {} }, "TalkTimeSeconds": { "title": "Talktimeseconds", "type": "integer", "default": 0 } } }, "CallArchiverReceiptIds": { "title": "CallArchiverReceiptIds", "type": "object", "properties": { "CallIds": { "title": "Callids", "type": "array", "items": { "type": "string" } } }, "required": [ "CallIds" ] }, "CallBatchUpdateArchiverIds": { "title": "CallBatchUpdateArchiverIds", "type": "object", "properties": { "ArchiverType": { "title": "Archivertype", "type": "string" }, "CallIds": { "title": "Callids", "type": "array", "items": { "type": "string" } }, "ConnectorId": { "title": "Connectorid", "type": "string" }, "NoteId": { "title": "Noteid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "CallIds", "ConnectorId", "ArchiverType" ] }, "CallBatchUpdateCrmIds": { "title": "CallBatchUpdateCrmIds", "type": "object", "properties": { "CallIds": { "title": "Callids", "type": "array", "items": { "type": "string" } }, "ConnectorId": { "title": "Connectorid", "type": "string" }, "CrmType": { "title": "Crmtype", "type": "string" }, "NoteId": { "title": "Noteid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "CallIds", "ConnectorId", "CrmType" ] }, "CallBatchUpdateNotetakerIds": { "title": "CallBatchUpdateNotetakerIds", "type": "object", "properties": { "CallIds": { "title": "Callids", "type": "array", "items": { "type": "string" } }, "ConnectorId": { "title": "Connectorid", "type": "string" }, "MeetingId": { "title": "Meetingid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NotetakerType": { "title": "Notetakertype", "type": "string" } }, "required": [ "CallIds", "ConnectorId", "NotetakerType" ] }, "CallComment": { "title": "CallComment", "description": "CallComment", "type": "object", "properties": { "CallCommentId": { "title": "Callcommentid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "Comment": { "title": "Comment", "type": "string" }, "CreatedByUserId": { "title": "Createdbyuserid", "type": "string" }, "CreatedByUserName": { "title": "Createdbyusername", "type": "string" }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Comment", "CreatedByUserId", "CreatedByUserName", "CreatedTime" ] }, "CallCommentCreate": { "title": "CallCommentCreate", "description": "CallCommentCreate", "type": "object", "properties": { "Comment": { "title": "Comment", "type": "string" }, "CreatedByUserId": { "title": "Createdbyuserid", "type": "string" }, "CreatedByUserName": { "title": "Createdbyusername", "type": "string" } }, "required": [ "Comment", "CreatedByUserId", "CreatedByUserName" ] }, "CallDirectionEnum": { "title": "CallDirectionEnum", "description": "CallDirectionEnum\n\nDirection of the call, whether it was outbound or inbound", "type": "string", "enum": [ "OUTBOUND", "INBOUND" ] }, "CallInDB": { "title": "CallInDB", "description": "InDB\n\nProperties properties stored in DB, this is full representation of\nrecord", "type": "object", "properties": { "AgentInteractions": { "title": "AgentInteractions", "description": "List of AI agent interactions on this call. Each entry contains agentId, conversationId, dialplanId, nextNodeId, and firmName.", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ] }, "AnsweredBy": { "title": "AnsweredBy", "description": "Twilio AMD result for outbound calls: 'human', 'machine_start', 'machine_end_silence', 'machine_end_beep', 'machine_end_other', 'fax', or 'unknown'. None when AMD was not run.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AnsweredByMemberId": { "title": "Answeredbymemberid", "description": "The id of the member that answered a call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ArchiverIds": { "title": "Archiverids", "description": "Dictionary to store archiver ids - key is ArchiverId, value is ArchiverType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "CallAnalysisStatus": { "title": "CallAnalysisStatus", "description": "Status of the ai summary", "anyOf": [ { "$ref": "#/components/schemas/CallAnalysisStatusEnum" }, { "type": "null" } ] }, "CallAnalysisSummary": { "title": "CallAnalysisSummary", "description": "Analysis generated for the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallAnalysisTranscript": { "title": "CallAnalysisTranscript", "description": "Transcript generated for the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallDurationTime": { "title": "CallDurationTime", "description": "Time in seconds of the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallEndedTime": { "title": "Callendedtime", "description": "The time the call ended", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CallId": { "title": "Callid", "type": "string" }, "CallSid": { "title": "CallSid", "description": "Specific call sid for the call, useful for twilio api", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallerMemberId": { "title": "Caller Member Id", "description": "Member id for the caller", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "1234-abcd-4567-ABCD" }, "CallerName": { "title": "Caller Name", "description": "Name of the caller for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "Jen Framer" }, "Comments": { "title": "Comments", "description": "Comments about the call", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CallComment" } }, { "type": "null" } ] }, "ContactId": { "title": "Contact Id", "description": "Id of the contact for outbounds", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "1234-abcd-4567-ABCD" }, "ContactName": { "title": "Contact Name", "description": "Name of the contact for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "Ray Dalio" }, "ContactNumber": { "title": "Contact Number", "description": "Phone number in E.164 format", "type": "string", "example": "+18008675309" }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmIds": { "title": "Crmids", "description": "Dictionary to store CRM ids - key is CrmId, value is CrmType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Direction": { "$ref": "#/components/schemas/CallDirectionEnum" }, "DispositionId": { "title": "DispositionId", "description": "Workspace disposition assigned to this call (PRO-4164). Null until set; filterable via the calls list endpoint.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI1PK": { "title": "Gsi1Pk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI1SK": { "title": "Gsi1Sk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI2PK": { "title": "Gsi2Pk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI2SK": { "title": "Gsi2Sk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI3PK": { "title": "Gsi3Pk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI3SK": { "title": "Gsi3Sk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI4PK": { "title": "Gsi4Pk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI4SK": { "title": "Gsi4Sk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsAgentCall": { "title": "IsAgentCall", "description": "Whether an AI agent handled this call", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsForwarded": { "title": "IsForwarded", "description": "If the call is forwarded", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMissedCall": { "title": "Ismissedcall", "description": "Explicitly set to True when the call is confirmed missed by the application layer (is_done=True). Prevents premature missed-call notifications from intermediate DynamoDB stream events during parallel dial.", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsOutsideHours": { "title": "IsOutsideHours", "description": "If the call is outside business hours", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsRecorded": { "title": "IsRecorded", "description": "If the call is recorded", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsVoicemail": { "title": "IsVoicemail", "description": "True when this call was routed to voicemail", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "description": "Key values of meta data for this call, will be published as attributes to topic on callbacks", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Note": { "title": "Note", "description": "Note about the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NotetakerIds": { "title": "Notetakerids", "description": "Dictionary to store notetaker ids", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "NumberForwardedTo": { "title": "NumberForwardedTo", "description": "If the call is forwarded, this is the number it went to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PK": { "title": "Pk", "type": "string" }, "Participants": { "title": "Participants", "description": "List of participants currently in the call", "type": "array", "items": { "$ref": "#/components/schemas/CallParticipant" } }, "RecordingDurationTime": { "title": "RecordingDurationTime", "description": "Time in seconds of the call recording", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RecordingSid": { "title": "RecordingSid", "description": "Specific recording sid for the call, useful for twilio api", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RecordingStatus": { "title": "RecordingStatus", "description": "Status of the recording", "anyOf": [ { "$ref": "#/components/schemas/RecordingStatusEnum" }, { "type": "null" } ] }, "RecordingUrl": { "title": "RecordingUrl", "description": "Url to the call recording", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SK": { "title": "Sk", "type": "string" }, "Searchable": { "title": "Searchable", "type": "string" }, "SourceCallSK": { "title": "Sourcecallsk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "$ref": "#/components/schemas/CallStatusEnum" }, "StatusCallSid": { "title": "Statuscallsid", "description": "The Twilio CallSid that produced the current StatusSequence.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusSequence": { "title": "Statussequence", "description": "Highest Twilio SequenceNumber processed for status updates. Stored as a DynamoDB N type for correct numeric comparison.", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "StatusWeight": { "title": "Statusweight", "description": "Numeric weight of the current Status, used to prevent cross-CallSid status regressions.", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TYPE": { "title": "Type", "type": "string" }, "Tags": { "title": "Tags", "description": "Tags for the message", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "TranscriptionStatus": { "title": "TranscriptionStatus", "description": "Status of the transcription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "TranscriptionText", "description": "Text of the voicemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TransferredAtTime": { "title": "Transferredattime", "description": "Epoch timestamp when the call was transferred", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TransferredToMemberId": { "title": "Transferredtomemberid", "description": "The id of the member that the call was transferred to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TransferredToNumber": { "title": "Transferredtonumber", "description": "The phone number that the call was transferred to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string", "example": "1234-abcd-4567-ABCD" }, "UserNumber": { "title": "Number for the app user", "description": "Number with a leading +1", "type": "string", "example": "+18008675309", "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "CallId", "TYPE", "PK", "SK", "Searchable" ] }, "CallInDBBase": { "title": "CallInDBBase", "description": "InDBBase\n\nInherits from create, but on create Ids are added, dont include PK and Sk\nso that the Call can be returned without them", "type": "object", "properties": { "AgentInteractions": { "title": "AgentInteractions", "description": "List of AI agent interactions on this call. Each entry contains agentId, conversationId, dialplanId, nextNodeId, and firmName.", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ] }, "AnsweredBy": { "title": "AnsweredBy", "description": "Twilio AMD result for outbound calls: 'human', 'machine_start', 'machine_end_silence', 'machine_end_beep', 'machine_end_other', 'fax', or 'unknown'. None when AMD was not run.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AnsweredByMemberId": { "title": "Answeredbymemberid", "description": "The id of the member that answered a call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ArchiverIds": { "title": "Archiverids", "description": "Dictionary to store archiver ids - key is ArchiverId, value is ArchiverType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "CallAnalysisStatus": { "title": "CallAnalysisStatus", "description": "Status of the ai summary", "anyOf": [ { "$ref": "#/components/schemas/CallAnalysisStatusEnum" }, { "type": "null" } ] }, "CallAnalysisSummary": { "title": "CallAnalysisSummary", "description": "Analysis generated for the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallAnalysisTranscript": { "title": "CallAnalysisTranscript", "description": "Transcript generated for the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallDurationTime": { "title": "CallDurationTime", "description": "Time in seconds of the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallEndedTime": { "title": "Callendedtime", "description": "The time the call ended", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CallId": { "title": "Callid", "type": "string" }, "CallSid": { "title": "CallSid", "description": "Specific call sid for the call, useful for twilio api", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallerMemberId": { "title": "Caller Member Id", "description": "Member id for the caller", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "1234-abcd-4567-ABCD" }, "CallerName": { "title": "Caller Name", "description": "Name of the caller for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "Jen Framer" }, "Comments": { "title": "Comments", "description": "Comments about the call", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/CallComment" } }, { "type": "null" } ] }, "ContactId": { "title": "Contact Id", "description": "Id of the contact for outbounds", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "1234-abcd-4567-ABCD" }, "ContactName": { "title": "Contact Name", "description": "Name of the contact for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "Ray Dalio" }, "ContactNumber": { "title": "Contact Number", "description": "Phone number in E.164 format", "type": "string", "example": "+18008675309" }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmIds": { "title": "Crmids", "description": "Dictionary to store CRM ids - key is CrmId, value is CrmType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Direction": { "$ref": "#/components/schemas/CallDirectionEnum" }, "DispositionId": { "title": "DispositionId", "description": "Workspace disposition assigned to this call (PRO-4164). Null until set; filterable via the calls list endpoint.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsAgentCall": { "title": "IsAgentCall", "description": "Whether an AI agent handled this call", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsForwarded": { "title": "IsForwarded", "description": "If the call is forwarded", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMissedCall": { "title": "Ismissedcall", "description": "Explicitly set to True when the call is confirmed missed by the application layer (is_done=True). Prevents premature missed-call notifications from intermediate DynamoDB stream events during parallel dial.", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsOutsideHours": { "title": "IsOutsideHours", "description": "If the call is outside business hours", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsRecorded": { "title": "IsRecorded", "description": "If the call is recorded", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsVoicemail": { "title": "IsVoicemail", "description": "True when this call was routed to voicemail", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "description": "Key values of meta data for this call, will be published as attributes to topic on callbacks", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Note": { "title": "Note", "description": "Note about the call", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NotetakerIds": { "title": "Notetakerids", "description": "Dictionary to store notetaker ids", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "NumberForwardedTo": { "title": "NumberForwardedTo", "description": "If the call is forwarded, this is the number it went to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Participants": { "title": "Participants", "description": "List of participants currently in the call", "type": "array", "items": { "$ref": "#/components/schemas/CallParticipant" } }, "RecordingDurationTime": { "title": "RecordingDurationTime", "description": "Time in seconds of the call recording", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RecordingSid": { "title": "RecordingSid", "description": "Specific recording sid for the call, useful for twilio api", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RecordingStatus": { "title": "RecordingStatus", "description": "Status of the recording", "anyOf": [ { "$ref": "#/components/schemas/RecordingStatusEnum" }, { "type": "null" } ] }, "RecordingUrl": { "title": "RecordingUrl", "description": "Url to the call recording", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "$ref": "#/components/schemas/CallStatusEnum" }, "StatusCallSid": { "title": "Statuscallsid", "description": "The Twilio CallSid that produced the current StatusSequence.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusSequence": { "title": "Statussequence", "description": "Highest Twilio SequenceNumber processed for status updates. Stored as a DynamoDB N type for correct numeric comparison.", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "StatusWeight": { "title": "Statusweight", "description": "Numeric weight of the current Status, used to prevent cross-CallSid status regressions.", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "description": "Tags for the message", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "TranscriptionStatus": { "title": "TranscriptionStatus", "description": "Status of the transcription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "TranscriptionText", "description": "Text of the voicemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TransferredAtTime": { "title": "Transferredattime", "description": "Epoch timestamp when the call was transferred", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TransferredToMemberId": { "title": "Transferredtomemberid", "description": "The id of the member that the call was transferred to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TransferredToNumber": { "title": "Transferredtonumber", "description": "The phone number that the call was transferred to", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string", "example": "1234-abcd-4567-ABCD" }, "UserNumber": { "title": "Number for the app user", "description": "Number with a leading +1", "type": "string", "example": "+18008675309", "pattern": "^\\+[1-9]\\d{1,14}$" } }, "required": [ "CallId" ] }, "CallParticipant": { "title": "CallParticipant", "description": "CallParticipant\n\nModel rerpesenting a participant to be added to an existing call", "type": "object", "properties": { "CallSid": { "title": "Callsid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallStatus": { "$ref": "#/components/schemas/CallParticipantStatus", "default": "left" }, "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "$ref": "#/components/schemas/CallParticipantType" } }, "required": [ "Type" ] }, "CallParticipantStatus": { "title": "CallParticipantStatus", "description": "CallParticipantStatus\n\nEnum for the various call states of a call participant", "type": "string", "enum": [ "connecting", "active", "left", "no-answer", "held" ] }, "CallParticipantType": { "title": "CallParticipantType", "description": "CallParticipantType\n\nEnum for the type of call", "type": "string", "enum": [ "contact", "team" ] }, "CallShareUrl": { "title": "CallShareUrl", "description": "CallShareUrl", "type": "object", "properties": { "PresignedUrl": { "title": "Presignedurl", "type": "string" } }, "required": [ "PresignedUrl" ] }, "CallSharedResponse": { "title": "CallSharedResponse", "description": "CallSharedResponse\n\nModel for signed URLs that allow sharing call records without authentication", "type": "object", "properties": { "Call": { "$ref": "#/components/schemas/CallInDBBase" }, "ExpirationTime": { "title": "Expirationtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Call" ] }, "CallSignedShareUrl": { "title": "CallSignedShareUrl", "description": "CallSignedShareUrl\n\nModel for signed URLs that allow sharing call records without authentication", "type": "object", "properties": { "ShareUrl": { "title": "Shareurl", "type": "string" } }, "required": [ "ShareUrl" ] }, "CallStatusEnum": { "title": "CallStatusEnum", "description": "CallStatusEnum\n\nStatus of the call", "type": "string", "enum": [ "created", "initiated", "ringing", "in-progress", "transferred", "blocked", "completed", "failed", "busy", "no-answer", "canceled" ] }, "CallUpdateCallAnalysis": { "title": "CallUpdateCallAnalysis", "type": "object", "properties": { "CallAnalysisStatus": { "anyOf": [ { "$ref": "#/components/schemas/CallAnalysisStatusEnum" }, { "type": "null" } ] }, "CallAnalysisSummary": { "title": "Callanalysissummary", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallAnalysisTranscript": { "title": "Callanalysistranscript", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CallUpdateContact": { "title": "CallUpdateContact", "type": "object", "properties": { "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CallUpdateDisposition": { "title": "CallUpdateDisposition", "type": "object", "properties": { "DispositionId": { "title": "Dispositionid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CallUpdateNote": { "title": "CallUpdateNote", "type": "object", "properties": { "Note": { "title": "Note", "type": "string" } }, "required": [ "Note" ] }, "CallUpdateVoicemail": { "title": "CallUpdateVoicemail", "type": "object", "properties": { "TranscriptionStatus": { "title": "Transcriptionstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "Transcriptiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CallerLookup": { "title": "CallerLookup", "description": "CallerLookup", "type": "object", "properties": { "CallerName": { "title": "Callername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallerType": { "title": "Callertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "CallsPaginated": { "title": "CallsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Call" } } }, "required": [ "meta", "records" ] }, "CarrierLookup": { "title": "CarrierLookup", "description": "CarrierLookup", "type": "object", "properties": { "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MobileCountryCode": { "title": "Mobilecountrycode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MobileNetworkCode": { "title": "Mobilenetworkcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ChannelTypeEnum": { "title": "ChannelTypeEnum", "description": "ChannelTypeEnum\n\nType of the communication channel", "type": "string", "enum": [ "sms", "whatsapp" ] }, "ClaimedNumber": { "title": "ClaimedNumber", "description": "ClaimedNumber", "type": "object", "properties": { "AddressRequirements": { "title": "Addressrequirements", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Capabilities": { "anyOf": [ { "$ref": "#/components/schemas/ClaimedNumberCapabilities" }, { "type": "null" } ] }, "DateCreated": { "title": "Datecreated", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "DateUpdated": { "title": "Dateupdated", "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "FriendlyName": { "title": "Friendlyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Origin": { "title": "Origin", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Sid": { "title": "Sid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsFallbackMethod": { "title": "Smsfallbackmethod", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsFallbackUrl": { "title": "Smsfallbackurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsMethod": { "title": "Smsmethod", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsUrl": { "title": "Smsurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusCallback": { "title": "Statuscallback", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusCallbackMethod": { "title": "Statuscallbackmethod", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "DateCreated", "DateUpdated", "Capabilities" ] }, "ClaimedNumberCapabilities": { "title": "ClaimedNumberCapabilities", "description": "ClaimedNumberCapabilities", "type": "object", "properties": { "IsMMSEnabled": { "title": "Ismmsenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSMSEnabled": { "title": "Issmsenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsVoiceEnabled": { "title": "Isvoiceenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "IsMMSEnabled", "IsSMSEnabled", "IsVoiceEnabled" ] }, "ClientTarget": { "title": "ClientTarget", "description": "Client target", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "client", "default": "client" }, "target": { "title": "Target", "type": "string" } }, "required": [ "target" ] }, "Contact": { "title": "Contact", "description": "Contact\n\nRepresent metadata about a contact for the creation of a new message.", "type": "object", "properties": { "Id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "type": "string" } }, "required": [ "Number" ] }, "ContactNode": { "title": "ContactNode", "description": "Branch based on contact existence or contact tags.\n\nWhen tags are provided, routes to match if any contact has a matching tag.\nWhen tags are empty, routes to match if the contact exists at all.", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "contact" }, "id": { "title": "Id", "type": "string" }, "match": { "title": "Match", "type": "string" }, "no_match": { "title": "No Match", "type": "string" }, "tags": { "title": "Tags", "type": "array", "default": [], "items": { "type": "string" } } }, "required": [ "type", "match", "no_match" ] }, "Conversation": { "title": "Conversation", "description": "Conversation\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationFolderId": { "title": "Conversationfolderid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationId": { "title": "Conversationid", "type": "string" }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "IsCancelSnoozeOnReply": { "title": "Iscancelsnoozeonreply", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsRead": { "title": "Isread", "type": "boolean", "default": false }, "IsSnoozed": { "title": "Issnoozed", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSnoozedAlert": { "title": "Issnoozedalert", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LatestCall": { "anyOf": [ { "$ref": "#/components/schemas/CallInDB" }, { "type": "null" } ] }, "LatestMessage": { "anyOf": [ { "$ref": "#/components/schemas/MessageInDB" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberReadStates": { "title": "Numberreadstates", "description": "Per-inbox read state for group conversations. Maps team phone number to has-read boolean.", "type": "object", "additionalProperties": { "type": "boolean" } }, "Owner": { "title": "Owner", "description": "Member ID of the first team member to send an outbound message or call in this conversation", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Participants": { "title": "Participants", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/ConversationParticipant" } }, "SnoozedUntilTime": { "title": "Snoozeduntiltime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "$ref": "#/components/schemas/ConversationStatusEnum" }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "UserNumbers": { "title": "User Numbers", "description": "List of user numbers associated with this conversation", "type": "array", "example": [ "+18008675309", "+18005551234" ], "items": { "type": "string" } }, "Viewers": { "title": "Viewers", "anyOf": [ { "type": "object", "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] } }, { "type": "null" } ] } }, "required": [ "UserId", "ConversationId", "CreatedTime" ] }, "ConversationFolder": { "title": "ConversationFolder", "description": "ConversationFolder\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Color": { "title": "Color", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationFolderId": { "title": "Conversationfolderid", "type": "string" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "IsActive": { "title": "Isactive", "type": "boolean", "default": true }, "Title": { "title": "Title", "type": "string" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Title", "UserId", "ConversationFolderId", "CreatedAt" ] }, "ConversationFolderCreate": { "title": "ConversationFolderCreate", "description": "Create\n\nProperties to receive on conversationfolder creation", "type": "object", "properties": { "Color": { "title": "Color", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" } }, "required": [ "Title" ] }, "ConversationFolderUpdate": { "title": "ConversationFolderUpdate", "description": "Update\n\nProperties to receive on conversationfolder update", "type": "object", "properties": { "Color": { "title": "Color", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ConversationFoldersPaginated": { "title": "ConversationFoldersPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/ConversationFolder" } } }, "required": [ "meta", "records" ] }, "ConversationParticipant": { "title": "ConversationParticipant", "description": "ConversationParticipant\n\nModel rerpesenting a participant in a conversation", "type": "object", "properties": { "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "$ref": "#/components/schemas/ConversationParticipantType" } }, "required": [ "Type" ] }, "ConversationParticipantType": { "title": "ConversationParticipantType", "description": "ConversationParticipantType\n\nEnum for the type of participant", "type": "string", "enum": [ "contact", "team" ] }, "ConversationParticipantUpdate": { "title": "ConversationParticipantUpdate", "description": "ConversationParticipantUpdate\n\nModel representing an update of the id and name for a participant", "type": "object", "properties": { "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ConversationStatusEnum": { "title": "ConversationStatusEnum", "description": "ConversationStatusEnum\n\nStatus of the conversation", "type": "string", "enum": [ "OPEN", "CLOSED" ] }, "ConversationStreamPaginated": { "title": "ConversationStreamPaginated", "description": "ConversationStreamPaginated\n\nReturns pages of records and meta data about pagination\nRecords contain messages, calls, and inbound-failure markers (PRO-5964)", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Message" }, { "$ref": "#/components/schemas/Call" }, { "$ref": "#/components/schemas/InboundFailureMarker" } ] } } }, "required": [ "meta", "records" ] }, "ConversationUpdateBody-Input": { "title": "ConversationUpdateBody", "description": "ConversationUpdate\n\nProperties to receive on conversation update", "type": "object", "properties": { "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsCancelSnoozeOnReply": { "title": "Iscancelsnoozeonreply", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsRead": { "title": "Isread", "type": "boolean", "default": false }, "IsSnoozed": { "title": "Issnoozed", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSnoozedAlert": { "title": "Issnoozedalert", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Owner": { "title": "Owner", "description": "Member ID of the first team member to send an outbound message or call in this conversation", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Participants": { "title": "Participants", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/ConversationParticipant" } }, "SnoozedUntilTime": { "title": "Snoozeduntiltime", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ConversationUpdateBody-Output": { "title": "ConversationUpdateBody", "description": "ConversationUpdate\n\nProperties to receive on conversation update", "type": "object", "properties": { "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsCancelSnoozeOnReply": { "title": "Iscancelsnoozeonreply", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsRead": { "title": "Isread", "type": "boolean", "default": false }, "IsSnoozed": { "title": "Issnoozed", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSnoozedAlert": { "title": "Issnoozedalert", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Owner": { "title": "Owner", "description": "Member ID of the first team member to send an outbound message or call in this conversation", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Participants": { "title": "Participants", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/ConversationParticipant" } }, "SnoozedUntilTime": { "title": "Snoozeduntiltime", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ConversationUpdateFolderBody": { "title": "ConversationUpdateFolderBody", "description": "ConversationUpdateFolderBody\n\nProperties to receive on conversation update folder body", "type": "object", "properties": { "ConversationFolderId": { "title": "Conversationfolderid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ConversationUpdateSnoozeBody": { "title": "ConversationUpdateSnoozeBody", "description": "ConversationUpdateSnoozeBody\n\nSnoozing or unsnoozing a conversation", "type": "object", "properties": { "IsCancelSnoozeOnReply": { "title": "Iscancelsnoozeonreply", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSnoozed": { "title": "Issnoozed", "type": "boolean" }, "IsSnoozedAlert": { "title": "Issnoozedalert", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "SnoozedUntilTime": { "title": "Snoozeduntiltime", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "IsSnoozed" ] }, "ConversationUpdateStatusBody": { "title": "ConversationUpdateStatusBody", "description": "ConversationUpdateStatusBody\n\nProperties to receive on conversation update status body", "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/ConversationStatusEnum" } }, "required": [ "Status" ] }, "ConversationUpdateViewers": { "title": "ConversationUpdateViewers", "description": "ConversationUpdateViewers", "type": "object", "properties": { "Viewers": { "title": "Viewers", "anyOf": [ { "type": "object", "additionalProperties": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] } }, { "type": "null" } ] } } }, "ConversationsBulkUpdateStatusBody": { "title": "ConversationsBulkUpdateStatusBody", "description": "ConversationsUpdateStatusBody\n\nProperties to receive on nulk conversations update status body", "type": "object", "properties": { "ConversationIds": { "title": "Conversationids", "type": "array", "items": { "type": "string" } }, "Status": { "$ref": "#/components/schemas/ConversationStatusEnum" } }, "required": [ "ConversationIds", "Status" ] }, "ConversationsPaginated": { "title": "ConversationsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } } }, "required": [ "meta", "records" ] }, "CreateConversation": { "title": "CreateConversation", "description": "Create Conversation\n\nInclude that data required to make a new conversation.", "type": "object", "properties": { "Contacts": { "title": "Contacts", "type": "array", "items": { "$ref": "#/components/schemas/Contact" }, "minItems": 1 }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserNumber": { "title": "Usernumber", "type": "string" } }, "required": [ "UserNumber", "Contacts" ] }, "CreateConversationDraftIn": { "title": "CreateConversationDraftIn", "description": "CreateConversationDraftIn\n\nModel to represent the data required to create\nan intial skeleton of a conversation", "type": "object", "properties": { "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactNumber": { "title": "Contactnumber", "type": "string" }, "UserNumber": { "title": "Usernumber", "type": "string" } }, "required": [ "UserNumber", "ContactNumber" ] }, "CreateDialplan": { "title": "CreateDialplan", "description": "Model to create a new dialplan", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nodes": { "title": "Nodes", "type": "object", "additionalProperties": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentNode", "announce": "#/components/schemas/AnnouncementNode", "contact": "#/components/schemas/ContactNode", "dial": "#/components/schemas/DialNode", "dynamic_dial": "#/components/schemas/DynamicDialNode", "hangup": "#/components/schemas/HangupNode", "prompt": "#/components/schemas/PromptNode", "schedule": "#/components/schemas/ScheduleNode", "start_record": "#/components/schemas/StartRecordNode", "stop_record": "#/components/schemas/StopRecordNode", "voicemail": "#/components/schemas/VoicemailNode" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgentNode" }, { "$ref": "#/components/schemas/AnnouncementNode" }, { "$ref": "#/components/schemas/ContactNode" }, { "$ref": "#/components/schemas/DialNode" }, { "$ref": "#/components/schemas/DynamicDialNode" }, { "$ref": "#/components/schemas/HangupNode" }, { "$ref": "#/components/schemas/PromptNode" }, { "$ref": "#/components/schemas/ScheduleNode" }, { "$ref": "#/components/schemas/StartRecordNode" }, { "$ref": "#/components/schemas/StopRecordNode" }, { "$ref": "#/components/schemas/VoicemailNode" } ] } }, "start_id": { "title": "Start Id", "type": "string" } }, "required": [ "start_id", "nodes" ] }, "CreateInbox": { "title": "CreateInbox", "description": "Model to create a new inbox", "type": "object", "properties": { "BusinessSchedule": { "title": "Businessschedule", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": [ { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "", "start": "" }, { "end": "", "start": "" } ] }, "BusinessTimezone": { "title": "Businesstimezone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallRingDuration": { "title": "Callringduration", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "15" }, "CallRingOrderType": { "title": "Callringordertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallTeamMemberIds": { "title": "Callteammemberids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "CallflowId": { "title": "Callflowid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ComplianceMessage": { "title": "Compliancemessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "You can call or text us at this number. Primarily, you can expect to receive brief news and updates from us. Msg & data rates may apply. Reply STOP to opt-out anytime. Questions? You are welcome to reply." }, "ComplianceVCardId": { "title": "Compliancevcardid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Dialplan": { "title": "Dialplan", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ForwardingTimeout": { "title": "Forwardingtimeout", "type": "integer", "default": 300 }, "ForwardingVoicemailMode": { "anyOf": [ { "$ref": "#/components/schemas/ForwardingVoicemailModeEnum" }, { "type": "null" } ] }, "GreetingAudioUrl": { "title": "Greetingaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HiddenFor": { "title": "Hiddenfor", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "InboundType": { "anyOf": [ { "$ref": "#/components/schemas/InboundTypeEnum" }, { "type": "null" } ] }, "IsComplianceAutoSuppress": { "title": "Iscomplianceautosuppress", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsComplianceEnabled": { "title": "Iscomplianceenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsDropCallerId": { "title": "Isdropcallerid", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoIncomingMessage": { "title": "Isenableautoincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoMissedCall": { "title": "Isenableautomissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutOfOfficeIncomingMessage": { "title": "Isenableautooutofofficeincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutOfOfficeMissedCall": { "title": "Isenableautooutofofficemissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutsideHoursIncomingMessage": { "title": "Isenableautooutsidehoursincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutsideHoursMissedCall": { "title": "Isenableautooutsidehoursmissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoRecordCalls": { "title": "Isenableautorecordcalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableBusinessHours": { "title": "Isenablebusinesshours", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableCallSummary": { "title": "Isenablecallsummary", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableCallTranscription": { "title": "Isenablecalltranscription", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableFilterProfanity": { "title": "Isenablefilterprofanity", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsEnableForwardCall": { "title": "Isenableforwardcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableGreeting": { "title": "Isenablegreeting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnablePhoneMenu": { "title": "Isenablephonemenu", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableRecordGreeting": { "title": "Isenablerecordgreeting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableRecordingAnnouncement": { "title": "Isenablerecordingannouncement", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableTranscribeVoicemail": { "title": "Isenabletranscribevoicemail", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSmsHosting": { "title": "Issmshosting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "MutedFor": { "title": "Mutedfor", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "type": "string" }, "NumberForwardTo": { "title": "Numberforwardto", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrgA2pId": { "title": "Orga2Pid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrgA2pStatus": { "title": "Orga2Pstatus", "anyOf": [ { "$ref": "#/components/schemas/InboxOrgA2PStatusEnum" }, { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeEndDate": { "title": "Outofofficeenddate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeEndTime": { "title": "Outofofficeendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeStartDate": { "title": "Outofofficestartdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeStartTime": { "title": "Outofofficestarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutsideHoursVoicemailAudioUrl": { "title": "Outsidehoursvoicemailaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Permissions": { "anyOf": [ { "$ref": "#/components/schemas/PermissionSettings" }, { "type": "null" } ] }, "RecordingAnnouncementPromptRef": { "title": "Recordingannouncementpromptref", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SkipTeamMemberIds": { "title": "Skipteammemberids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Symbol": { "title": "Symbol", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoAutoOutsideHoursMissedCall": { "title": "Textautoautooutsidehoursmissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoIncomingMessage": { "title": "Textautoincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoMissedCall": { "title": "Textautomissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutOfOfficeIncomingMessage": { "title": "Textautooutofofficeincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutOfOfficeMissedCall": { "title": "Textautooutofofficemissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutsideHoursIncomingMessage": { "title": "Textautooutsidehoursincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VoicemailAudioUrl": { "title": "Voicemailaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Number" ] }, "CreateRingGroup": { "title": "CreateRingGroup", "description": "Model to create a group", "type": "object", "properties": { "agents": { "title": "Agents", "type": "array", "items": { "type": "string" } }, "name": { "title": "Name", "type": "string" } }, "required": [ "agents", "name" ] }, "CreateSchedule": { "title": "CreateSchedule", "description": "Model to create a schedule", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "time_ranges": { "title": "Time Ranges", "type": "array", "default": [ [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [], [] ], "items": { "type": "array", "items": { "$ref": "#/components/schemas/Interval" } } }, "timezone": { "title": "Timezone", "type": "string", "default": "UTC" } }, "required": [ "name" ] }, "DialNode": { "title": "DialNode", "description": "Dial a target", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "dial", "default": "dial" }, "id": { "title": "Id", "type": "string" }, "no_answer": { "title": "No Answer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "targets": { "title": "Targets", "type": "array", "items": { "discriminator": { "mapping": { "client": "#/components/schemas/ClientTarget", "group": "#/components/schemas/GroupTarget", "inbox": "#/components/schemas/InboxTarget", "number": "#/components/schemas/NumberTarget" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/ClientTarget" }, { "$ref": "#/components/schemas/GroupTarget" }, { "$ref": "#/components/schemas/InboxTarget" }, { "$ref": "#/components/schemas/NumberTarget" } ] } }, "timeout_sec": { "title": "Timeout Sec", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "whisper": { "title": "Whisper", "description": "Playback source (audio URL) for a disclosure whispered privately to the answering callee before the legs are bridged. One whisper per dial node, applied to whichever target wins the fork -- the disclosure is a property of the call, not of which leg answered. Omit (the default) to bridge immediately, as before.", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "targets" ] }, "Dialplan": { "title": "Dialplan", "description": "Dialplan is a directed set of actions to perform when processing a call", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nodes": { "title": "Nodes", "type": "object", "additionalProperties": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentNode", "announce": "#/components/schemas/AnnouncementNode", "contact": "#/components/schemas/ContactNode", "dial": "#/components/schemas/DialNode", "dynamic_dial": "#/components/schemas/DynamicDialNode", "hangup": "#/components/schemas/HangupNode", "prompt": "#/components/schemas/PromptNode", "schedule": "#/components/schemas/ScheduleNode", "start_record": "#/components/schemas/StartRecordNode", "stop_record": "#/components/schemas/StopRecordNode", "voicemail": "#/components/schemas/VoicemailNode" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgentNode" }, { "$ref": "#/components/schemas/AnnouncementNode" }, { "$ref": "#/components/schemas/ContactNode" }, { "$ref": "#/components/schemas/DialNode" }, { "$ref": "#/components/schemas/DynamicDialNode" }, { "$ref": "#/components/schemas/HangupNode" }, { "$ref": "#/components/schemas/PromptNode" }, { "$ref": "#/components/schemas/ScheduleNode" }, { "$ref": "#/components/schemas/StartRecordNode" }, { "$ref": "#/components/schemas/StopRecordNode" }, { "$ref": "#/components/schemas/VoicemailNode" } ] } }, "start_id": { "title": "Start Id", "type": "string" } }, "required": [ "start_id", "nodes", "CreatedAt", "id" ] }, "DialplanInDB": { "title": "DialplanInDB", "description": "A dialplan in the database", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "PK": { "title": "Pk", "type": "string" }, "SK": { "title": "Sk", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nodes": { "title": "Nodes", "type": "object", "additionalProperties": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentNode", "announce": "#/components/schemas/AnnouncementNode", "contact": "#/components/schemas/ContactNode", "dial": "#/components/schemas/DialNode", "dynamic_dial": "#/components/schemas/DynamicDialNode", "hangup": "#/components/schemas/HangupNode", "prompt": "#/components/schemas/PromptNode", "schedule": "#/components/schemas/ScheduleNode", "start_record": "#/components/schemas/StartRecordNode", "stop_record": "#/components/schemas/StopRecordNode", "voicemail": "#/components/schemas/VoicemailNode" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgentNode" }, { "$ref": "#/components/schemas/AnnouncementNode" }, { "$ref": "#/components/schemas/ContactNode" }, { "$ref": "#/components/schemas/DialNode" }, { "$ref": "#/components/schemas/DynamicDialNode" }, { "$ref": "#/components/schemas/HangupNode" }, { "$ref": "#/components/schemas/PromptNode" }, { "$ref": "#/components/schemas/ScheduleNode" }, { "$ref": "#/components/schemas/StartRecordNode" }, { "$ref": "#/components/schemas/StopRecordNode" }, { "$ref": "#/components/schemas/VoicemailNode" } ] } }, "start_id": { "title": "Start Id", "type": "string" } }, "required": [ "start_id", "nodes", "CreatedAt", "id", "PK", "SK" ] }, "DialplanPaginated": { "title": "DialplanPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/DialplanInDB" } } }, "required": [ "meta", "records" ] }, "DispositionCreate": { "title": "DispositionCreate", "type": "object", "properties": { "Label": { "title": "Label", "description": "Disposition label (trimmed and de-duped case-insensitively)", "type": "string", "maxLength": 100, "minLength": 1 } }, "required": [ "Label" ] }, "DispositionRename": { "title": "DispositionRename", "type": "object", "properties": { "Label": { "title": "Label", "description": "Disposition label (trimmed and de-duped case-insensitively)", "type": "string", "maxLength": 100, "minLength": 1 } }, "required": [ "Label" ] }, "DispositionResponse": { "title": "DispositionResponse", "description": "Client-facing disposition record (PRO-4164 contract).\n\nThe stored ``DispositionInDB`` carries internal keys (PK/SK/WorkspaceId and\nthe NormalizedLabel de-dupe key) that must not leak to clients. This is the\nonly shape endpoints return: id/label/isDefault/archivedAt (+ createdAt).", "type": "object", "properties": { "ArchivedAt": { "title": "Archivedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DispositionId": { "title": "Dispositionid", "type": "string" }, "IsDefault": { "title": "Isdefault", "type": "boolean", "default": false }, "Label": { "title": "Label", "type": "string" } }, "required": [ "DispositionId", "Label" ] }, "DispositionsResponse": { "title": "DispositionsResponse", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/DispositionResponse" } } }, "required": [ "meta", "records" ] }, "Drop": { "title": "Drop", "description": "Drop\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "AudioUrl": { "title": "AudioUrl", "description": "Field of audio url to send", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "https://www.audio.com" }, "ContactId": { "title": "Contact Id", "description": "Id of the contact for outbounds", "anyOf": [ { "type": "string" }, { "type": "null" } ], "example": "1234-abcd-4567-ABCD" }, "ContactNumber": { "title": "Contact Number", "description": "Phone with a leading +1", "type": "string", "example": "+18008675309", "pattern": "^\\+[1-9]\\d{1,14}$" }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "default": "1617296378" }, "DropId": { "title": "Dropid", "type": "string" }, "Meta": { "title": "Meta", "description": "Key values of meta data for this drop, will be published as attributes to topic on callbacks", "type": "object", "additionalProperties": true }, "Report": { "$ref": "#/components/schemas/DropReport" }, "Status": { "$ref": "#/components/schemas/DropStatusEnum" }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string", "example": "1234-abcd-4567-ABCD" }, "UserNumber": { "title": "User Number", "description": "Phone with a leading +1", "type": "string", "example": "+18008675309", "pattern": "^\\+[1-9]\\d{1,14}$" }, "WebhookUrlStatus": { "title": "Webhookurlstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "DropCreate": { "description": "Create\n\nProperties to receive on drop creation", "properties": { "AudioUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Field of audio url to send", "example": "https://www.audio.com", "title": "AudioUrl" }, "ContactId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Id of the contact for outbounds", "example": "1234-abcd-4567-ABCD", "title": "Contact Id" }, "ContactNumber": { "description": "Phone with a leading +1", "example": "+18008675309", "pattern": "^\\+[1-9]\\d{1,14}$", "title": "Contact Number", "type": "string" }, "Meta": { "additionalProperties": true, "description": "Key values of meta data for this drop, will be published as attributes to topic on callbacks", "title": "Meta", "type": "object" }, "UserId": { "description": "Id of the app user", "example": "1234-abcd-4567-ABCD", "title": "User Id", "type": "string" }, "UserNumber": { "description": "Phone with a leading +1", "example": "+18008675309", "pattern": "^\\+[1-9]\\d{1,14}$", "title": "User Number", "type": "string" } }, "title": "DropCreate", "type": "object", "example": { "AudioUrl": "https://www.com", "ContactId": "1234-abcd-4567-ABCD", "ContactNumber": "+18008675309", "Meta": { "campaignId": "ABC", "contactId": "$%^", "dispatchId": "123" }, "UserId": "1234-abcd-4567-ABCD", "UserNumber": "+18008675309" } }, "DropReport": { "title": "DropReport", "description": "DropReport\n\nBody that is returned in the status callback", "type": "object", "properties": { "AttemptedAt": { "title": "Attemptedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Dnc": { "title": "Dnc", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalSystemId": { "title": "Externalsystemid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "InternalSystemId": { "title": "Internalsystemid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkName": { "title": "Networkname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkType": { "title": "Networktype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProductCost": { "title": "Productcost", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Reason": { "title": "Reason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/DropStatusEnum" }, { "type": "null" } ] }, "ToNmber": { "title": "Tonmber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Status" ] }, "DropStatusEnum": { "title": "DropStatusEnum", "description": "DropStatusEnum\n\nStatus of the drop", "type": "string", "enum": [ "created", "ready", "unsubscriber", "presenderror", "senderror", "sent", "error", "success", "failure" ] }, "DropUpdate": { "title": "DropUpdate", "description": "Update\n\nProperties to receive on drop update", "type": "object", "properties": { "DropId": { "title": "Dropid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Report": { "anyOf": [ { "$ref": "#/components/schemas/DropReport" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/DropStatusEnum" }, { "type": "null" } ] } } }, "DynamicDialNode": { "title": "DynamicDialNode", "description": "Route call based on contact tags matched against extension routing_tags.\n\nLooks up all workspace extensions (augmented with CRM-derived routing tags),\nintersects with the caller's contact tags, and fork-dials all matched\nteam-member extensions simultaneously. Routes to a matched inbox directly.\n\nLIMITATION: When multiple extensions match and nobody answers, voicemail\nfalls to the incoming call's inbox voicemail, not any individual team\nmember's personal voicemail.", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "dynamic_dial", "default": "dynamic_dial" }, "id": { "title": "Id", "type": "string" }, "no_answer": { "title": "No Answer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "no_match": { "title": "No Match", "type": "string" } }, "required": [ "no_match" ] }, "EmailAttachment": { "title": "EmailAttachment", "description": "EmailAttachment\n\n\nData should be base64 encoded\n\nhttps://docs.aws.amazon.com/ses/latest/dg/send-email-raw.html#send-email-raw-mime", "type": "object", "properties": { "Content": { "title": "Content" }, "ContentType": { "title": "Contenttype", "type": "string" }, "Filename": { "title": "Filename", "type": "string" } }, "required": [ "Filename", "ContentType", "Content" ] }, "ForwardedCallRequest": { "title": "ForwardedCallRequest", "description": "Model for an incoming request to originate and forwarded call", "type": "object", "properties": { "ContactNumber": { "title": "Contactnumber", "type": "string" }, "ForwardTo": { "title": "Forwardto", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserNumber": { "title": "Usernumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ContactNumber" ] }, "ForwardingVoicemailModeEnum": { "title": "ForwardingVoicemailModeEnum", "description": "Forwarding Voicemail Mode Enum\n\nPRO-6628: which voicemail should win the race when a forwarded call goes\nunanswered.\n- DESTINATION (default, `None`/absent behaves identically): the\n forwarded-to number's own carrier voicemail. `ForwardingTimeout` is\n floored at `crud.MIN_FORWARD_RING_SEC` so that voicemail has a real\n chance to answer.\n- CURRENTCLIENT: CurrentClient's own voicemail. `ForwardingTimeout` is\n passed through unfloored so a short ring lets it win instead.", "type": "string", "enum": [ "DESTINATION", "CURRENTCLIENT" ] }, "GroupTarget": { "title": "GroupTarget", "description": "Group target", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "group", "default": "group" }, "target": { "title": "Target", "type": "string" } }, "required": [ "target" ] }, "HangupNode": { "title": "HangupNode", "description": "Hangup the call", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "hangup", "default": "hangup" }, "id": { "title": "Id", "type": "string" } } }, "InboundFailureMarker": { "title": "InboundFailureMarker", "description": "InboundFailureMarker\n\nThe model to be used for responses. Doesn't include internal PK/SK.", "type": "object", "properties": { "ContactNumber": { "title": "Contact Number", "description": "Phone with a leading +1", "type": "string" }, "ConversationId": { "title": "Conversation ID", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ErrorCode": { "title": "Error Code", "description": "Twilio error code for the failure", "type": "string" }, "MarkerId": { "title": "Markerid", "type": "string" }, "TwilioSid": { "title": "Twilio Sid", "description": "Sid of the failed Twilio Message resource this marker was detected from. Identity/dedup only -- never resolved to content.", "type": "string" }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string" }, "UserNumber": { "title": "User Number", "description": "Inbox number, with a leading +1", "type": "string" } }, "required": [ "UserId", "UserNumber", "ContactNumber", "ErrorCode", "TwilioSid", "MarkerId" ] }, "InboundFailureMarkerCreate": { "title": "InboundFailureMarkerCreate", "description": "InboundFailureMarkerCreate\n\nRequest body for creating a marker. Internal/service-user only -- called\nby module-reconcile's scheduled sweep, never by the app directly.", "type": "object", "properties": { "ContactNumber": { "title": "Contact Number", "description": "Phone with a leading +1", "type": "string" }, "ConversationId": { "title": "Conversation ID", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorCode": { "title": "Error Code", "description": "Twilio error code for the failure", "type": "string" }, "TwilioSid": { "title": "Twilio Sid", "description": "Sid of the failed Twilio Message resource this marker was detected from. Identity/dedup only -- never resolved to content.", "type": "string" }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string" }, "UserNumber": { "title": "User Number", "description": "Inbox number, with a leading +1", "type": "string" } }, "required": [ "UserId", "UserNumber", "ContactNumber", "ErrorCode", "TwilioSid" ] }, "InboundFailureMarkerCreateResult": { "title": "InboundFailureMarkerCreateResult", "description": "Response for the create endpoint -- distinguishes fresh vs idempotent hit", "type": "object", "properties": { "created": { "title": "Created", "type": "boolean" }, "marker": { "$ref": "#/components/schemas/InboundFailureMarker" } }, "required": [ "marker", "created" ] }, "InboundTypeEnum": { "title": "InboundTypeEnum", "description": "Inbound Type Enum\n\nDetermines how incoming calls are handled for this inbox:\n- RING: Ring the team members in the app\n- FORWARD: Forward the call to an external number\n- DIALPLAN: Route through a custom dial plan", "type": "string", "enum": [ "RING", "FORWARD", "DIALPLAN" ] }, "Inbox": { "title": "Inbox", "description": "Collection for inbox", "type": "object", "properties": { "BusinessSchedule": { "title": "Businessschedule", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": [ { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "", "start": "" }, { "end": "", "start": "" } ] }, "BusinessTimezone": { "title": "Businesstimezone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallRingDuration": { "title": "Callringduration", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "15" }, "CallRingOrderType": { "title": "Callringordertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallTeamMemberIds": { "title": "Callteammemberids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "CallflowId": { "title": "Callflowid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ComplianceMessage": { "title": "Compliancemessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "You can call or text us at this number. Primarily, you can expect to receive brief news and updates from us. Msg & data rates may apply. Reply STOP to opt-out anytime. Questions? You are welcome to reply." }, "ComplianceVCardId": { "title": "Compliancevcardid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Dialplan": { "title": "Dialplan", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ForwardingTimeout": { "title": "Forwardingtimeout", "type": "integer", "default": 300 }, "ForwardingVoicemailMode": { "anyOf": [ { "$ref": "#/components/schemas/ForwardingVoicemailModeEnum" }, { "type": "null" } ] }, "GreetingAudioUrl": { "title": "Greetingaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HiddenFor": { "title": "Hiddenfor", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "InboundType": { "anyOf": [ { "$ref": "#/components/schemas/InboundTypeEnum" }, { "type": "null" } ] }, "IsComplianceAutoSuppress": { "title": "Iscomplianceautosuppress", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsComplianceEnabled": { "title": "Iscomplianceenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsDropCallerId": { "title": "Isdropcallerid", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoIncomingMessage": { "title": "Isenableautoincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoMissedCall": { "title": "Isenableautomissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutOfOfficeIncomingMessage": { "title": "Isenableautooutofofficeincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutOfOfficeMissedCall": { "title": "Isenableautooutofofficemissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutsideHoursIncomingMessage": { "title": "Isenableautooutsidehoursincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutsideHoursMissedCall": { "title": "Isenableautooutsidehoursmissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoRecordCalls": { "title": "Isenableautorecordcalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableBusinessHours": { "title": "Isenablebusinesshours", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableCallSummary": { "title": "Isenablecallsummary", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableCallTranscription": { "title": "Isenablecalltranscription", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableFilterProfanity": { "title": "Isenablefilterprofanity", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsEnableForwardCall": { "title": "Isenableforwardcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableGreeting": { "title": "Isenablegreeting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnablePhoneMenu": { "title": "Isenablephonemenu", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableRecordGreeting": { "title": "Isenablerecordgreeting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableRecordingAnnouncement": { "title": "Isenablerecordingannouncement", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableTranscribeVoicemail": { "title": "Isenabletranscribevoicemail", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSmsHosting": { "title": "Issmshosting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "MutedFor": { "title": "Mutedfor", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "type": "string" }, "NumberForwardTo": { "title": "Numberforwardto", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrgA2pId": { "title": "Orga2Pid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrgA2pStatus": { "title": "Orga2Pstatus", "anyOf": [ { "$ref": "#/components/schemas/InboxOrgA2PStatusEnum" }, { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeEndDate": { "title": "Outofofficeenddate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeEndTime": { "title": "Outofofficeendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeStartDate": { "title": "Outofofficestartdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeStartTime": { "title": "Outofofficestarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutsideHoursVoicemailAudioUrl": { "title": "Outsidehoursvoicemailaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Permissions": { "anyOf": [ { "$ref": "#/components/schemas/PermissionSettings" }, { "type": "null" } ] }, "RecordingAnnouncementPromptRef": { "title": "Recordingannouncementpromptref", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SkipTeamMemberIds": { "title": "Skipteammemberids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Symbol": { "title": "Symbol", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoAutoOutsideHoursMissedCall": { "title": "Textautoautooutsidehoursmissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoIncomingMessage": { "title": "Textautoincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoMissedCall": { "title": "Textautomissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutOfOfficeIncomingMessage": { "title": "Textautooutofofficeincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutOfOfficeMissedCall": { "title": "Textautooutofofficemissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutsideHoursIncomingMessage": { "title": "Textautooutsidehoursincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VoiceProvider": { "$ref": "#/components/schemas/VoiceProviderEnum", "default": "twilio" }, "VoicemailAudioUrl": { "title": "Voicemailaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Number" ] }, "InboxCallStats": { "title": "InboxCallStats", "description": "InboxCallStats\n\nCall counts for a specific inbox with daily breakdown for heatmap", "type": "object", "properties": { "CountInbound": { "title": "Countinbound", "type": "integer", "default": 0 }, "CountOutbound": { "title": "Countoutbound", "type": "integer", "default": 0 }, "CountTotal": { "title": "Counttotal", "type": "integer", "default": 0 }, "Days": { "title": "Days", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/InboxStatsDayEntry" } } } }, "InboxMessageStats": { "title": "InboxMessageStats", "description": "InboxMessageStats\n\nMessage counts for a specific inbox with daily breakdown for heatmap", "type": "object", "properties": { "CountReceived": { "title": "Countreceived", "type": "integer", "default": 0 }, "CountSent": { "title": "Countsent", "type": "integer", "default": 0 }, "CountTotal": { "title": "Counttotal", "type": "integer", "default": 0 }, "Days": { "title": "Days", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/InboxStatsDayEntry" } } } }, "InboxOrgA2PStatusEnum": { "title": "InboxOrgA2PStatusEnum", "description": "Inbox Org A2P Status Enum\n\nStatus tracking for linking an inbox to a business registration (A2P)", "type": "string", "enum": [ "PORTING_IN", "SMS_HOSTING_PENDING", "UNLINKED", "LINKING", "VOICE_LINKING", "SMS_LINKING", "WAITING_FOR_SMS", "ADDING_TO_MESSAGING_SERVICE", "SMS_LINKING_FAILED", "LINKED", "LINKED_TO_HOLDING_POOL", "UNLINKING" ] }, "InboxPagination": { "title": "InboxPagination", "description": "Pagniation\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Inbox" } } }, "required": [ "meta", "records" ] }, "InboxStatsDayEntry": { "title": "InboxStatsDayEntry", "description": "InboxStatsDayEntry\n\nActivity count for a single day - used for heatmap display", "type": "object", "properties": { "Count": { "title": "Count", "type": "integer", "default": 0 }, "Date": { "title": "Date", "type": "string" } }, "required": [ "Date" ] }, "InboxTarget": { "title": "InboxTarget", "description": "Inbox target", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "inbox", "default": "inbox" }, "target": { "title": "Target", "type": "string" } }, "required": [ "target" ] }, "InboxUpdate": { "title": "InboxUpdate", "description": "Model to update an inbox", "type": "object", "properties": { "BusinessSchedule": { "title": "Businessschedule", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ], "default": [ { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "1700", "start": "0900" }, { "end": "", "start": "" }, { "end": "", "start": "" } ] }, "BusinessTimezone": { "title": "Businesstimezone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallRingDuration": { "title": "Callringduration", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "15" }, "CallRingOrderType": { "title": "Callringordertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallTeamMemberIds": { "title": "Callteammemberids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "CallflowId": { "title": "Callflowid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ComplianceMessage": { "title": "Compliancemessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "You can call or text us at this number. Primarily, you can expect to receive brief news and updates from us. Msg & data rates may apply. Reply STOP to opt-out anytime. Questions? You are welcome to reply." }, "ComplianceVCardId": { "title": "Compliancevcardid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Dialplan": { "title": "Dialplan", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ForwardingTimeout": { "title": "Forwardingtimeout", "type": "integer", "default": 300 }, "ForwardingVoicemailMode": { "anyOf": [ { "$ref": "#/components/schemas/ForwardingVoicemailModeEnum" }, { "type": "null" } ] }, "GreetingAudioUrl": { "title": "Greetingaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HiddenFor": { "title": "Hiddenfor", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "InboundType": { "anyOf": [ { "$ref": "#/components/schemas/InboundTypeEnum" }, { "type": "null" } ] }, "IsComplianceAutoSuppress": { "title": "Iscomplianceautosuppress", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsComplianceEnabled": { "title": "Iscomplianceenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsDropCallerId": { "title": "Isdropcallerid", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoIncomingMessage": { "title": "Isenableautoincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoMissedCall": { "title": "Isenableautomissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutOfOfficeIncomingMessage": { "title": "Isenableautooutofofficeincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutOfOfficeMissedCall": { "title": "Isenableautooutofofficemissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutsideHoursIncomingMessage": { "title": "Isenableautooutsidehoursincomingmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoOutsideHoursMissedCall": { "title": "Isenableautooutsidehoursmissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableAutoRecordCalls": { "title": "Isenableautorecordcalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableBusinessHours": { "title": "Isenablebusinesshours", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableCallSummary": { "title": "Isenablecallsummary", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableCallTranscription": { "title": "Isenablecalltranscription", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableFilterProfanity": { "title": "Isenablefilterprofanity", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsEnableForwardCall": { "title": "Isenableforwardcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableGreeting": { "title": "Isenablegreeting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnablePhoneMenu": { "title": "Isenablephonemenu", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableRecordGreeting": { "title": "Isenablerecordgreeting", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableRecordingAnnouncement": { "title": "Isenablerecordingannouncement", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableTranscribeVoicemail": { "title": "Isenabletranscribevoicemail", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "MutedFor": { "title": "Mutedfor", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberForwardTo": { "title": "Numberforwardto", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrgA2pId": { "title": "Orga2Pid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrgA2pStatus": { "title": "Orga2Pstatus", "anyOf": [ { "$ref": "#/components/schemas/InboxOrgA2PStatusEnum" }, { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeEndDate": { "title": "Outofofficeenddate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeEndTime": { "title": "Outofofficeendtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeStartDate": { "title": "Outofofficestartdate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutOfOfficeStartTime": { "title": "Outofofficestarttime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OutsideHoursVoicemailAudioUrl": { "title": "Outsidehoursvoicemailaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Permissions": { "anyOf": [ { "$ref": "#/components/schemas/PermissionSettings" }, { "type": "null" } ] }, "RecordingAnnouncementPromptRef": { "title": "Recordingannouncementpromptref", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SkipTeamMemberIds": { "title": "Skipteammemberids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Symbol": { "title": "Symbol", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoAutoOutsideHoursMissedCall": { "title": "Textautoautooutsidehoursmissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoIncomingMessage": { "title": "Textautoincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoMissedCall": { "title": "Textautomissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutOfOfficeIncomingMessage": { "title": "Textautooutofofficeincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutOfOfficeMissedCall": { "title": "Textautooutofofficemissedcall", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TextAutoOutsideHoursIncomingMessage": { "title": "Textautooutsidehoursincomingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VoicemailAudioUrl": { "title": "Voicemailaudiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "InboxVoiceProviderUpdate": { "title": "InboxVoiceProviderUpdate", "description": "Request body of the admin-only `PUT /api/v1/inboxes/{number}/voice-provider`.\n\nIts own model rather than a field on InboxUpdate, so setting the provider\nstays an admin operation instead of riding along on the client-writable\ninbox PUT.", "type": "object", "properties": { "VoiceProvider": { "$ref": "#/components/schemas/VoiceProviderEnum" } }, "required": [ "VoiceProvider" ] }, "Interval": { "title": "Interval", "description": "A block of time with a start and stop time", "type": "object", "properties": { "end": { "title": "End", "type": "string" }, "start": { "title": "Start", "type": "string" } }, "required": [ "start", "end" ] }, "KeywordNumber": { "title": "KeywordNumber", "description": "KeywordNumber\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "Keyword": { "title": "Keyword", "type": "string" }, "KeywordNumberId": { "title": "Keywordnumberid", "type": "string" }, "Number": { "title": "Number", "type": "string" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Number", "Keyword", "UserId", "KeywordNumberId", "CreatedTime" ] }, "KeywordNumberCreate": { "title": "KeywordNumberCreate", "description": "Create\n\nProperties to receive on keywordnumber creation", "type": "object", "properties": { "Keyword": { "title": "Keyword", "type": "string" }, "Number": { "title": "Number", "type": "string" } }, "required": [ "Number", "Keyword" ] }, "KeywordNumbersPaginated": { "title": "KeywordNumbersPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/KeywordNumber" } } }, "required": [ "meta", "records" ] }, "KeywordRule": { "title": "KeywordRule", "description": "KeywordRule\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "AiModel": { "title": "Aimodel", "anyOf": [ { "$ref": "#/components/schemas/KeywordRuleAiModelEnum" }, { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageBody": { "title": "Autoreplymessagebody", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageBodyFinal": { "title": "Autoreplymessagebodyfinal", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageMediaItems": { "title": "Autoreplymessagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "AutoReplyMessageMediaItemsFinal": { "title": "Autoreplymessagemediaitemsfinal", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "DataGatherFields": { "title": "Datagatherfields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "HitCount": { "title": "Hitcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAiMode": { "title": "Isaimode", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerCreateOpportunity": { "title": "Istriggercreateopportunity", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerCreateTask": { "title": "Istriggercreatetask", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerNewContact": { "title": "Istriggernewcontact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerSequence": { "title": "Istriggersequence", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerTags": { "title": "Istriggertags", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerTaskList": { "title": "Istriggertasklist", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Keyword": { "title": "Keyword", "type": "string" }, "KeywordRuleId": { "title": "Keywordruleid", "type": "string" }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "TriggerCrmType": { "title": "Triggercrmtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerOpportunityId": { "title": "Triggeropportunityid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerOpportunityStageId": { "title": "Triggeropportunitystageid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerSequenceId": { "title": "Triggersequenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerTagNames": { "title": "Triggertagnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "UserNumber": { "title": "Usernumber", "type": "string" } }, "required": [ "Keyword", "UserNumber", "UserId", "KeywordRuleId", "CreatedTime" ] }, "KeywordRuleAiModelEnum": { "title": "KeywordRuleAiModelEnum", "description": "Ai framework types", "type": "string", "enum": [ "OPENAI", "CLAUDE" ] }, "KeywordRuleCreate": { "title": "KeywordRuleCreate", "description": "Create\n\nProperties to receive on keywordrule creation", "type": "object", "properties": { "AiModel": { "title": "Aimodel", "anyOf": [ { "$ref": "#/components/schemas/KeywordRuleAiModelEnum" }, { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageBody": { "title": "Autoreplymessagebody", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageBodyFinal": { "title": "Autoreplymessagebodyfinal", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageMediaItems": { "title": "Autoreplymessagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "AutoReplyMessageMediaItemsFinal": { "title": "Autoreplymessagemediaitemsfinal", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "DataGatherFields": { "title": "Datagatherfields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "HitCount": { "title": "Hitcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAiMode": { "title": "Isaimode", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerCreateOpportunity": { "title": "Istriggercreateopportunity", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerCreateTask": { "title": "Istriggercreatetask", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerNewContact": { "title": "Istriggernewcontact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerSequence": { "title": "Istriggersequence", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerTags": { "title": "Istriggertags", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerTaskList": { "title": "Istriggertasklist", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Keyword": { "title": "Keyword", "type": "string" }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "TriggerCrmType": { "title": "Triggercrmtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerOpportunityId": { "title": "Triggeropportunityid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerOpportunityStageId": { "title": "Triggeropportunitystageid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerSequenceId": { "title": "Triggersequenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerTagNames": { "title": "Triggertagnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UserNumber": { "title": "User's number for keyword rule", "anyOf": [ { "type": "string", "pattern": "^\\+1[0-9]{10}$" }, { "type": "null" } ] } }, "required": [ "Keyword" ] }, "KeywordRuleUpdate": { "title": "KeywordRuleUpdate", "description": "Update\n\nProperties to receive on keywordrule update", "type": "object", "properties": { "AiModel": { "title": "Aimodel", "anyOf": [ { "$ref": "#/components/schemas/KeywordRuleAiModelEnum" }, { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageBody": { "title": "Autoreplymessagebody", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageBodyFinal": { "title": "Autoreplymessagebodyfinal", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AutoReplyMessageMediaItems": { "title": "Autoreplymessagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "AutoReplyMessageMediaItemsFinal": { "title": "Autoreplymessagemediaitemsfinal", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "DataGatherFields": { "title": "Datagatherfields", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "HitCount": { "title": "Hitcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAiMode": { "title": "Isaimode", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerCreateOpportunity": { "title": "Istriggercreateopportunity", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerCreateTask": { "title": "Istriggercreatetask", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerNewContact": { "title": "Istriggernewcontact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerSequence": { "title": "Istriggersequence", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerTags": { "title": "Istriggertags", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTriggerTaskList": { "title": "Istriggertasklist", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Keyword": { "title": "Keyword", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "TriggerCrmType": { "title": "Triggercrmtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerOpportunityId": { "title": "Triggeropportunityid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerOpportunityStageId": { "title": "Triggeropportunitystageid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerSequenceId": { "title": "Triggersequenceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TriggerTagNames": { "title": "Triggertagnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UserNumber": { "title": "User's number for keyword rule", "anyOf": [ { "type": "string", "pattern": "^\\+1[0-9]{10}$" }, { "type": "null" } ] } } }, "KeywordRulesPaginated": { "title": "KeywordRulesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/KeywordRule" } } }, "required": [ "meta", "records" ] }, "Message": { "title": "Message", "description": "Message\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "ArchiverIds": { "title": "Archiverids", "description": "Dictionary to store archiver ids - key is ArchiverId, value is ArchiverType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "ChannelType": { "anyOf": [ { "$ref": "#/components/schemas/ChannelTypeEnum" }, { "type": "null" } ], "default": "sms" }, "Comments": { "title": "Comments", "description": "Comments about the message", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageComment" } }, { "type": "null" } ] }, "ContactId": { "title": "Contact Id", "description": "Id of the contact for outbounds", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contact Name", "description": "Name of the contact for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactNumber": { "title": "Contact Number", "description": "Phone with a leading +1 or a short code", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationId": { "title": "Conversation ID", "description": "A Twilio conversation ID or our number TO number format", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmIds": { "title": "Crmids", "description": "Dictionary to store CRM ids - key is CrmId, value is CrmType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Direction": { "anyOf": [ { "$ref": "#/components/schemas/MessageDirectionEnum" }, { "type": "null" } ] }, "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsIgnored": { "title": "Isignored", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSilenced": { "title": "Issilenced", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LocalMessageId": { "title": "Localmessageid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Message": { "title": "Message", "description": "Field of message to send", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageId": { "title": "Messageid", "type": "string" }, "MessageMediaItems": { "title": "MessageMediaItems", "description": "Media to include in message", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "Meta": { "title": "Meta", "description": "Key values of meta data for this message, will be published as attributes to topic on callbacks", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SenderMemberId": { "title": "Sender Member Id", "description": "Member id for the sender", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SenderName": { "title": "Sender Name", "description": "Name of the Sender for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/MessageStatusEnum" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "description": "Tags for the message", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "TwilioNumOfSegments": { "title": "Twilionumofsegments", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TwilioSid": { "title": "Twiliosid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UndeliveredContactNumber": { "title": "Undelivered Contact Number", "description": "For a group-conversation message, the specific participant number whose relay leg failed, resolved from Twilio's per-recipient onDeliveryUpdated ParticipantSid (PRO-6630/PRO-6632) since the message row's own ContactNumber can't name one recipient out of several. Unset for a 1:1 message, where ContactNumber already identifies the recipient, and unset if the participant lookup failed.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string" }, "UserNumber": { "title": "Number for the app user", "description": "Number with a leading +1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WebhookUrlStatus": { "title": "Webhookurlstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "MessageId" ] }, "MessageArchiverReceiptIds": { "title": "MessageArchiverReceiptIds", "type": "object", "properties": { "MessageIds": { "title": "Messageids", "type": "array", "items": { "type": "string" } } }, "required": [ "MessageIds" ] }, "MessageBatchUpdateArchiverIds": { "title": "MessageBatchUpdateArchiverIds", "type": "object", "properties": { "ArchiverType": { "title": "Archivertype", "type": "string" }, "ConnectorId": { "title": "Connectorid", "type": "string" }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageIds": { "title": "Messageids", "type": "array", "items": { "type": "string" } }, "NoteId": { "title": "Noteid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "MessageIds", "ConnectorId", "ArchiverType" ] }, "MessageBatchUpdateCrmIds": { "title": "MessageBatchUpdateCrmIds", "type": "object", "properties": { "ConnectorId": { "title": "Connectorid", "type": "string" }, "CrmType": { "title": "Crmtype", "type": "string" }, "MessageIds": { "title": "Messageids", "type": "array", "items": { "type": "string" } }, "NoteId": { "title": "Noteid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "MessageIds", "ConnectorId", "CrmType" ] }, "MessageComment": { "title": "MessageComment", "description": "MessageComment", "type": "object", "properties": { "Comment": { "title": "Comment", "type": "string" }, "CreatedByUserId": { "title": "Createdbyuserid", "type": "string" }, "CreatedByUserName": { "title": "Createdbyusername", "type": "string" }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "MessageCommentId": { "title": "Messagecommentid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Comment", "CreatedByUserId", "CreatedByUserName", "CreatedTime" ] }, "MessageCommentCreate": { "title": "MessageCommentCreate", "description": "MessageCommentCreate", "type": "object", "properties": { "Comment": { "title": "Comment", "type": "string" }, "CreatedByUserId": { "title": "Createdbyuserid", "type": "string" }, "CreatedByUserName": { "title": "Createdbyusername", "type": "string" } }, "required": [ "Comment", "CreatedByUserId", "CreatedByUserName" ] }, "MessageCreate": { "title": "MessageCreate", "description": "Create\n\nProperties to receive on message creation", "type": "object", "properties": { "ArchiverIds": { "title": "Archiverids", "description": "Dictionary to store archiver ids - key is ArchiverId, value is ArchiverType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "ChannelType": { "anyOf": [ { "$ref": "#/components/schemas/ChannelTypeEnum" }, { "type": "null" } ], "default": "sms" }, "Comments": { "title": "Comments", "description": "Comments about the message", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageComment" } }, { "type": "null" } ] }, "ContactId": { "title": "Contact Id", "description": "Id of the contact for outbounds", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contact Name", "description": "Name of the contact for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactNumber": { "title": "Contact Number", "description": "Phone with a leading +1 or a short code", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationId": { "title": "Conversation ID", "description": "A Twilio conversation ID or our number TO number format", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CrmIds": { "title": "Crmids", "description": "Dictionary to store CRM ids - key is CrmId, value is CrmType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsIgnored": { "title": "Isignored", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSilenced": { "title": "Issilenced", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LocalMessageId": { "title": "Localmessageid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Message": { "title": "Message", "description": "Field of message to send", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageMediaItems": { "title": "MessageMediaItems", "description": "Media to include in message", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "Meta": { "title": "Meta", "description": "Key values of meta data for this message, will be published as attributes to topic on callbacks", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SenderMemberId": { "title": "Sender Member Id", "description": "Member id for the sender", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SenderName": { "title": "Sender Name", "description": "Name of the Sender for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "description": "Tags for the message", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "UndeliveredContactNumber": { "title": "Undelivered Contact Number", "description": "For a group-conversation message, the specific participant number whose relay leg failed, resolved from Twilio's per-recipient onDeliveryUpdated ParticipantSid (PRO-6630/PRO-6632) since the message row's own ContactNumber can't name one recipient out of several. Unset for a 1:1 message, where ContactNumber already identifies the recipient, and unset if the participant lookup failed.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string" }, "UserNumber": { "title": "Number for the app user", "description": "Number with a leading +1", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "MessageDirectionEnum": { "title": "MessageDirectionEnum", "description": "MessageDirectionEnum\n\nDirection of the message, whether it was sent or received", "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "MessageInDB": { "title": "MessageInDB", "description": "InDB\n\nProperties properties stored in DB, this is full representation of\nrecord", "type": "object", "properties": { "ArchiverIds": { "title": "Archiverids", "description": "Dictionary to store archiver ids - key is ArchiverId, value is ArchiverType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "ChannelType": { "anyOf": [ { "$ref": "#/components/schemas/ChannelTypeEnum" }, { "type": "null" } ], "default": "sms" }, "Comments": { "title": "Comments", "description": "Comments about the message", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageComment" } }, { "type": "null" } ] }, "ContactId": { "title": "Contact Id", "description": "Id of the contact for outbounds", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contact Name", "description": "Name of the contact for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactNumber": { "title": "Contact Number", "description": "Phone with a leading +1 or a short code", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationId": { "title": "Conversation ID", "description": "A Twilio conversation ID or our number TO number format", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmIds": { "title": "Crmids", "description": "Dictionary to store CRM ids - key is CrmId, value is CrmType", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Direction": { "anyOf": [ { "$ref": "#/components/schemas/MessageDirectionEnum" }, { "type": "null" } ] }, "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI1PK": { "title": "Gsi1Pk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI1SK": { "title": "Gsi1Sk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI2PK": { "title": "Gsi2Pk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI2SK": { "title": "Gsi2Sk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI3PK": { "title": "Gsi3Pk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GSI3SK": { "title": "Gsi3Sk", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsIgnored": { "title": "Isignored", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSilenced": { "title": "Issilenced", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LocalMessageId": { "title": "Localmessageid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Message": { "title": "Message", "description": "Field of message to send", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageId": { "title": "Messageid", "type": "string" }, "MessageMediaItems": { "title": "MessageMediaItems", "description": "Media to include in message", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "Meta": { "title": "Meta", "description": "Key values of meta data for this message, will be published as attributes to topic on callbacks", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "PK": { "title": "Pk", "type": "string" }, "SK": { "title": "Sk", "type": "string" }, "Searchable": { "title": "Searchable", "type": "string" }, "SenderMemberId": { "title": "Sender Member Id", "description": "Member id for the sender", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SenderName": { "title": "Sender Name", "description": "Name of the Sender for quick reference", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/MessageStatusEnum" }, { "type": "null" } ] }, "TYPE": { "title": "Type", "type": "string" }, "Tags": { "title": "Tags", "description": "Tags for the message", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "TwilioNumOfSegments": { "title": "Twilionumofsegments", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TwilioSid": { "title": "Twiliosid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UndeliveredContactNumber": { "title": "Undelivered Contact Number", "description": "For a group-conversation message, the specific participant number whose relay leg failed, resolved from Twilio's per-recipient onDeliveryUpdated ParticipantSid (PRO-6630/PRO-6632) since the message row's own ContactNumber can't name one recipient out of several. Unset for a 1:1 message, where ContactNumber already identifies the recipient, and unset if the participant lookup failed.", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "User Id", "description": "Id of the app user", "type": "string" }, "UserNumber": { "title": "Number for the app user", "description": "Number with a leading +1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WebhookUrlStatus": { "title": "Webhookurlstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "MessageId", "TYPE", "PK", "SK", "Searchable" ] }, "MessageMediaItem": { "title": "MessageMediaItem", "description": "MessageMediaItem\n\nMedia object can be sent and received by/from twilio\n\nhttps://www.twilio.com/docs/sms/accepted-mime-types", "type": "object", "properties": { "ChatServiceId": { "title": "Chatserviceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FileName": { "title": "Filename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaId": { "title": "Mediaid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaType": { "title": "Mediatype", "type": "string" }, "MediaUrl": { "title": "Mediaurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "MediaType" ] }, "MessageStatusEnum": { "title": "MessageStatusEnum", "description": "MessageStatusEnum\n\nStatus of the message", "type": "string", "enum": [ "created", "ready", "blockednumber", "unsubscriber", "cannotroute", "error", "invalid", "nosms", "presenderror", "senderror", "unsubscribed", "accepted", "delivered", "failed", "queued", "read", "sending", "sent", "undelivered", "received", "receiving" ] }, "MessageUpdate": { "title": "MessageUpdate", "description": "Update\n\nProperties to receive on message update", "type": "object", "properties": { "ErrorCode": { "title": "Errorcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ErrorMessage": { "title": "Errormessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/MessageStatusEnum" }, { "type": "null" } ] }, "TwilioNumOfSegments": { "title": "Twilionumofsegments", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TwilioSid": { "title": "Twiliosid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UndeliveredContactNumber": { "title": "Undeliveredcontactnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "MessagesPaginated": { "title": "MessagesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Message" } } }, "required": [ "meta", "records" ] }, "Number": { "title": "Number", "description": "Number", "type": "object", "properties": { "AddressRequirements": { "title": "Addressrequirements", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Capabilities": { "$ref": "#/components/schemas/NumberCapabilities" }, "FriendlyName": { "title": "Friendlyname", "type": "string" }, "IsoCountry": { "title": "Isocountry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "type": "string" }, "PostalCode": { "title": "Postalcode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RateCenter": { "title": "Ratecenter", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Region": { "title": "Region", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "FriendlyName", "PhoneNumber", "Capabilities" ] }, "NumberCapabilities": { "title": "NumberCapabilities", "description": "NumberCapabilities", "type": "object", "properties": { "IsMMSEnabled": { "title": "Ismmsenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSMSEnabled": { "title": "Issmsenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsVoiceEnabled": { "title": "Isvoiceenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "IsMMSEnabled", "IsSMSEnabled", "IsVoiceEnabled" ] }, "NumberLookup": { "title": "NumberLookup", "description": "NumberLookup", "type": "object", "properties": { "AddOns": { "title": "Addons", "anyOf": [ {}, { "type": "null" } ] }, "CallerLookup": { "anyOf": [ { "$ref": "#/components/schemas/CallerLookup" }, { "type": "null" } ] }, "CarrierLookup": { "anyOf": [ { "$ref": "#/components/schemas/CarrierLookup" }, { "type": "null" } ] }, "CountryCode": { "title": "Countrycode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NationalFormat": { "title": "Nationalformat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "CallerLookup", "CarrierLookup", "AddOns" ] }, "NumberOptions": { "title": "NumberOptions", "description": "NumberOptions\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "IsIgnored": { "title": "Isignored", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSilenced": { "title": "Issilenced", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Number": { "title": "Number", "type": "string" }, "NumberOptionsId": { "title": "Numberoptionsid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Number", "UserId", "NumberOptionsId", "CreatedTime" ] }, "NumberOptionsCreate": { "description": "Create\n\nProperties to receive on numberoptions creation", "properties": { "IsIgnored": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isignored" }, "IsSilenced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Issilenced" }, "Number": { "title": "Number", "type": "string" } }, "required": [ "Number" ], "title": "NumberOptionsCreate", "type": "object", "example": { "IsSilenced": "true", "Number": "+18008675309" } }, "NumberOptionsPaginated": { "title": "NumberOptionsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/NumberOptions" } } }, "required": [ "meta", "records" ] }, "NumberOptionsUpdate": { "description": "NumberOptionsUpdate\n\nProperties to receive on block message update", "properties": { "IsIgnored": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Isignored" }, "IsSilenced": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Issilenced" }, "Number": { "title": "Number", "type": "string" } }, "required": [ "Number" ], "title": "NumberOptionsUpdate", "type": "object", "example": { "IsSilenced": "true", "Number": "+18008675309" } }, "NumberTarget": { "title": "NumberTarget", "description": "Phone number target", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "number", "default": "number" }, "target": { "title": "Target", "type": "string" } }, "required": [ "target" ] }, "PermissionSettings": { "title": "PermissionSettings", "description": "Model to hold inbox permission settings", "type": "object", "properties": { "Editors": { "title": "Editors", "type": "array", "default": [], "items": { "type": "string" } }, "Viewers": { "title": "Viewers", "type": "array", "default": [], "items": { "type": "string" } } } }, "PlaybackAnnouncement": { "title": "PlaybackAnnouncement", "description": "Playback some audio from a url", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "play", "default": "play" }, "url": { "title": "Url", "type": "string" } }, "required": [ "url" ] }, "PromptNode": { "title": "PromptNode", "description": "Execute a prompt and response", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "prompt", "default": "prompt" }, "announcement": { "title": "Announcement", "discriminator": { "mapping": { "play": "#/components/schemas/PlaybackAnnouncement", "say": "#/components/schemas/VoiceAnnouncement" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/PlaybackAnnouncement" }, { "$ref": "#/components/schemas/VoiceAnnouncement" } ] }, "enable_extension_dial": { "title": "Enable Extension Dial", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "id": { "title": "Id", "type": "string" }, "invalid_action": { "title": "Invalid Action", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "mapping": { "title": "Mapping", "type": "object", "additionalProperties": { "type": "string" }, "propertyNames": { "enum": [ "0", "1", "2", "3", "4", "5", "6", "7", "8", "9" ] } }, "timeout_action": { "title": "Timeout Action", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timeout_sec": { "title": "Timeout Sec", "type": "integer", "default": 5 } }, "required": [ "announcement", "mapping" ] }, "RawEmail": { "title": "RawEmail", "description": "RawEmail\n\nFields for sending out a raw email.", "type": "object", "properties": { "Attachments": { "title": "Attachments", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/EmailAttachment" } }, { "type": "null" } ] }, "BodyContent": { "title": "Bodycontent", "type": "string" }, "SendBCC": { "title": "Sendbcc", "anyOf": [ { "type": "array", "items": { "type": "string", "format": "email" } }, { "type": "null" } ] }, "SendCC": { "title": "Sendcc", "anyOf": [ { "type": "array", "items": { "type": "string", "format": "email" } }, { "type": "null" } ] }, "SendFrom": { "title": "Sendfrom", "type": "string" }, "SendSubject": { "title": "Sendsubject", "type": "string" }, "SendTo": { "title": "Sendto", "type": "array", "items": { "type": "string", "format": "email" } } }, "required": [ "SendFrom", "SendTo", "SendSubject", "BodyContent" ] }, "RecordingPrompt": { "title": "RecordingPrompt", "description": "A recording prompt: playable audio url, plus source text when the\nprompt came from the TTS-generated system default (uploaded prompts\nhave no source text).\n\nAudioUrl mirrors the shape of Inbox.GreetingAudioUrl -- a plain public\nhttps url to an mp3 in the outbounds public bucket -- so callers (the\nsettings-tier resolver in PRO-5675, the call-flow integration in\nPRO-5677) can treat it identically to any other announcement url.", "type": "object", "properties": { "AudioUrl": { "title": "Audiourl", "type": "string" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "IsSystem": { "title": "Issystem", "type": "boolean", "default": false }, "Text": { "title": "Text", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" } }, "required": [ "id", "AudioUrl", "CreatedAt" ] }, "RecordingPromptInDB": { "title": "RecordingPromptInDB", "description": "A recording prompt in the database", "type": "object", "properties": { "AudioUrl": { "title": "Audiourl", "type": "string" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "IsSystem": { "title": "Issystem", "type": "boolean", "default": false }, "PK": { "title": "Pk", "type": "string" }, "SK": { "title": "Sk", "type": "string" }, "Text": { "title": "Text", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "id": { "title": "Id", "type": "string" } }, "required": [ "id", "AudioUrl", "CreatedAt", "PK", "SK" ] }, "RecordingPromptPaginated": { "title": "RecordingPromptPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/RecordingPromptInDB" } } }, "required": [ "meta", "records" ] }, "RecordingStatusEnum": { "title": "RecordingStatusEnum", "description": "RecordingStatusEnum\n\nRecording Status of the call", "type": "string", "enum": [ "in-progress", "completed", "absent" ] }, "ReportUrl": { "title": "ReportUrl", "description": "ConversationReport", "type": "object", "properties": { "ReportUrl": { "title": "Reporturl", "type": "string" } }, "required": [ "ReportUrl" ] }, "RingGroup": { "title": "RingGroup", "description": "Collection of agents", "type": "object", "properties": { "agents": { "title": "Agents", "type": "array", "items": { "type": "string" } }, "dynamic": { "title": "Dynamic", "type": "boolean", "default": false }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "agents", "name", "id" ] }, "RingGroupPagination": { "title": "RingGroupPagination", "description": "Pagniation\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/RingGroup" } } }, "required": [ "meta", "records" ] }, "Schedule": { "title": "Schedule", "description": "Time-based schedule configuration", "type": "object", "properties": { "dynamic": { "title": "Dynamic", "type": "boolean", "default": false }, "id": { "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "time_ranges": { "title": "Time Ranges", "type": "array", "default": [ [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [ { "end": "1700", "start": "0900" } ], [], [] ], "items": { "type": "array", "items": { "$ref": "#/components/schemas/Interval" } } }, "timezone": { "title": "Timezone", "type": "string", "default": "UTC" } }, "required": [ "name", "id" ] }, "ScheduleNode": { "title": "ScheduleNode", "description": "Branch based on schedule active/inactive state", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "schedule", "default": "schedule" }, "active": { "title": "Active", "type": "string" }, "id": { "title": "Id", "type": "string" }, "inactive": { "title": "Inactive", "type": "string" }, "schedule_id": { "title": "Schedule Id", "type": "string" } }, "required": [ "schedule_id", "active", "inactive" ] }, "SchedulePagination": { "title": "SchedulePagination", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Schedule" } } }, "required": [ "meta", "records" ] }, "StartRecordNode": { "title": "StartRecordNode", "description": "Start recording the call. Non-blocking \u2014 call continues while recording runs.", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "start_record", "default": "start_record" }, "id": { "title": "Id", "type": "string" }, "max_duration_ms": { "title": "Max Duration Ms", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "next": { "title": "Next", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "record_channels": { "title": "Record Channels", "description": "Channel count of the call recording. Call recordings are always dual-channel (PRO-4301); this field makes that choice explicit on the wire rather than reopening it, so 2 is the only accepted value. Voicemail's own mono record path is a different node and is untouched.", "type": "integer", "const": 2, "default": 2 } } }, "StatTimeSeries": { "title": "StatTimeSeries", "description": "StatTimeSeries", "type": "object", "properties": { "data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/StatTimeSeriesCord" } }, "id": { "title": "Id", "type": "string" } }, "required": [ "id", "data" ] }, "StatTimeSeriesCord": { "title": "StatTimeSeriesCord", "description": "StatTimeSeriesCord", "type": "object", "properties": { "x": { "title": "X", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "y": { "title": "Y", "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "required": [ "x", "y" ] }, "StatUsageSummary": { "title": "StatUsageSummary", "description": "StatUsageSummary\n\nStat usage overview with the available chart data.", "type": "object", "properties": { "TimeSeriesActivity": { "title": "Timeseriesactivity", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/StatTimeSeries" } }, { "type": "null" } ] } }, "required": [ "TimeSeriesActivity" ] }, "StopRecordNode": { "title": "StopRecordNode", "description": "Stop an in-progress recording. Non-blocking.", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "stop_record", "default": "stop_record" }, "id": { "title": "Id", "type": "string" }, "next": { "title": "Next", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "Unsubscriber": { "title": "Unsubscriber", "description": "Unsubscriber\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedTime": { "title": "Createdtime", "type": "integer" }, "InboxNumber": { "title": "Inboxnumber", "type": "string" }, "Number": { "title": "Number", "type": "string" }, "UnsubscriberId": { "title": "Unsubscriberid", "type": "string" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Number", "InboxNumber", "UserId", "UnsubscriberId", "CreatedTime" ] }, "UnsubscriberCreate": { "description": "Create\n\nProperties to receive on unsubscriber creation", "properties": { "InboxNumber": { "title": "Inboxnumber", "type": "string" }, "Number": { "title": "Number", "type": "string" } }, "required": [ "Number", "InboxNumber" ], "title": "UnsubscriberCreate", "type": "object", "example": { "InboxNumber": "+13444126380", "Number": "+18008675309" } }, "UnsubscriberStatus": { "title": "UnsubscriberStatus", "description": "UnsubscriberStatus\n\nCheck a number against blocked list and return\nif blocked or allowed", "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/UnsubscriberStatusEnum" } }, "required": [ "Status" ] }, "UnsubscriberStatusEnum": { "title": "UnsubscriberStatusEnum", "description": "UnsubscriberStatusEnum\n\nStatus for whether a number is blocked or not", "type": "string", "enum": [ "BLOCKED", "ALLOW" ] }, "UnsubscribersPaginated": { "title": "UnsubscribersPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Unsubscriber" } } }, "required": [ "meta", "records" ] }, "UpdateDialplan-Input": { "title": "UpdateDialplan", "description": "Partial update to allow just updating the name when needed", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nodes": { "title": "Nodes", "anyOf": [ { "type": "object", "additionalProperties": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentNode", "announce": "#/components/schemas/AnnouncementNode", "contact": "#/components/schemas/ContactNode", "dial": "#/components/schemas/DialNode", "dynamic_dial": "#/components/schemas/DynamicDialNode", "hangup": "#/components/schemas/HangupNode", "prompt": "#/components/schemas/PromptNode", "schedule": "#/components/schemas/ScheduleNode", "start_record": "#/components/schemas/StartRecordNode", "stop_record": "#/components/schemas/StopRecordNode", "voicemail": "#/components/schemas/VoicemailNode" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgentNode" }, { "$ref": "#/components/schemas/AnnouncementNode" }, { "$ref": "#/components/schemas/ContactNode" }, { "$ref": "#/components/schemas/DialNode" }, { "$ref": "#/components/schemas/DynamicDialNode" }, { "$ref": "#/components/schemas/HangupNode" }, { "$ref": "#/components/schemas/PromptNode" }, { "$ref": "#/components/schemas/ScheduleNode" }, { "$ref": "#/components/schemas/StartRecordNode" }, { "$ref": "#/components/schemas/StopRecordNode" }, { "$ref": "#/components/schemas/VoicemailNode" } ] } }, { "type": "null" } ] }, "start_id": { "title": "Start Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "UpdateDialplan-Output": { "title": "UpdateDialplan", "description": "Partial update to allow just updating the name when needed", "type": "object", "properties": { "name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nodes": { "title": "Nodes", "anyOf": [ { "type": "object", "additionalProperties": { "discriminator": { "mapping": { "agent": "#/components/schemas/AgentNode", "announce": "#/components/schemas/AnnouncementNode", "contact": "#/components/schemas/ContactNode", "dial": "#/components/schemas/DialNode", "dynamic_dial": "#/components/schemas/DynamicDialNode", "hangup": "#/components/schemas/HangupNode", "prompt": "#/components/schemas/PromptNode", "schedule": "#/components/schemas/ScheduleNode", "start_record": "#/components/schemas/StartRecordNode", "stop_record": "#/components/schemas/StopRecordNode", "voicemail": "#/components/schemas/VoicemailNode" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/AgentNode" }, { "$ref": "#/components/schemas/AnnouncementNode" }, { "$ref": "#/components/schemas/ContactNode" }, { "$ref": "#/components/schemas/DialNode" }, { "$ref": "#/components/schemas/DynamicDialNode" }, { "$ref": "#/components/schemas/HangupNode" }, { "$ref": "#/components/schemas/PromptNode" }, { "$ref": "#/components/schemas/ScheduleNode" }, { "$ref": "#/components/schemas/StartRecordNode" }, { "$ref": "#/components/schemas/StopRecordNode" }, { "$ref": "#/components/schemas/VoicemailNode" } ] } }, { "type": "null" } ] }, "start_id": { "title": "Start Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "UsageMetricTypeEnum": { "title": "UsageMetricTypeEnum", "description": "UsageMetricTypeEnum\n\nType of metrics that can be reported on for usage", "type": "string", "enum": [ "CountMessagesInboundReceived", "CountMessagesConversationSent", "CountMessagesConversationFailed", "CountMessagesDispatchSent", "CountMessagesDispatchFailed", "CountMessagesAutoreplySent", "CountMessagesAutoreplyFailed", "CountMessagesAutoscheduledSent", "CountMessagesAutoscheduledFailed", "CountMessagesBroadcastSent", "CountMessagesBroadcastFailed", "CountSegmentsInboundReceived", "CountSegmentsConversationSent", "CountSegmentsConversationFailed", "CountSegmentsDispatchSent", "CountSegmentsDispatchFailed", "CountSegmentsAutoreplySent", "CountSegmentsAutoreplyFailed", "CountSegmentsAutoscheduledSent", "CountSegmentsAutoscheduledFailed", "CountSegmentsBroadcastSent", "CountSegmentsBroadcastFailed", "CountDropsSuccess", "CountDropsSent", "CountCallsInbound", "CountCallsOutbound", "CountCallsInboundSeconds", "CountCallsOutboundSeconds", "CountInternationalCost" ] }, "VoiceAnnouncement": { "title": "VoiceAnnouncement", "description": "Generate a text to speach announcement", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "say", "default": "say" }, "text": { "title": "Text", "type": "string" } }, "required": [ "text" ] }, "VoiceProviderEnum": { "title": "VoiceProviderEnum", "description": "Voice Provider Enum\n\nPRO-7115: which voice stack places and receives calls for THIS inbox.\nPer inbox, deliberately not per workspace: one workspace has to be able\nto run a Twilio inbox and a CC SIP inbox side by side, both live in the\nsame session.\n\nValues are lowercase, unlike the ALL-CAPS `InboundTypeEnum` /\n`ForwardingVoicemailModeEnum` above. That is not a style slip: cc-app-core\npasses this string verbatim from `resolveProviderConfig` into\n`createVoiceDriver`, whose registered driver ids are lowercase\n(`registerVoiceDriver('twilio', ...)`), and there is no normalization seam\nbetween the two. An ALL-CAPS value here would raise\nUnknownVoiceProviderError in the client.", "type": "string", "enum": [ "twilio", "sip" ] }, "VoicemailNode": { "title": "VoicemailNode", "description": "Direct the call to voicemail", "type": "object", "properties": { "type": { "title": "Type", "type": "string", "const": "voicemail", "default": "voicemail" }, "announcement": { "title": "Announcement", "anyOf": [ { "discriminator": { "mapping": { "play": "#/components/schemas/PlaybackAnnouncement", "say": "#/components/schemas/VoiceAnnouncement" }, "propertyName": "type" }, "oneOf": [ { "$ref": "#/components/schemas/PlaybackAnnouncement" }, { "$ref": "#/components/schemas/VoiceAnnouncement" } ] }, { "type": "null" } ] }, "filter_profanity": { "title": "Filter Profanity", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "id": { "title": "Id", "type": "string" }, "transcribe": { "title": "Transcribe", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false } } }, "A2pRegistrationRecord": { "title": "A2pRegistrationRecord", "description": "A single recorded network-member A2P registration charge event.", "type": "object", "properties": { "base_fee_cents": { "title": "Base Fee Cents", "type": "integer" }, "charged_at": { "title": "Charged At", "type": "integer" }, "network_id": { "title": "Network Id", "type": "string" }, "organization_id": { "title": "Organization Id", "type": "string" }, "workspace_id": { "title": "Workspace Id", "type": "string" } }, "required": [ "workspace_id", "organization_id", "network_id", "charged_at", "base_fee_cents" ] }, "A2pRegistrationRecordsResponse": { "title": "A2pRegistrationRecordsResponse", "description": "Paginated response for the internal a2p-registrations endpoint.", "type": "object", "properties": { "cursor": { "title": "Cursor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/A2pRegistrationRecord" } } }, "required": [ "records" ] }, "ActionExecutionIndexIdentifier": { "title": "ActionExecutionIndexIdentifier", "description": "Hubspot action execution index identifier model", "type": "object", "properties": { "actionExecutionIndex": { "title": "Actionexecutionindex", "type": "integer" }, "enrollmentId": { "title": "Enrollmentid", "type": "integer" } }, "required": [ "enrollmentId", "actionExecutionIndex" ] }, "ActiveSubscriptionFeatures": { "title": "ActiveSubscriptionFeatures", "description": "ActiveSubscriptionFeatures\n\nReturn if the user has active subscriptions for prices", "type": "object", "properties": { "IsActiveAiAgents": { "title": "Isactiveaiagents", "type": "boolean" }, "IsActiveAiSummaries": { "title": "Isactiveaisummaries", "type": "boolean" }, "IsActiveCallForward": { "title": "Isactivecallforward", "type": "boolean" }, "IsActiveInternational": { "title": "Isactiveinternational", "type": "boolean" }, "IsActiveOutreach": { "title": "Isactiveoutreach", "type": "boolean" }, "IsActiveVoice": { "title": "Isactivevoice", "type": "boolean" } }, "required": [ "IsActiveVoice", "IsActiveCallForward", "IsActiveOutreach", "IsActiveInternational", "IsActiveAiAgents", "IsActiveAiSummaries" ] }, "AdminImpersonateRequest": { "title": "AdminImpersonateRequest", "description": "AdminImpersonateRequest\n\nRequest body for cc-admin's \"View as customer\" action. Deliberately has\nno operator/actor field: the acting operator is read off the caller's\nOWN verified cc-admin-pool token (deps.get_current_ccadmin_operator),\nnever accepted from the request body. An audit trail whose actor is\nself-reported is worthless in exactly the situation it exists for -- an\nabuse investigation.", "type": "object", "properties": { "Email": { "title": "Email", "type": "string" } }, "required": [ "Email" ] }, "AdminImpersonateResponse": { "title": "AdminImpersonateResponse", "description": "AdminImpersonateResponse", "type": "object", "properties": { "SessionId": { "title": "Sessionid", "type": "string" }, "TargetOrganizationId": { "title": "Targetorganizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TargetUserId": { "title": "Targetuserid", "type": "string" }, "TargetWorkspaceId": { "title": "Targetworkspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Token": { "title": "Token", "type": "string" } }, "required": [ "Token", "SessionId", "TargetUserId" ] }, "AgentCoreListTypeEnum": { "title": "AgentCoreListTypeEnum", "description": "AgentCore list type", "type": "string", "enum": [ "STATES" ] }, "AgentCoreProperty": { "title": "AgentCoreProperty", "description": "Meta for AgentCore api property", "type": "object", "properties": { "FieldType": { "title": "Fieldtype", "type": "string" }, "FilterValues": { "title": "Filtervalues", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": [] }, "Label": { "title": "Label", "type": "string" }, "Name": { "title": "Name", "type": "string" } }, "required": [ "FieldType", "Label", "Name" ] }, "AutomationRule": { "title": "AutomationRule", "description": "AutomationRule\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "AdditionalNumbers": { "title": "Additionalnumbers", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdditionalPeopleType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleAdditionalPeopleTypeEnum" }, { "type": "null" } ] }, "AudienceType": { "title": "Audiencetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AutomationRuleId": { "title": "Automationruleid", "type": "string" }, "ContactFieldId": { "title": "Contactfieldid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "type": "string" }, "DateType": { "title": "Datetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "HouseholdType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleHouseholdTypeEnum" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSms": { "title": "Issms", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "MessageBody": { "title": "Messagebody", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageBodyWeekend": { "title": "Messagebodyweekend", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageMediaItems": { "title": "Messagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "NotTagIds": { "title": "Nottagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "OrTagIds": { "title": "Ortagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ScheduleDaysBefore": { "title": "Scheduledaysbefore", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ScheduledCount": { "title": "Scheduledcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SegmentId": { "title": "Segmentid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SendAtTime": { "title": "Sendattime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SendDateDegree": { "title": "Senddatedegree", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SendDateDegreeUnit": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateDegreeUnitEnum" }, { "type": "null" } ] }, "SendDateType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateTypeEnum" }, { "type": "null" } ] }, "SendDateTypeWeekend": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateTypeEnum" }, { "type": "null" } ] }, "SendTriggerType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleTriggerTypeEnum" }, { "type": "null" } ] }, "SentCount": { "title": "Sentcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TagIds": { "title": "Tagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "TuneType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleTuneTypeEnum" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "UserNumber": { "title": "Usernumber", "type": "string" } }, "required": [ "Title", "UserNumber", "UserId", "AutomationRuleId", "CreatedAt" ] }, "AutomationRuleAdditionalPeopleTypeEnum": { "title": "AutomationRuleAdditionalPeopleTypeEnum", "description": "Additional people types", "type": "string", "enum": [ "YES", "NO" ] }, "AutomationRuleCreate": { "title": "AutomationRuleCreate", "description": "Create\n\nProperties to receive on automationrule creation", "type": "object", "properties": { "AdditionalNumbers": { "title": "Additionalnumbers", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdditionalPeopleType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleAdditionalPeopleTypeEnum" }, { "type": "null" } ] }, "AudienceType": { "title": "Audiencetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactFieldId": { "title": "Contactfieldid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DateType": { "title": "Datetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "HouseholdType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleHouseholdTypeEnum" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSms": { "title": "Issms", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "MessageBody": { "title": "Messagebody", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageBodyWeekend": { "title": "Messagebodyweekend", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageMediaItems": { "title": "Messagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "NotTagIds": { "title": "Nottagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "OrTagIds": { "title": "Ortagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ScheduleDaysBefore": { "title": "Scheduledaysbefore", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ScheduledCount": { "title": "Scheduledcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SegmentId": { "title": "Segmentid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SendAtTime": { "title": "Sendattime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SendDateDegree": { "title": "Senddatedegree", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SendDateDegreeUnit": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateDegreeUnitEnum" }, { "type": "null" } ] }, "SendDateType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateTypeEnum" }, { "type": "null" } ] }, "SendDateTypeWeekend": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateTypeEnum" }, { "type": "null" } ] }, "SendTriggerType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleTriggerTypeEnum" }, { "type": "null" } ] }, "SentCount": { "title": "Sentcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TagIds": { "title": "Tagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "TuneType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleTuneTypeEnum" }, { "type": "null" } ] }, "UserNumber": { "title": "User's number for automation rule", "description": "User's number to send automation messages from", "anyOf": [ { "type": "string", "pattern": "^\\+1[0-9]{10}$" }, { "type": "null" } ], "example": "+18008675309" } }, "required": [ "Title" ] }, "AutomationRuleHouseholdTypeEnum": { "title": "AutomationRuleHouseholdTypeEnum", "description": "Household types", "type": "string", "enum": [ "ALL", "SPOUSE", "SKIP" ] }, "AutomationRuleSendDateDegreeUnitEnum": { "title": "AutomationRuleSendDateDegreeUnitEnum", "description": "Send date degree units", "type": "string", "enum": [ "DAY", "YEAR" ] }, "AutomationRuleSendDateTypeEnum": { "title": "AutomationRuleSendDateTypeEnum", "description": "SendDate types", "type": "string", "enum": [ "ON", "BEFORE", "AFTER" ] }, "AutomationRuleTriggerTypeEnum": { "title": "AutomationRuleTriggerTypeEnum", "description": "Send trigger type", "type": "string", "enum": [ "RECURRING", "ONETIME" ] }, "AutomationRuleTuneTypeEnum": { "title": "AutomationRuleTuneTypeEnum", "description": "Tune types", "type": "string", "enum": [ "AI", "STATIC" ] }, "AutomationRuleUpdate": { "title": "AutomationRuleUpdate", "description": "Update\n\nProperties to receive on automationrule update", "type": "object", "properties": { "AdditionalNumbers": { "title": "Additionalnumbers", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdditionalPeopleType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleAdditionalPeopleTypeEnum" }, { "type": "null" } ] }, "AudienceType": { "title": "Audiencetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactFieldId": { "title": "Contactfieldid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DateType": { "title": "Datetype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "HouseholdType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleHouseholdTypeEnum" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSms": { "title": "Issms", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "MessageBody": { "title": "Messagebody", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageBodyWeekend": { "title": "Messagebodyweekend", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageMediaItems": { "title": "Messagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "NotTagIds": { "title": "Nottagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "OrTagIds": { "title": "Ortagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ScheduleDaysBefore": { "title": "Scheduledaysbefore", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ScheduledCount": { "title": "Scheduledcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SegmentId": { "title": "Segmentid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SendAtTime": { "title": "Sendattime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SendDateDegree": { "title": "Senddatedegree", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SendDateDegreeUnit": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateDegreeUnitEnum" }, { "type": "null" } ] }, "SendDateType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateTypeEnum" }, { "type": "null" } ] }, "SendDateTypeWeekend": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleSendDateTypeEnum" }, { "type": "null" } ] }, "SendTriggerType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleTriggerTypeEnum" }, { "type": "null" } ] }, "SentCount": { "title": "Sentcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TagIds": { "title": "Tagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TuneType": { "anyOf": [ { "$ref": "#/components/schemas/AutomationRuleTuneTypeEnum" }, { "type": "null" } ] }, "UserNumber": { "title": "User's number for automation rule", "description": "User's number to send automation messages from", "anyOf": [ { "type": "string", "pattern": "^\\+1[0-9]{10}$" }, { "type": "null" } ], "example": "+18008675309" } } }, "AutomationRulesPaginated": { "title": "AutomationRulesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/AutomationRule" } } }, "required": [ "records" ] }, "BankQuestion": { "title": "BankQuestion", "description": "BankQuestion\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "BankQuestionId": { "title": "Bankquestionid", "type": "string" }, "BankQuestionType": { "$ref": "#/components/schemas/BankQuestionTypeEnum" }, "CreatedByUserBrandImageUrl": { "title": "Createdbyuserbrandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedByUserId": { "title": "Createdbyuserid", "type": "string" }, "CreatedByUserName": { "title": "Createdbyusername", "type": "string" }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "IsAllowAddProbes": { "title": "Isallowaddprobes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsAllowRemoveProbes": { "title": "Isallowremoveprobes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsIncludeQuestionDescription": { "title": "Isincludequestiondescription", "type": "boolean" }, "IsLockDescription": { "title": "Islockdescription", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsLockTitle": { "title": "Islocktitle", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Probes": { "title": "Probes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/BankQuestionProbe" } }, { "type": "null" } ] }, "QuestionDescription": { "title": "Questiondescription", "type": "string" }, "QuestionTitle": { "title": "Questiontitle", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "BankQuestionType", "QuestionTitle", "QuestionDescription", "IsIncludeQuestionDescription", "UserId", "BankQuestionId", "CreatedTime", "CreatedByUserId", "CreatedByUserName" ] }, "BankQuestionCreate": { "title": "BankQuestionCreate", "description": "Create\n\nProperties to receive on bankquestion creation", "type": "object", "properties": { "BankQuestionType": { "$ref": "#/components/schemas/BankQuestionTypeEnum" }, "IsAllowAddProbes": { "title": "Isallowaddprobes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsAllowRemoveProbes": { "title": "Isallowremoveprobes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsIncludeQuestionDescription": { "title": "Isincludequestiondescription", "type": "boolean" }, "IsLockDescription": { "title": "Islockdescription", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsLockTitle": { "title": "Islocktitle", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Probes": { "title": "Probes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/BankQuestionProbe" } }, { "type": "null" } ] }, "QuestionDescription": { "title": "Questiondescription", "type": "string" }, "QuestionTitle": { "title": "Questiontitle", "type": "string" } }, "required": [ "BankQuestionType", "QuestionTitle", "QuestionDescription", "IsIncludeQuestionDescription" ] }, "BankQuestionProbe": { "title": "BankQuestionProbe", "description": "BankQuestionProbe\n\nA probe tied to mutli select question", "type": "object", "properties": { "IsAllowRemoveProbe": { "title": "Isallowremoveprobe", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsLockName": { "title": "Islockname", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "Name": { "title": "Name", "type": "string" } }, "required": [ "Name" ] }, "BankQuestionTypeEnum": { "title": "BankQuestionTypeEnum", "description": "Template question types", "type": "string", "enum": [ "TEXT_SHORT", "TEXT_LONG", "MULTI_SELECT", "RADIO_SELECT" ] }, "BankQuestionUpdate": { "title": "BankQuestionUpdate", "description": "Update\n\nProperties to receive on bankquestion update", "type": "object", "properties": { "BankQuestionType": { "anyOf": [ { "$ref": "#/components/schemas/BankQuestionTypeEnum" }, { "type": "null" } ] }, "IsAllowAddProbes": { "title": "Isallowaddprobes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsAllowRemoveProbes": { "title": "Isallowremoveprobes", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsIncludeQuestionDescription": { "title": "Isincludequestiondescription", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsLockDescription": { "title": "Islockdescription", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsLockTitle": { "title": "Islocktitle", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Probes": { "title": "Probes", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/BankQuestionProbe" } }, { "type": "null" } ] }, "QuestionDescription": { "title": "Questiondescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "QuestionTitle": { "title": "Questiontitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "Billing": { "title": "Billing", "description": "Billing\n\nBilling provides fields for the billing record.", "type": "object", "properties": { "AddonIds": { "title": "Addonids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "AddonNames": { "title": "Addonnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "BillingType": { "title": "Billingtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BundleIds": { "title": "Bundleids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "BundleNames": { "title": "Bundlenames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "CancelAtTime": { "title": "Cancelattime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CanceledAtTime": { "title": "Canceledattime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "PriceIds": { "title": "Priceids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ProductDescription": { "title": "Productdescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProductId": { "title": "Productid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProductName": { "title": "Productname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StripeCustomerId": { "title": "Stripecustomerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionId": { "title": "Subscriptionid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionStatus": { "anyOf": [ { "$ref": "#/components/schemas/StripeSubscriptionStatusEnum" }, { "type": "null" } ] } } }, "BillingConfig": { "title": "BillingConfig", "description": "BillingConfig\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CallForwarding": { "anyOf": [ { "$ref": "#/components/schemas/ProductData" }, { "type": "null" } ] }, "Prices": { "title": "Prices", "type": "object", "additionalProperties": true }, "Products": { "title": "Products", "type": "object", "additionalProperties": true }, "Registration": { "anyOf": [ { "$ref": "#/components/schemas/ProductData" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "type": "string" } }, "required": [ "Products", "Prices", "UpdatedAt" ] }, "BillingConfigCreate": { "title": "BillingConfigCreate", "description": "Create\n\nProperties to receive on billingconfig creation", "type": "object", "properties": { "CallForwarding": { "anyOf": [ { "$ref": "#/components/schemas/ProductData" }, { "type": "null" } ] }, "Prices": { "title": "Prices", "type": "object", "additionalProperties": true }, "Products": { "title": "Products", "type": "object", "additionalProperties": true }, "Registration": { "anyOf": [ { "$ref": "#/components/schemas/ProductData" }, { "type": "null" } ] } }, "required": [ "Products", "Prices" ] }, "BillingConfigUpdate": { "title": "BillingConfigUpdate", "description": "Update\n\nProperties to receive on billingconfig update", "type": "object", "properties": { "CallForwarding": { "anyOf": [ { "$ref": "#/components/schemas/ProductData" }, { "type": "null" } ] }, "Products": { "title": "Products", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Registration": { "anyOf": [ { "$ref": "#/components/schemas/ProductData" }, { "type": "null" } ] } } }, "BillingDetails": { "title": "BillingDetails", "description": "Consolidated billing details for an account", "type": "object", "properties": { "BillingCadence": { "title": "Billingcadence", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Invoices": { "title": "Invoices", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/BillingInvoice" } }, { "type": "null" } ] }, "PeriodEnd": { "title": "Periodend", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "PeriodStart": { "title": "Periodstart", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "PriceIds": { "title": "Priceids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ProductIds": { "title": "Productids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ProductNames": { "title": "Productnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BillingInDB": { "title": "BillingInDB", "description": "Billing\n\nSome more info not needed on ui", "type": "object", "properties": { "AddonIds": { "title": "Addonids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "AddonNames": { "title": "Addonnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "AddonsLookupIds": { "title": "Addonslookupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "BillingType": { "title": "Billingtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BundleIds": { "title": "Bundleids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "BundleNames": { "title": "Bundlenames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "BundlesLookupIds": { "title": "Bundleslookupids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "CancelAtTime": { "title": "Cancelattime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CanceledAtTime": { "title": "Canceledattime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "PriceIds": { "title": "Priceids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ProductDescription": { "title": "Productdescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProductId": { "title": "Productid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProductLookupId": { "title": "Productlookupid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProductName": { "title": "Productname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StripeCustomerId": { "title": "Stripecustomerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionId": { "title": "Subscriptionid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionStatus": { "anyOf": [ { "$ref": "#/components/schemas/StripeSubscriptionStatusEnum" }, { "type": "null" } ] } } }, "BillingInvoice": { "title": "BillingInvoice", "description": "A Stripe invoice summary", "type": "object", "properties": { "AmountDue": { "title": "Amountdue", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "AmountPaid": { "title": "Amountpaid", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Created": { "title": "Created", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Currency": { "title": "Currency", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HostedInvoiceUrl": { "title": "Hostedinvoiceurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "InvoicePdf": { "title": "Invoicepdf", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PeriodEnd": { "title": "Periodend", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "PeriodStart": { "title": "Periodstart", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BillingPaymentMethod": { "title": "BillingPaymentMethod", "description": "BillingPaymentMethod\n\nPayment method object", "type": "object", "properties": { "Card": { "anyOf": [ { "$ref": "#/components/schemas/BillingPaymentMethodCard" }, { "type": "null" } ] }, "Created": { "title": "Created", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BillingPaymentMethodCard": { "title": "BillingPaymentMethodCard", "description": "BillingPaymentMethodCard", "type": "object", "properties": { "Brand": { "title": "Brand", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExpMonth": { "title": "Expmonth", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExpYear": { "title": "Expyear", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Last4": { "title": "Last4", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BillingPlans": { "title": "BillingPlans", "description": "BillingPlans\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Products": { "title": "Products", "type": "object", "additionalProperties": true }, "UpdatedAt": { "title": "Updatedat", "type": "string" } }, "required": [ "Products", "UpdatedAt" ] }, "BillingPortalConfiguration": { "title": "BillingPortalConfiguration", "description": "BillingPortalConfiguration\n\nFeature for biling portal", "type": "object", "properties": { "IsInvoiceHistoryPortal": { "title": "Isinvoicehistoryportal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsPaymentMethodPortal": { "title": "Ispaymentmethodportal", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "ReturnUrl": { "title": "Returnurl", "type": "string" } }, "required": [ "ReturnUrl" ] }, "BillingStatement": { "title": "BillingStatement", "description": "BillingStatement\n\nThe model to be used for responses.", "type": "object", "properties": { "FileName": { "title": "Filename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "Body_create_billingstatement_api_v1_portin_billing_statements__post": { "title": "Body_create_billingstatement_api_v1_portin_billing_statements__post", "type": "object", "properties": { "file": { "title": "File", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "file" ] }, "Body_create_organization_subscription_api_v1_organizations_create_checkout_session_post": { "title": "Body_create_organization_subscription_api_v1_organizations_create_checkout_session_post", "type": "object", "properties": { "cancelUrl": { "title": "Cancelurl", "type": "string" }, "successUrl": { "title": "Successurl", "type": "string" } }, "required": [ "successUrl", "cancelUrl" ] }, "Body_create_privacypolicy_api_v1_orga2ps_privacy_policies__post": { "title": "Body_create_privacypolicy_api_v1_orga2ps_privacy_policies__post", "type": "object", "properties": { "file": { "title": "File", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "file" ] }, "Body_create_upload_usermedia_api_v1_usermedia__post": { "title": "Body_create_upload_usermedia_api_v1_usermedia__post", "type": "object", "properties": { "media": { "title": "Media", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "media" ] }, "Body_post_add_addon_api_v1_billing_add_addon_post": { "title": "Body_post_add_addon_api_v1_billing_add_addon_post", "type": "object", "properties": { "PriceIds": { "title": "Priceids", "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "PriceIds" ] }, "Body_post_change_plan_api_v1_billing_change_plan_post": { "title": "Body_post_change_plan_api_v1_billing_change_plan_post", "type": "object", "properties": { "PriceId": { "title": "Priceid", "type": "string" } }, "required": [ "PriceId" ] }, "Body_post_create_checkout_session_api_v1_billing_create_checkout_session_post": { "title": "Body_post_create_checkout_session_api_v1_billing_create_checkout_session_post", "type": "object", "properties": { "cancelUrl": { "title": "Cancelurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "productBundleIds": { "title": "Productbundleids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "productLookupId": { "title": "Productlookupid", "type": "string" }, "quantity": { "title": "Quantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": 1 }, "successUrl": { "title": "Successurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "productLookupId", "successUrl", "cancelUrl" ] }, "Body_post_remove_addon_api_v1_billing_remove_addon_post": { "title": "Body_post_remove_addon_api_v1_billing_remove_addon_post", "type": "object", "properties": { "PriceIds": { "title": "Priceids", "type": "array", "items": { "type": "string" }, "minItems": 1 } }, "required": [ "PriceIds" ] }, "Body_register_number_api_v1_profile_register_number_post": { "title": "Body_register_number_api_v1_profile_register_number_post", "type": "object", "properties": { "phoneNumber": { "title": "Phone number", "description": "Phone number with a leading +1", "type": "string" } } }, "Body_upload_audio_file_api_v1_useraudios_upload_audio_post": { "title": "Body_upload_audio_file_api_v1_useraudios_upload_audio_post", "type": "object", "properties": { "audio": { "title": "Audio", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "audio" ] }, "Body_upload_audio_file_api_v1_voice_upload_audio_post": { "title": "Body_upload_audio_file_api_v1_voice_upload_audio_post", "type": "object", "properties": { "audio": { "title": "Audio", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "audio" ] }, "Body_upload_brand_image_api_v1_brand_upload_brand_post": { "title": "Body_upload_brand_image_api_v1_brand_upload_brand_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_organization_brand_image_api_v1_organizations_upload_brand_post": { "title": "Body_upload_organization_brand_image_api_v1_organizations_upload_brand_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_profile_branding_image_api_v1_profile_uploadbranding_post": { "title": "Body_upload_profile_branding_image_api_v1_profile_uploadbranding_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_teammember_branding_image_api_v1_team_members__id__uploadbranding_post": { "title": "Body_upload_teammember_branding_image_api_v1_team_members__id__uploadbranding_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_tether_brand_logo_api_v1_tether_links_upload_logo_post": { "title": "Body_upload_tether_brand_logo_api_v1_tether_links_upload_logo_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_tether_image_api_v1_tether_links_upload_post": { "title": "Body_upload_tether_image_api_v1_tether_links_upload_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_vcard_image_api_v1_vcards_upload_post": { "title": "Body_upload_vcard_image_api_v1_vcards_upload_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_video_author_image_api_v1_videos__id__upload_author_post": { "title": "Body_upload_video_author_image_api_v1_videos__id__upload_author_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_video_brand_image_api_v1_videos__id__upload_brand_post": { "title": "Body_upload_video_brand_image_api_v1_videos__id__upload_brand_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Body_upload_video_favicon_image_api_v1_videos__id__upload_favicon_post": { "title": "Body_upload_video_favicon_image_api_v1_videos__id__upload_favicon_post", "type": "object", "properties": { "image": { "title": "Image", "type": "string", "contentMediaType": "application/octet-stream" } }, "required": [ "image" ] }, "Brand": { "title": "Brand", "description": "Brand\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "BrandId": { "title": "Brandid", "type": "string" }, "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "StyleActionBannerBg": { "title": "Styleactionbannerbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleLegalFontColor": { "title": "Stylelegalfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionBg": { "title": "Styleprimaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionColor": { "title": "Styleprimaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryBgColor": { "title": "Styleprimarybgcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryFontColor": { "title": "Styleprimaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionBg": { "title": "Stylesecondaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionColor": { "title": "Stylesecondaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryFontColor": { "title": "Stylesecondaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VideoThumbnailUrl": { "title": "Videothumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VoiceMemoThumbnailUrl": { "title": "Voicememothumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "UserId", "BrandId", "CreatedTime" ] }, "BrandDomain": { "title": "BrandDomain", "description": "BrandDomain\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "BrandDomainId": { "title": "Branddomainid", "type": "string" }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "DnsTarget": { "title": "Dnstarget", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DomainName": { "title": "Domainname", "type": "string" }, "IsConfigured": { "title": "Isconfigured", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsVerified": { "title": "Isverified", "type": "boolean" }, "LastCheckedTime": { "title": "Lastcheckedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VerificationName": { "title": "Verificationname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationType": { "title": "Verificationtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationValue": { "title": "Verificationvalue", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "DomainName", "IsVerified", "UserId", "BrandDomainId", "CreatedTime" ] }, "BrandDomainCreate": { "title": "BrandDomainCreate", "description": "Create\n\nProperties to receive on branddomain creation", "type": "object", "properties": { "DnsTarget": { "title": "Dnstarget", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DomainName": { "title": "Domainname", "type": "string" }, "IsConfigured": { "title": "Isconfigured", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsVerified": { "title": "Isverified", "type": "boolean" }, "LastCheckedTime": { "title": "Lastcheckedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationName": { "title": "Verificationname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationType": { "title": "Verificationtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationValue": { "title": "Verificationvalue", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "DomainName", "IsVerified" ] }, "BrandDomainUpdate": { "title": "BrandDomainUpdate", "description": "Update\n\nProperties to receive on branddomain update", "type": "object", "properties": { "DnsTarget": { "title": "Dnstarget", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DomainName": { "title": "Domainname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsConfigured": { "title": "Isconfigured", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsVerified": { "title": "Isverified", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastCheckedTime": { "title": "Lastcheckedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationName": { "title": "Verificationname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationType": { "title": "Verificationtype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VerificationValue": { "title": "Verificationvalue", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BrandDomainsPaginated": { "title": "BrandDomainsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/BrandDomain" } } }, "required": [ "records" ] }, "BrandUpdate": { "title": "BrandUpdate", "description": "Update\n\nProperties to receive on brand update", "type": "object", "properties": { "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleActionBannerBg": { "title": "Styleactionbannerbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleLegalFontColor": { "title": "Stylelegalfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionBg": { "title": "Styleprimaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionColor": { "title": "Styleprimaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryBgColor": { "title": "Styleprimarybgcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryFontColor": { "title": "Styleprimaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionBg": { "title": "Stylesecondaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionColor": { "title": "Stylesecondaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryFontColor": { "title": "Stylesecondaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VideoThumbnailUrl": { "title": "Videothumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VoiceMemoThumbnailUrl": { "title": "Voicememothumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BrandUrl": { "title": "BrandUrl", "description": "BrandUrl", "type": "object", "properties": { "BrandUrlId": { "title": "Brandurlid", "type": "string" }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "DomainName": { "title": "Domainname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsTetherLink": { "title": "Istetherlink", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "ShortId": { "title": "Shortid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TargetUrl": { "title": "Targeturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId", "BrandUrlId", "CreatedTime" ] }, "BrandUrlCreate": { "title": "BrandUrlCreate", "description": "BrandUrlCreate", "type": "object", "properties": { "DomainName": { "title": "Domainname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsTetherLink": { "title": "Istetherlink", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "ShortId": { "title": "Shortid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TargetUrl": { "title": "Targeturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BrandUrlPaginated": { "title": "BrandUrlPaginated", "description": "BrandUrlPaginated", "type": "object", "properties": { "Items": { "title": "Items", "type": "array", "items": { "$ref": "#/components/schemas/BrandUrl" } }, "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": {} } }, "required": [ "records", "Items" ] }, "BrandUrlUpdate": { "title": "BrandUrlUpdate", "description": "Update\n\nProperties to receive on branddomain update", "type": "object", "properties": { "DomainName": { "title": "Domainname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsTetherLink": { "title": "Istetherlink", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "ShortId": { "title": "Shortid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TargetUrl": { "title": "Targeturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "BusinessTypesEnum": { "title": "BusinessTypesEnum", "description": "Business Types Enum\nTypes of a business used for a2p registration", "type": "string", "enum": [ "SOLE_PROPRIETORSHIP", "PARTNERSHIP", "LIMITED_LIABILITY_CORPORATION", "COOPERATIVE", "NONPROFIT_CORPORATION", "CORPORATION" ] }, "ButtonActionTypeEnum": { "title": "ButtonActionTypeEnum", "description": "Button action types", "type": "string", "enum": [ "LINK", "CALL", "EMAIL", "SMS" ] }, "Cairn": { "title": "Cairn", "description": "Cairn\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CairnId": { "title": "Cairnid", "type": "string" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "GroupLabel": { "title": "Grouplabel", "type": "string" }, "GroupOrder": { "title": "Grouporder", "type": "integer" }, "Order": { "title": "Order", "type": "integer" }, "Tasks": { "title": "Tasks", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/CairnTask" } }, "Title": { "title": "Title", "type": "string" } }, "required": [ "CairnId", "GroupOrder", "GroupLabel", "Order", "Title" ] }, "CairnTask": { "title": "CairnTask", "description": "CairnTask", "type": "object", "properties": { "CairnTaskId": { "title": "Cairntaskid", "type": "string" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "JourneyKey": { "$ref": "#/components/schemas/JourneyKeys" }, "Order": { "title": "Order", "type": "integer" }, "PageLink": { "title": "Pagelink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PageLinkUrl": { "title": "Pagelinkurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "VideoId": { "title": "Videoid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VideoTitle": { "title": "Videotitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "CairnTaskId", "JourneyKey", "Order", "Title" ] }, "CairnsPaginated": { "title": "CairnsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Cairn" } } }, "required": [ "records" ] }, "CommunityTemplate": { "title": "CommunityTemplate", "description": "CommunityTemplate\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Description": { "title": "Description", "type": "string" }, "Industry": { "title": "Industry", "type": "string" }, "Message": { "title": "Message", "type": "string" }, "Order": { "title": "Order", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TemplateId": { "title": "Templateid", "type": "string" }, "Title": { "title": "Title", "type": "string" }, "Topic": { "title": "Topic", "type": "string" } }, "required": [ "TemplateId", "Industry", "Topic", "Title", "Description", "Message" ] }, "CommunityTemplatesPaginated": { "title": "CommunityTemplatesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/CommunityTemplate" } } }, "required": [ "records" ] }, "ComponentTypeEnum": { "title": "ComponentTypeEnum", "description": "TetherLink component types", "type": "string", "enum": [ "TEXT", "VIDEO", "BUTTON", "LINK" ] }, "ConnectionRequest": { "title": "ConnectionRequest", "description": "Connection Request\n\nA request to connect a new OAuth provider", "type": "object", "properties": { "Domain": { "title": "Domain", "type": "string" }, "Meta": { "title": "Meta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Provider": { "title": "Provider", "type": "string" }, "Redirect": { "title": "Redirect", "type": "string" }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Domain", "Provider", "Redirect" ] }, "ConnectionResponse": { "title": "ConnectionResponse", "description": "Connection Response\n\nThe successful response from a connection request", "type": "object", "properties": { "Url": { "title": "Url", "type": "string" } }, "required": [ "Url" ] }, "Connector": { "title": "Connector", "description": "Connector\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "ConnectorId": { "title": "Connectorid", "type": "string" }, "ConnectorName": { "title": "Connectorname", "type": "string" }, "ConnectorSecureParamName": { "title": "Connectorsecureparamname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorType": { "title": "Connectortype", "type": "string" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsFirm": { "title": "Isfirm", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ { "$ref": "#/components/schemas/ConnectorMetaAgencyBloc" }, { "$ref": "#/components/schemas/ConnectorMetaAgentCore" }, { "$ref": "#/components/schemas/ConnectorMetaEmail" }, { "$ref": "#/components/schemas/ConnectorMetaMedicarePro" }, { "$ref": "#/components/schemas/ConnectorMetaMobile" }, { "$ref": "#/components/schemas/ConnectorMetaHubspotOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaSlant" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBoxOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaRadiusBob" }, { "$ref": "#/components/schemas/ConnectorMetaRedtail" }, { "$ref": "#/components/schemas/ConnectorMetaSlackOauth" }, { "$ref": "#/components/schemas/ConnectorMetaGoogleDrive" }, { "$ref": "#/components/schemas/ConnectorMetaTeams" }, { "$ref": "#/components/schemas/ConnectorMetaSMS" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBox" }, { "$ref": "#/components/schemas/ConnectorMetaWebhooks" }, { "$ref": "#/components/schemas/ConnectorMetaOAuth" }, {} ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "UserNumber": { "title": "Usernumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ConnectorName", "ConnectorType", "Meta", "UserId", "ConnectorId", "CreatedAt" ] }, "ConnectorContactCreateInHubspot": { "title": "ConnectorContactCreateInHubspot", "description": "Hubspot create contact", "type": "object", "properties": { "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "IsHubspot": { "title": "Ishubspot", "type": "boolean" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "type": "string" }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName", "Phone", "IsHubspot" ] }, "ConnectorContactCreateInMedicarePro": { "title": "ConnectorContactCreateInMedicarePro", "description": "MedicarePro create contact", "type": "object", "properties": { "ContactStatus": { "title": "Contactstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "IsMedicarePro": { "title": "Ismedicarepro", "type": "boolean" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "type": "string" }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName", "Phone", "IsMedicarePro" ] }, "ConnectorContactCreateInQuivr": { "title": "ConnectorContactCreateInQuivr", "description": "Quivr create contact", "type": "object", "properties": { "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "Household": { "$ref": "#/components/schemas/Household" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "type": "string" }, "RecordTypeId": { "title": "Recordtypeid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName", "Phone", "Household" ] }, "ConnectorContactCreateInRedtail": { "title": "ConnectorContactCreateInRedtail", "description": "Redtail create contact", "type": "object", "properties": { "ContactCategoryId": { "title": "Contactcategoryid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactSourceId": { "title": "Contactsourceid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "ContactStatusId": { "title": "Contactstatusid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "IsRedtail": { "title": "Isredtail", "type": "boolean" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "type": "string" }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName", "Phone", "IsRedtail" ] }, "ConnectorContactCreateInSlant": { "title": "ConnectorContactCreateInSlant", "description": "Slant create contact\n\nSlant requires a parent entity (Prospect or professional Contact) before a\nperson can be created. The backend orchestrates that two-step flow:\n- If HouseholdId is provided, the person is added to that existing\n prospect/contact and step 1 is skipped.\n- Otherwise the backend creates a new Prospect or Contact in BookId,\n then creates the person under it.", "type": "object", "properties": { "BookId": { "title": "Bookid", "type": "string" }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "HouseholdId": { "title": "Householdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsSlant": { "title": "Isslant", "type": "boolean" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "type": "string" }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Type": { "$ref": "#/components/schemas/SlantContactTypeEnum" } }, "required": [ "FirstName", "LastName", "Phone", "IsSlant", "BookId", "Type" ] }, "ConnectorContactCreateInWealthbox": { "title": "ConnectorContactCreateInWealthbox", "description": "Wealthbox create contact", "type": "object", "properties": { "ContactSource": { "title": "Contactsource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactType": { "title": "Contacttype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "IsWealthbox": { "title": "Iswealthbox", "type": "boolean" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "type": "string" }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName", "Phone", "IsWealthbox" ] }, "ConnectorContactPhoneUpdateIn": { "title": "ConnectorContactPhoneUpdateIn", "description": "Update the phone number on an existing crm contact", "type": "object", "properties": { "Phone": { "title": "Phone", "type": "string" } }, "required": [ "Phone" ] }, "ConnectorCreate": { "title": "ConnectorCreate", "description": "Create\n\nProperties to receive on connector creation", "type": "object", "properties": { "ConnectorName": { "title": "Connectorname", "type": "string" }, "ConnectorSecureParamName": { "title": "Connectorsecureparamname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorType": { "title": "Connectortype", "type": "string" }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsFirm": { "title": "Isfirm", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ { "$ref": "#/components/schemas/ConnectorMetaAgencyBloc" }, { "$ref": "#/components/schemas/ConnectorMetaAgentCore" }, { "$ref": "#/components/schemas/ConnectorMetaEmail" }, { "$ref": "#/components/schemas/ConnectorMetaMedicarePro" }, { "$ref": "#/components/schemas/ConnectorMetaMobile" }, { "$ref": "#/components/schemas/ConnectorMetaHubspotOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaSlant" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBoxOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaRadiusBob" }, { "$ref": "#/components/schemas/ConnectorMetaRedtail" }, { "$ref": "#/components/schemas/ConnectorMetaSlackOauth" }, { "$ref": "#/components/schemas/ConnectorMetaGoogleDrive" }, { "$ref": "#/components/schemas/ConnectorMetaTeams" }, { "$ref": "#/components/schemas/ConnectorMetaSMS" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBox" }, { "$ref": "#/components/schemas/ConnectorMetaWebhooks" }, { "$ref": "#/components/schemas/ConnectorMetaOAuth" }, {} ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserNumber": { "title": "Usernumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ConnectorName", "ConnectorType", "Meta" ] }, "ConnectorCrmContact": { "title": "ConnectorCrmContact", "description": "ConnectorCrmContact\n\nBase crm contact props", "type": "object", "properties": { "AvatarUrl": { "title": "Avatarurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdId": { "title": "Householdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "SourceMeta": { "title": "Sourcemeta", "anyOf": [ { "type": "object", "additionalProperties": { "type": "string" } }, { "type": "null" } ] }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "SourceId" ] }, "ConnectorCrmEvent": { "title": "ConnectorCrmEvent", "description": "ConnectorCrmEvent\n\nBase crm task props to keep common vals", "type": "object", "properties": { "AuthorName": { "title": "Authorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EventId": { "title": "Eventid", "type": "string" }, "Label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LinkUrl": { "title": "Linkurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Location": { "title": "Location", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StartTime": { "title": "Starttime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "EventId" ] }, "ConnectorCrmTask": { "title": "ConnectorCrmTask", "description": "ConnectorCrmTask\n\nBase crm task props to keep common vals", "type": "object", "properties": { "AuthorName": { "title": "Authorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsTaskComplete": { "title": "Istaskcomplete", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTaskPastDue": { "title": "Istaskpastdue", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "TaskAssignedToName": { "title": "Taskassignedtoname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDescription": { "title": "Taskdescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDescriptionHtml": { "title": "Taskdescriptionhtml", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDueTime": { "title": "Taskduetime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskId": { "title": "Taskid", "type": "string" }, "TaskLinkUrl": { "title": "Tasklinkurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskLinkedTo": { "title": "Tasklinkedto", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorCrmTaskLinkedTo" } }, { "type": "null" } ] }, "TaskName": { "title": "Taskname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskPriority": { "title": "Taskpriority", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskVisibleTo": { "title": "Taskvisibleto", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "TaskId" ] }, "ConnectorCrmTaskLinkedTo": { "title": "ConnectorCrmTaskLinkedTo", "description": "Linked-to item on a CRM task (e.g. a contact).", "type": "object", "properties": { "Id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ConnectorHouseholdCreateIn": { "title": "ConnectorHouseholdCreateIn", "description": "Create household in CRM connector (Slant, Quivr, etc.)", "type": "object", "properties": { "BookId": { "title": "Bookid", "type": "string" }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tier": { "title": "Tier", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Type": { "title": "Type", "type": "string" } }, "required": [ "BookId", "Type" ] }, "ConnectorListTypeOption": { "title": "ConnectorListTypeOption", "description": "List type option value", "type": "object", "properties": { "AvatarUrl": { "title": "Avatarurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Label": { "title": "Label", "type": "string" }, "Value": { "title": "Value", "type": "string" } }, "required": [ "Label", "Value" ] }, "ConnectorLockIn": { "title": "ConnectorLockIn", "description": "Data to acquire lock", "type": "object", "properties": { "LockId": { "title": "Lockid", "type": "string" } }, "required": [ "LockId" ] }, "ConnectorMeetingCreateIn": { "title": "ConnectorMeetingCreateIn", "description": "Data to push meeting recording to notetaker connector", "type": "object", "properties": { "CallId": { "title": "Callid", "type": "string" }, "MeetingName": { "title": "Meetingname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RecordingUrl": { "title": "Recordingurl", "type": "string" } }, "required": [ "CallId", "RecordingUrl" ] }, "ConnectorMetaAgencyBloc": { "title": "ConnectorMetaAgencyBloc", "description": "Meta for MetaAgencyBloc channel", "type": "object", "properties": { "AccountSid": { "title": "Accountsid", "type": "string" }, "ApiKey": { "title": "Apikey", "type": "string" }, "FilterContactStatuses": { "title": "Filtercontactstatuses", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypes": { "title": "Filtercontacttypes", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "NumberOrderPreference": { "title": "Numberorderpreference", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ApiKey", "AccountSid" ] }, "ConnectorMetaAgentCore": { "title": "ConnectorMetaAgentCore", "description": "Meta for AgentCore channel", "type": "object", "properties": { "AgentCoreAgentNames": { "title": "Agentcoreagentnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": [] }, "AgentCoreApiKey": { "title": "Agentcoreapikey", "type": "string" }, "AgentCoreFilterProperties": { "title": "Agentcorefilterproperties", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AgentCoreProperty" } }, { "type": "null" } ] }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "AgentCoreApiKey" ] }, "ConnectorMetaAgentCoreApiListIn": { "title": "ConnectorMetaAgentCoreApiListIn", "description": "Meta for AgentCore api list request", "type": "object", "properties": { "ApiKey": { "title": "Apikey", "type": "string" }, "ListType": { "$ref": "#/components/schemas/AgentCoreListTypeEnum" } }, "required": [ "ApiKey", "ListType" ] }, "ConnectorMetaAgentCoreApiListOut": { "title": "ConnectorMetaAgentCoreApiListOut", "description": "Meta for AgentCore api key request", "type": "object", "properties": { "FieldType": { "title": "Fieldtype", "type": "string" }, "Label": { "title": "Label", "type": "string" }, "Options": { "title": "Options", "type": "array", "items": { "type": "string" } }, "Property": { "title": "Property", "type": "string" } }, "required": [ "Property", "Label", "FieldType" ] }, "ConnectorMetaEmail": { "title": "ConnectorMetaEmail", "description": "Meta for Email channel", "type": "object", "properties": { "EmailsCc": { "title": "Emailscc", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "EmailsTo": { "title": "Emailsto", "type": "array", "items": { "type": "string" } } }, "required": [ "EmailsTo" ] }, "ConnectorMetaGoogleDrive": { "title": "ConnectorMetaGoogleDrive", "description": "Meta for GoogleDrive channel", "type": "object", "properties": { "ConsecutiveAuthFailures": { "title": "Consecutiveauthfailures", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Domain": { "title": "Domain", "type": "string" }, "DriveFolderName": { "title": "Drivefoldername", "type": "string" }, "EncryptedAccessToken": { "title": "Encryptedaccesstoken", "type": "string" }, "EncryptedRefreshToken": { "title": "Encryptedrefreshtoken", "type": "string" }, "IsPushCallRecordings": { "title": "Ispushcallrecordings", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsPushVideos": { "title": "Ispushvideos", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastHealthCheck": { "title": "Lasthealthcheck", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastSuccessTime": { "title": "Lastsuccesstime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "VALID" }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TokenVersion": { "title": "Tokenversion", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Domain", "EncryptedAccessToken", "EncryptedRefreshToken", "DriveFolderName" ] }, "ConnectorMetaHubspotOAuth": { "title": "ConnectorMetaHubspotOAuth", "description": "Meta Hubspot for OAuth channels", "type": "object", "properties": { "ConsecutiveAuthFailures": { "title": "Consecutiveauthfailures", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ContactProperties": { "title": "Contactproperties", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/HubSpotProperty" } }, { "type": "null" } ] }, "Domain": { "title": "Domain", "type": "string" }, "EncryptedAccessToken": { "title": "Encryptedaccesstoken", "type": "string" }, "EncryptedRefreshToken": { "title": "Encryptedrefreshtoken", "type": "string" }, "HsAccountId": { "title": "Hsaccountid", "type": "string" }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastHealthCheck": { "title": "Lasthealthcheck", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastSuccessTime": { "title": "Lastsuccesstime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "VALID" }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TokenVersion": { "title": "Tokenversion", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Domain", "EncryptedAccessToken", "EncryptedRefreshToken", "HsAccountId" ] }, "ConnectorMetaMedicarePro": { "title": "ConnectorMetaMedicarePro", "description": "Meta for MedicarePro channel", "type": "object", "properties": { "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "MedicareProApiKey": { "title": "Medicareproapikey", "type": "string" }, "MedicareProFilterProperties": { "title": "Medicareprofilterproperties", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MedicareProProperty" } }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "MedicareProApiKey" ] }, "ConnectorMetaMedicareProApiListIn": { "title": "ConnectorMetaMedicareProApiListIn", "description": "Meta for MedicarePro api list request", "type": "object", "properties": { "ListType": { "$ref": "#/components/schemas/MedicareProListTypeEnum" } }, "required": [ "ListType" ] }, "ConnectorMetaMedicareProApiListOut": { "title": "ConnectorMetaMedicareProApiListOut", "description": "Meta for MedicarePro api key request", "type": "object", "properties": { "FieldType": { "title": "Fieldtype", "type": "string" }, "Label": { "title": "Label", "type": "string" }, "Options": { "title": "Options", "type": "array", "items": { "type": "string" } }, "Property": { "title": "Property", "type": "string" } }, "required": [ "Property", "Label", "FieldType" ] }, "ConnectorMetaMobile": { "title": "ConnectorMetaMobile", "description": "Meta for mobile channel", "type": "object", "properties": { "DeviceBrand": { "title": "Devicebrand", "type": "string" }, "DeviceId": { "title": "Deviceid", "type": "string" }, "DeviceModel": { "title": "Devicemodel", "type": "string" }, "DeviceName": { "title": "Devicename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExpoPushToken": { "title": "Expopushtoken", "type": "string" }, "PlatformOS": { "title": "Platformos", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlatformVersion": { "title": "Platformversion", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] } }, "required": [ "ExpoPushToken", "DeviceId", "DeviceModel", "DeviceBrand" ] }, "ConnectorMetaOAuth": { "title": "ConnectorMetaOAuth", "description": "Meta for OAuth channels", "type": "object", "properties": { "ConsecutiveAuthFailures": { "title": "Consecutiveauthfailures", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Domain": { "title": "Domain", "type": "string" }, "EncryptedAccessToken": { "title": "Encryptedaccesstoken", "type": "string" }, "EncryptedRefreshToken": { "title": "Encryptedrefreshtoken", "type": "string" }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastHealthCheck": { "title": "Lasthealthcheck", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastSuccessTime": { "title": "Lastsuccesstime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "VALID" }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TokenVersion": { "title": "Tokenversion", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Domain", "EncryptedAccessToken", "EncryptedRefreshToken" ] }, "ConnectorMetaRadiusBob": { "title": "ConnectorMetaRadiusBob", "description": "Meta for RadiusBob channel", "type": "object", "properties": { "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "RadiusBobApiKey": { "title": "Radiusbobapikey", "type": "string" }, "RadiusBobFilterProperties": { "title": "Radiusbobfilterproperties", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/AgentCoreProperty" } }, { "type": "null" } ] }, "RadiusBobRecordType": { "title": "Radiusbobrecordtype", "type": "string" }, "RadiusBobWebUrl": { "title": "Radiusbobweburl", "type": "string" }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "RadiusBobApiKey", "RadiusBobWebUrl", "RadiusBobRecordType" ] }, "ConnectorMetaRadiusBobApiListIn": { "title": "ConnectorMetaRadiusBobApiListIn", "description": "Meta for RadiusBob api list request", "type": "object", "properties": { "ApiKey": { "title": "Apikey", "type": "string" }, "ListType": { "$ref": "#/components/schemas/RadiusBobListTypeEnum" } }, "required": [ "ApiKey", "ListType" ] }, "ConnectorMetaRadiusBobApiListOut": { "title": "ConnectorMetaRadiusBobApiListOut", "description": "Meta for RadiusBob api key request", "type": "object", "properties": { "FieldType": { "title": "Fieldtype", "type": "string" }, "Label": { "title": "Label", "type": "string" }, "Options": { "title": "Options", "type": "array", "items": { "type": "string" } }, "Property": { "title": "Property", "type": "string" } }, "required": [ "Property", "Label", "FieldType" ] }, "ConnectorMetaRedtail": { "title": "ConnectorMetaRedtail", "description": "Meta for Redtail channel", "type": "object", "properties": { "ContactStatusIds": { "title": "Contactstatusids", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, { "type": "null" } ] }, "FilterContactTypeIds": { "title": "Filtercontacttypeids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypeNames": { "title": "Filtercontacttypenames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterServicingAdvisorIds": { "title": "Filterservicingadvisorids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterServicingAdvisorNames": { "title": "Filterservicingadvisornames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserKey": { "title": "Userkey", "type": "string" } }, "required": [ "UserKey" ] }, "ConnectorMetaRedtailApiListIn": { "title": "ConnectorMetaRedtailApiListIn", "description": "Meta for Redtail api key request", "type": "object", "properties": { "ListType": { "title": "Listtype", "type": "string" }, "Userkey": { "title": "Userkey", "type": "string" } }, "required": [ "Userkey", "ListType" ] }, "ConnectorMetaRedtailApiTokenIn": { "title": "ConnectorMetaRedtailApiTokenIn", "description": "Meta for Redtail api key request", "type": "object", "properties": { "Password": { "title": "Password", "type": "string" }, "Username": { "title": "Username", "type": "string" } }, "required": [ "Username", "Password" ] }, "ConnectorMetaSMS": { "title": "ConnectorMetaSMS", "description": "Meta for SMS channel", "type": "object", "properties": { "SmsTo": { "title": "Smsto", "type": "string" } }, "required": [ "SmsTo" ] }, "ConnectorMetaSlackOauth": { "title": "ConnectorMetaSlackOauth", "description": "Meta for Slack channel", "type": "object", "properties": { "ChannelName": { "title": "Channelname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConsecutiveAuthFailures": { "title": "Consecutiveauthfailures", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Domain": { "title": "Domain", "type": "string" }, "EncryptedAccessToken": { "title": "Encryptedaccesstoken", "type": "string" }, "EncryptedRefreshToken": { "title": "Encryptedrefreshtoken", "type": "string" }, "IsArchive": { "title": "Isarchive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsPushMissedCall": { "title": "Ispushmissedcall", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsPushNewCallRecording": { "title": "Ispushnewcallrecording", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsPushNewMessage": { "title": "Ispushnewmessage", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsPushNewVoicemail": { "title": "Ispushnewvoicemail", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsPushSurveySubmission": { "title": "Ispushsurveysubmission", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastHealthCheck": { "title": "Lasthealthcheck", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastSuccessTime": { "title": "Lastsuccesstime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SlackWebhookUrl": { "title": "Slackwebhookurl", "type": "string" }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "VALID" }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TokenVersion": { "title": "Tokenversion", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Domain", "EncryptedAccessToken", "EncryptedRefreshToken", "SlackWebhookUrl" ] }, "ConnectorMetaSlant": { "title": "ConnectorMetaSlant", "description": "Meta for Slant OAuth channel.\n\nRegistered in TYPE_CONNECTOR_META (ordered before ConnectorMetaWealthBoxOAuth)\nso its Slant-specific filter fields \u2014 notably FilterBookIds/FilterBookNames\n(PRO-3133) \u2014 survive Union validation on update instead of being dropped as\nextras when a Slant Meta dict matches WealthBoxOAuth.", "type": "object", "properties": { "ConsecutiveAuthFailures": { "title": "Consecutiveauthfailures", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Domain": { "title": "Domain", "type": "string" }, "EncryptedAccessToken": { "title": "Encryptedaccesstoken", "type": "string" }, "EncryptedRefreshToken": { "title": "Encryptedrefreshtoken", "type": "string" }, "FilterBookIds": { "title": "Filterbookids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterBookNames": { "title": "Filterbooknames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypeIds": { "title": "Filtercontacttypeids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypeNames": { "title": "Filtercontacttypenames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "IsCrm": { "title": "Iscrm", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastHealthCheck": { "title": "Lasthealthcheck", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastSuccessTime": { "title": "Lastsuccesstime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "VALID" }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TokenVersion": { "title": "Tokenversion", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Domain", "EncryptedAccessToken", "EncryptedRefreshToken" ] }, "ConnectorMetaTeams": { "title": "ConnectorMetaTeams", "description": "Meta for Microsoft Teams Activity Feed channel (PRO-4099/PRO-4100).\n\nStores the user's Microsoft (Entra AAD) identity, captured via Teams SSO\nwhen the embedded web app provisions notifications. ``IsStale`` is set when\nGraph reports the Teams app is no longer installed (RecipientNotInstalled);\nthe frontend re-provisions to clear it.", "type": "object", "properties": { "IsStale": { "title": "Isstale", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "MicrosoftGraphAADObjectId": { "title": "Microsoftgraphaadobjectid", "type": "string" }, "MicrosoftTenantId": { "title": "Microsofttenantid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StaleAt": { "title": "Staleat", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "MicrosoftGraphAADObjectId" ] }, "ConnectorMetaWealthBox": { "title": "ConnectorMetaWealthBox", "description": "Meta for WealthBox channel", "type": "object", "properties": { "ApiKey": { "title": "Apikey", "type": "string" }, "ContactType": { "title": "Contacttype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FilterAdvisorIds": { "title": "Filteradvisorids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterAdvisorNames": { "title": "Filteradvisornames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTagIds": { "title": "Filtercontacttagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTagNames": { "title": "Filtercontacttagnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypeIds": { "title": "Filtercontacttypeids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypeNames": { "title": "Filtercontacttypenames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "IsIncludeCompany": { "title": "Isincludecompany", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsIncludeInactive": { "title": "Isincludeinactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsIncludeTrust": { "title": "Isincludetrust", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ApiKey" ] }, "ConnectorMetaWealthBoxApiListIn": { "title": "ConnectorMetaWealthBoxApiListIn", "description": "Meta for WealthBox api key request", "type": "object", "properties": { "ApiKey": { "title": "Apikey", "type": "string" }, "ListType": { "title": "Listtype", "type": "string" } }, "required": [ "ApiKey", "ListType" ] }, "ConnectorMetaWealthBoxOAuth": { "title": "ConnectorMetaWealthBoxOAuth", "description": "Meta for WealthBox OAuth channel", "type": "object", "properties": { "ConsecutiveAuthFailures": { "title": "Consecutiveauthfailures", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ContactType": { "title": "Contacttype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Domain": { "title": "Domain", "type": "string" }, "EncryptedAccessToken": { "title": "Encryptedaccesstoken", "type": "string" }, "EncryptedRefreshToken": { "title": "Encryptedrefreshtoken", "type": "string" }, "FilterAdvisorIds": { "title": "Filteradvisorids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterAdvisorNames": { "title": "Filteradvisornames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTagIds": { "title": "Filtercontacttagids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTagNames": { "title": "Filtercontacttagnames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypeIds": { "title": "Filtercontacttypeids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "FilterContactTypeNames": { "title": "Filtercontacttypenames", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "IsCrm": { "title": "Iscrm", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsIncludeCompany": { "title": "Isincludecompany", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsIncludeInactive": { "title": "Isincludeinactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsIncludeTrust": { "title": "Isincludetrust", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastError": { "title": "Lasterror", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastErrorTime": { "title": "Lasterrortime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastHealthCheck": { "title": "Lasthealthcheck", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "LastSuccessTime": { "title": "Lastsuccesstime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "VALID" }, "StatusMessage": { "title": "Statusmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TokenVersion": { "title": "Tokenversion", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Domain", "EncryptedAccessToken", "EncryptedRefreshToken" ] }, "ConnectorMetaWebhooks": { "title": "ConnectorMetaWebhooks", "description": "Meta for Webhooks", "type": "object", "properties": { "Url": { "title": "Url", "type": "string" } }, "required": [ "Url" ] }, "ConnectorNoteCreateIn": { "title": "ConnectorNoteCreateIn", "description": "Data to create note in crm connector", "type": "object", "properties": { "CategoryId": { "title": "Categoryid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "Contacts": { "title": "Contacts", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/ConnectorTaskContactLinkCreateIn" } }, { "type": "null" } ] }, "Content": { "title": "Content", "type": "string" }, "NotifyTeamId": { "title": "Notifyteamid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "NotifyUserId": { "title": "Notifyuserid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceConversationUrl": { "title": "Sourceconversationurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Tags": { "title": "Tags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, "required": [ "Content" ] }, "ConnectorTaskContactLinkCreateIn": { "title": "ConnectorTaskContactLinkCreateIn", "description": "Data to create task contact link in crm connector", "type": "object", "properties": { "Name": { "title": "Name", "type": "string" }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "required": [ "Name", "SourceId" ] }, "ConnectorTaskCreateIn": { "title": "ConnectorTaskCreateIn", "description": "Data to create task in crm connector", "type": "object", "properties": { "AssignedToTeam": { "title": "Assignedtoteam", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AssignedToUser": { "title": "Assignedtouser", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BookId": { "title": "Bookid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Category": { "title": "Category", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Description": { "title": "Description", "type": "string" }, "DueTimestamp": { "title": "Duetimestamp", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "type": "string" }, "Priority": { "title": "Priority", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceContactEmail": { "title": "Sourcecontactemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceContactId": { "title": "Sourcecontactid", "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ] }, "SourceContactName": { "title": "Sourcecontactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceConversationUrl": { "title": "Sourceconversationurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceHouseholdId": { "title": "Sourcehouseholdid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskType": { "title": "Tasktype", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Name", "Description" ] }, "ConnectorTypeEnum": { "title": "ConnectorTypeEnum", "description": "Types of connectors", "type": "string", "enum": [ "AGENCYBLOC", "AGENTCORE", "ARCHIVEINTEL", "COMPLY", "CONTIO", "CALENDLY", "EMAIL", "EMAILARCHIVE", "ERADO", "GLOBALRELAY", "GOOGLE", "GOOGLEDRIVE", "GREENBOARD", "RIACOMPTECH", "GREMINDERS", "HADRIUS", "HUBSPOT", "INTRADYN", "MEDICAREPRO", "MESSAGEWATCHER", "MICROSOFTOUTLOOK", "MIRRORWEB", "MOBILE", "MYRIACOMPLIANCE", "PATRINA", "PRESULTS", "PROOFPOINT", "QUIVR", "RADIUSBOB", "REDTAIL", "SALESFORCE", "SLACK", "SLACKARCHIVE", "SLANT", "SMARSH", "SMS", "TEAMS", "WEALTHBOX", "WEALTHBOX_OAUTH", "WEBHOOK", "PRACTIFI", "XLR8", "XYARCHIVE", "ZAPIER" ] }, "ConnectorUserUpdate": { "title": "ConnectorUserUpdate", "description": "Update\n\nProperties to receive on connector update from user land", "type": "object", "properties": { "ConnectorName": { "title": "Connectorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExpectedRefreshToken": { "title": "Expectedrefreshtoken", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ { "$ref": "#/components/schemas/ConnectorMetaAgencyBloc" }, { "$ref": "#/components/schemas/ConnectorMetaAgentCore" }, { "$ref": "#/components/schemas/ConnectorMetaEmail" }, { "$ref": "#/components/schemas/ConnectorMetaMedicarePro" }, { "$ref": "#/components/schemas/ConnectorMetaMobile" }, { "$ref": "#/components/schemas/ConnectorMetaHubspotOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaSlant" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBoxOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaRadiusBob" }, { "$ref": "#/components/schemas/ConnectorMetaRedtail" }, { "$ref": "#/components/schemas/ConnectorMetaSlackOauth" }, { "$ref": "#/components/schemas/ConnectorMetaGoogleDrive" }, { "$ref": "#/components/schemas/ConnectorMetaTeams" }, { "$ref": "#/components/schemas/ConnectorMetaSMS" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBox" }, { "$ref": "#/components/schemas/ConnectorMetaWebhooks" }, { "$ref": "#/components/schemas/ConnectorMetaOAuth" }, {} ] }, "UserNumber": { "title": "Usernumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Meta" ] }, "ConnectorWorkflowCreateIn": { "title": "ConnectorWorkflowCreateIn", "description": "Data to create workflow in crm connector", "type": "object", "properties": { "Contact": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorTaskContactLinkCreateIn" }, { "type": "null" } ] }, "Label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkflowId": { "title": "Workflowid", "type": "string" } }, "required": [ "WorkflowId" ] }, "ConnectorsPaginated": { "title": "ConnectorsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Connector" } } }, "required": [ "records" ] }, "ContioWebhookResponse": { "title": "ContioWebhookResponse", "description": "Contio webhook response model", "type": "object", "properties": { "event_id": { "title": "Event Id", "description": "The Contio event id that was processed", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "received": { "title": "Received", "description": "Whether the webhook event was received", "type": "boolean", "default": true } } }, "CreateUploadVideoLinkIn": { "title": "CreateUploadVideoLinkIn", "description": "CreateUploadVideoLinkIn", "type": "object", "properties": { "filename": { "title": "Filename", "type": "string" } }, "required": [ "filename" ] }, "CrmRedtailCreateOpportunity": { "title": "CrmRedtailCreateOpportunity", "description": "CrmWealthboxCreateOpportunity\n\nhttps://documenter.getpostman.com/view/7873823/SVzxXyzn#fccef1df-d716-4d1a-9433-775eaf0f5661", "type": "object", "properties": { "Description": { "title": "Description", "type": "string" }, "Name": { "title": "Name", "type": "string" }, "OpportunityType": { "title": "Opportunitytype", "type": "string" }, "SourceContactId": { "title": "Sourcecontactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Name", "Description", "OpportunityType" ] }, "CrmSync": { "title": "CrmSync", "description": "CrmSync\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CallNoteCategoryId": { "title": "Callnotecategoryid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallNoteTags": { "title": "Callnotetags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ConnectorId": { "title": "Connectorid", "type": "string" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "CrmSyncId": { "title": "Crmsyncid", "type": "string" }, "IsAllowCreate": { "title": "Isallowcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsAllowCreateContact": { "title": "Isallowcreatecontact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsAllowUpdate": { "title": "Isallowupdate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnabled": { "title": "Isenabled", "type": "boolean" }, "IsEnforcePermissions": { "title": "Isenforcepermissions", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsOnlyMyBook": { "title": "Isonlymybook", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsOnlyNotesForContacts": { "title": "Isonlynotesforcontacts", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncCallRecordings": { "title": "Issynccallrecordings", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncCallTranscripts": { "title": "Issynccalltranscripts", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSyncCalls": { "title": "Issynccalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSyncMessages": { "title": "Issyncmessages", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncSurveySubmissions": { "title": "Issyncsurveysubmissions", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "IsEnabled", "ConnectorId", "UserId", "CrmSyncId", "CreatedAt" ] }, "CrmSyncCreate": { "title": "CrmSyncCreate", "description": "Create\n\nProperties to receive on crmsync creation", "type": "object", "properties": { "CallNoteCategoryId": { "title": "Callnotecategoryid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallNoteTags": { "title": "Callnotetags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ConnectorId": { "title": "Connectorid", "type": "string" }, "IsAllowCreate": { "title": "Isallowcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsAllowCreateContact": { "title": "Isallowcreatecontact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsAllowUpdate": { "title": "Isallowupdate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnabled": { "title": "Isenabled", "type": "boolean" }, "IsEnforcePermissions": { "title": "Isenforcepermissions", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsOnlyMyBook": { "title": "Isonlymybook", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsOnlyNotesForContacts": { "title": "Isonlynotesforcontacts", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncCallRecordings": { "title": "Issynccallrecordings", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncCallTranscripts": { "title": "Issynccalltranscripts", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSyncCalls": { "title": "Issynccalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSyncMessages": { "title": "Issyncmessages", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncSurveySubmissions": { "title": "Issyncsurveysubmissions", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false } }, "required": [ "IsEnabled", "ConnectorId" ] }, "CrmSyncPermissions": { "title": "CrmSyncPermissions", "description": "CrmSync Permissions\n\nModel to return crm sync permissions", "type": "object", "properties": { "Enabled": { "title": "Enabled", "type": "boolean" }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserMeta": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] } }, "required": [ "Enabled" ] }, "CrmSyncUpdate": { "title": "CrmSyncUpdate", "description": "Update\n\nProperties to receive on crmsync update", "type": "object", "properties": { "CallNoteCategoryId": { "title": "Callnotecategoryid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallNoteTags": { "title": "Callnotetags", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "ConnectorId": { "title": "Connectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsAllowCreate": { "title": "Isallowcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsAllowCreateContact": { "title": "Isallowcreatecontact", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsAllowUpdate": { "title": "Isallowupdate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnforcePermissions": { "title": "Isenforcepermissions", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsOnlyMyBook": { "title": "Isonlymybook", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsOnlyNotesForContacts": { "title": "Isonlynotesforcontacts", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncCallRecordings": { "title": "Issynccallrecordings", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncCallTranscripts": { "title": "Issynccalltranscripts", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSyncCalls": { "title": "Issynccalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsSyncMessages": { "title": "Issyncmessages", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsSyncSurveySubmissions": { "title": "Issyncsurveysubmissions", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false } } }, "CrmSyncsPaginated": { "title": "CrmSyncsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/CrmSync" } } }, "required": [ "records" ] }, "CrmWealthboxCreateOpportunity": { "title": "CrmWealthboxCreateOpportunity", "description": "CrmWealthboxCreateOpportunity\n\nhttps://dev.wealthbox.com/#opportunities-collection-post", "type": "object", "properties": { "Description": { "title": "Description", "type": "string" }, "Name": { "title": "Name", "type": "string" }, "SourceContactId": { "title": "Sourcecontactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Stage": { "title": "Stage", "type": "string" } }, "required": [ "Name", "Description", "Stage" ] }, "EmailChangeConfirm": { "title": "EmailChangeConfirm", "description": "Confirm a self-serve email change with the code Cognito emailed", "type": "object", "properties": { "Code": { "title": "Code", "type": "string" } }, "required": [ "Code" ] }, "EmailChangeRequest": { "title": "EmailChangeRequest", "description": "Start a self-serve email change (PRO-4011)", "type": "object", "properties": { "Email": { "title": "Email", "type": "string", "format": "email" } }, "required": [ "Email" ] }, "EmailChangeResult": { "title": "EmailChangeResult", "description": "Outcome of propagating a confirmed email to every system that stores it\n\nCognito is already committed by the time this is produced, so ``Failed``\nbeing non-empty means the copies are stale, NOT that the change was\nrejected. Re-POSTing the sync endpoint retries just the stale ones.", "type": "object", "properties": { "Email": { "title": "Email", "type": "string" }, "Failed": { "title": "Failed", "type": "array", "default": [], "items": { "type": "string" } }, "Synced": { "title": "Synced", "type": "array", "default": [], "items": { "type": "string" } } }, "required": [ "Email" ] }, "EndAdminImpersonationRequest": { "title": "EndAdminImpersonationRequest", "description": "EndAdminImpersonationRequest\n\nRequest body for cc-admin ending a session it started, keyed by target\nWORKSPACE (matching how LoginSession records are partitioned) rather\nthan trusting only the SessionId -- belt-and-suspenders check in the\nendpoint that the session actually belongs to that workspace.", "type": "object", "properties": { "SessionId": { "title": "Sessionid", "type": "string" }, "TargetWorkspaceId": { "title": "Targetworkspaceid", "type": "string" } }, "required": [ "SessionId", "TargetWorkspaceId" ] }, "ExchangeRequest": { "title": "ExchangeRequest", "description": "Exchange Request\n\nA request to finish the auth code exchange", "type": "object", "properties": { "Code": { "title": "Code", "type": "string" }, "State": { "title": "State", "type": "string" } }, "required": [ "Code", "State" ] }, "ExternalDataWealthBox": { "title": "ExternalDataWealthBox", "description": "External data from wealthbox", "type": "object", "properties": { "Groups": { "title": "Groups", "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, { "type": "null" } ] } } }, "ExternalTypeEnum": { "title": "ExternalTypeEnum", "description": "Types for external data", "type": "string", "enum": [ "WEALTHBOX", "SLANT", "AGENCYBLOC", "AGENTCORE", "HUBSPOT", "MEDICAREPRO", "PRACTIFI", "QUIVR", "SALESFORCE", "RADIUSBOB", "REDTAIL", "XLR8" ] }, "FlowerRunRequest": { "title": "FlowerRunRequest", "description": "FlowerRunRequest\n\nRequest body for the admin console \"Run now\" action on the flower\nautomations state machine (PRO-7031). Always scoped to a single user --\nthere is no all-users option here, that's what the daily cron already\ndoes. RunDate is optional; omitted means \"run now\" exactly like the cron\n(no runDate sent to the state machine at all).", "type": "object", "properties": { "RunDate": { "title": "Rundate", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId" ] }, "FlowerRunResponse": { "title": "FlowerRunResponse", "description": "FlowerRunResponse", "type": "object", "properties": { "ExecutionArn": { "title": "Executionarn", "type": "string" } }, "required": [ "ExecutionArn" ] }, "GenerateVideoIn": { "title": "GenerateVideoIn", "description": "Base", "type": "object", "properties": { "Theme": { "title": "Theme", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VideoId": { "title": "Videoid", "type": "string" }, "VideoTitle": { "title": "Videotitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "VideoId" ] }, "Household": { "title": "Household", "description": "Information about Quivr household", "type": "object", "properties": { "Id": { "title": "Id", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "type": "string" } }, "required": [ "Name" ] }, "HubSpotProperty": { "title": "HubSpotProperty", "description": "Meta for HubSpot api property", "type": "object", "properties": { "FieldType": { "title": "Fieldtype", "type": "string" }, "FilterValues": { "title": "Filtervalues", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": [] }, "Label": { "title": "Label", "type": "string" }, "Name": { "title": "Name", "type": "string" } }, "required": [ "FieldType", "Label", "Name" ] }, "HubspotActionContext": { "title": "HubspotActionContext", "description": "Hubspot action context model", "type": "object", "properties": { "actionExecutionIndexIdentifier": { "$ref": "#/components/schemas/ActionExecutionIndexIdentifier" }, "actionId": { "title": "Actionid", "type": "integer" }, "source": { "title": "Source", "type": "string" }, "workflowId": { "title": "Workflowid", "type": "integer" } }, "required": [ "workflowId", "actionId", "actionExecutionIndexIdentifier", "source" ] }, "HubspotActionObject": { "title": "HubspotActionObject", "description": "Hubspot action object model", "type": "object", "properties": { "properties": { "title": "Properties", "type": "object", "additionalProperties": { "type": "string" } }, "objectId": { "title": "Objectid", "type": "integer" }, "objectType": { "title": "Objecttype", "type": "string" }, "propertyValues": { "title": "Propertyvalues", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/PropertyValue" } } }, "required": [ "objectId", "propertyValues", "properties", "objectType" ] }, "HubspotActionOrigin": { "title": "HubspotActionOrigin", "description": "Hubspot action origin model", "type": "object", "properties": { "actionDefinitionId": { "title": "Actiondefinitionid", "type": "integer" }, "actionDefinitionVersion": { "title": "Actiondefinitionversion", "type": "integer" }, "portalId": { "title": "Portalid", "type": "integer" } }, "required": [ "portalId", "actionDefinitionId", "actionDefinitionVersion" ] }, "HubspotActionPayload": { "title": "HubspotActionPayload", "description": "Hubspot action payload model", "type": "object", "properties": { "callbackId": { "title": "Callbackid", "type": "string" }, "context": { "$ref": "#/components/schemas/HubspotActionContext" }, "fields": { "title": "Fields", "type": "object", "additionalProperties": { "type": "string" } }, "inputFields": { "title": "Inputfields", "type": "object", "additionalProperties": { "type": "string" } }, "object": { "$ref": "#/components/schemas/HubspotActionObject" }, "origin": { "$ref": "#/components/schemas/HubspotActionOrigin" } }, "required": [ "callbackId", "origin", "context", "object", "fields", "inputFields" ] }, "HubspotCardMessage": { "title": "HubspotCardMessage", "description": "Whitelisted message shape returned to the CRM card.\n\nKeep this surface narrow on purpose \u2014 this is exposed via the marketplace\napp, so do not pass through internal CC fields wholesale.", "type": "object", "properties": { "body": { "title": "Body", "type": "string" }, "createdTime": { "title": "Createdtime", "type": "integer" }, "direction": { "title": "Direction", "type": "string" }, "fromNumber": { "title": "Fromnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "messageId": { "title": "Messageid", "type": "string" }, "status": { "title": "Status", "type": "string" }, "toNumber": { "title": "Tonumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "messageId", "direction", "status", "body", "createdTime" ] }, "HubspotCardMessagesRequest": { "title": "HubspotCardMessagesRequest", "description": "Request body for /hubspot/cards/messages", "type": "object", "properties": { "hubspotId": { "title": "Hubspotid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "limit": { "title": "Limit", "type": "integer", "default": 20, "maximum": 100.0, "minimum": 1.0 }, "phone": { "title": "Phone", "type": "string" }, "portalId": { "title": "Portalid", "type": "integer" } }, "required": [ "portalId", "phone" ] }, "HubspotCardMessagesResponse": { "title": "HubspotCardMessagesResponse", "description": "Response for /hubspot/cards/messages", "type": "object", "properties": { "messages": { "title": "Messages", "type": "array", "items": { "$ref": "#/components/schemas/HubspotCardMessage" } } } }, "HubspotCardSendSmsRequest": { "title": "HubspotCardSendSmsRequest", "description": "Request body for /hubspot/cards/send-sms", "type": "object", "properties": { "hubspotId": { "title": "Hubspotid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "title": "Message", "type": "string", "maxLength": 1600, "minLength": 1 }, "phone": { "title": "Phone", "type": "string" }, "portalId": { "title": "Portalid", "type": "integer" } }, "required": [ "portalId", "phone", "message" ] }, "HubspotCardSendSmsResponse": { "title": "HubspotCardSendSmsResponse", "description": "Response for /hubspot/cards/send-sms", "type": "object", "properties": { "messageId": { "title": "Messageid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "title": "Status", "type": "string", "default": "sent" } } }, "HubspotSubscriptionType": { "title": "HubspotSubscriptionType", "description": "Hubspot subscription types", "type": "string", "enum": [ "contact.propertyChange", "contact.creation", "contact.deletion" ] }, "HubspotWebhookPayload": { "title": "HubspotWebhookPayload", "description": "Hubspot webhook payload model", "type": "object", "properties": { "appId": { "title": "Appid", "type": "integer" }, "attemptNumber": { "title": "Attemptnumber", "type": "integer" }, "changeSource": { "title": "Changesource", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "eventId": { "title": "Eventid", "type": "integer" }, "objectId": { "title": "Objectid", "type": "integer" }, "occurredAt": { "title": "Occurredat", "type": "integer" }, "portalId": { "title": "Portalid", "type": "integer" }, "propertyName": { "title": "Propertyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "propertyValue": { "title": "Propertyvalue", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "subscriptionId": { "title": "Subscriptionid", "type": "integer" }, "subscriptionType": { "$ref": "#/components/schemas/HubspotSubscriptionType" } }, "required": [ "appId", "eventId", "subscriptionId", "portalId", "occurredAt", "subscriptionType", "attemptNumber", "objectId" ] }, "HubspotWebhookResponse": { "title": "HubspotWebhookResponse", "description": "Hubspot webhook response model", "type": "object", "properties": { "message": { "title": "Message", "description": "Response message", "type": "string", "default": "Webhook processed successfully" }, "success": { "title": "Success", "description": "Whether the webhook was processed successfully", "type": "boolean", "default": true } } }, "ImpersonateRequest": { "title": "ImpersonateRequest", "description": "Request for impersonate", "type": "object", "properties": { "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId" ] }, "IntercomIdentityHash": { "title": "IntercomIdentityHash", "description": "Response for the Intercom Messenger Identity Verification (HMAC) hash\n(PRO-7053).\n\n`UserHash` is an HMAC-SHA256 hex digest of the caller's own identifier,\nmeant to be passed as the `user_hash` field on the web app's Intercom\n`boot`/`update` calls.", "type": "object", "properties": { "UserHash": { "title": "Userhash", "type": "string" } }, "required": [ "UserHash" ] }, "Journey": { "title": "Journey", "description": "Journey\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "A2PRegistrationSubmitted": { "title": "A2Pregistrationsubmitted", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "AccountCreated": { "title": "Accountcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ArchiverConnectorCreated": { "title": "Archiverconnectorcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ArchiverRuleCreated": { "title": "Archiverrulecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "AutomationRuleCreated": { "title": "Automationrulecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "AvatarUploaded": { "title": "Avataruploaded", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "BroadcastHolidaySent": { "title": "Broadcastholidaysent", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "BroadcastIntroSent": { "title": "Broadcastintrosent", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ComplianceMessageUpdated": { "title": "Compliancemessageupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "CrmConnectorCreated": { "title": "Crmconnectorcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmSyncEnabled": { "title": "Crmsyncenabled", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "EmailConnectorCreated": { "title": "Emailconnectorcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "FirstMessageSent": { "title": "Firstmessagesent", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "JourneyId": { "title": "Journeyid", "type": "string" }, "MediaImageCreated": { "title": "Mediaimagecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "OnboardingCompleted": { "title": "Onboardingcompleted", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SetupBusinessHours": { "title": "Setupbusinesshours", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SetupCallFlow": { "title": "Setupcallflow", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SmsTemplateCreated": { "title": "Smstemplatecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SubmitPortRequest": { "title": "Submitportrequest", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SubscriptionCreated": { "title": "Subscriptioncreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TeamInvited": { "title": "Teaminvited", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VideoCreated": { "title": "Videocreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "UserId", "JourneyId", "CreatedTime" ] }, "JourneyKeys": { "title": "JourneyKeys", "description": "Journey options", "type": "string", "enum": [ "AccountCreated", "SubscriptionCreated", "AvatarUploaded", "EmailConnectorCreated", "CrmConnectorCreated", "CrmSyncEnabled", "FirstMessageSent", "SubmitPortRequest", "SetupCallFlow", "SetupBusinessHours", "A2PRegistrationSubmitted", "ComplianceMessageUpdated", "ArchiverConnectorCreated", "ArchiverRuleCreated", "TeamInvited", "MediaImageCreated", "SmsTemplateCreated", "AutomationRuleCreated", "BroadcastIntroSent", "BroadcastHolidaySent", "VideoCreated" ] }, "JourneyListIn": { "title": "JourneyListIn", "description": "Capture list of changed journeys", "type": "object", "properties": { "journeys": { "title": "Journeys", "type": "array", "items": { "$ref": "#/components/schemas/JourneyKeys" } } }, "required": [ "journeys" ] }, "JourneyUpdate": { "title": "JourneyUpdate", "description": "Update\n\nProperties to receive on preferences update", "type": "object", "properties": { "A2PRegistrationSubmitted": { "title": "A2Pregistrationsubmitted", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "AccountCreated": { "title": "Accountcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ArchiverConnectorCreated": { "title": "Archiverconnectorcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ArchiverRuleCreated": { "title": "Archiverrulecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "AutomationRuleCreated": { "title": "Automationrulecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "AvatarUploaded": { "title": "Avataruploaded", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "BroadcastHolidaySent": { "title": "Broadcastholidaysent", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "BroadcastIntroSent": { "title": "Broadcastintrosent", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ComplianceMessageUpdated": { "title": "Compliancemessageupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmConnectorCreated": { "title": "Crmconnectorcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CrmSyncEnabled": { "title": "Crmsyncenabled", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "EmailConnectorCreated": { "title": "Emailconnectorcreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "FirstMessageSent": { "title": "Firstmessagesent", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "MediaImageCreated": { "title": "Mediaimagecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "OnboardingCompleted": { "title": "Onboardingcompleted", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SetupBusinessHours": { "title": "Setupbusinesshours", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SetupCallFlow": { "title": "Setupcallflow", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SmsTemplateCreated": { "title": "Smstemplatecreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SubmitPortRequest": { "title": "Submitportrequest", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SubscriptionCreated": { "title": "Subscriptioncreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TeamInvited": { "title": "Teaminvited", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "VideoCreated": { "title": "Videocreated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } } }, "LoginSession": { "title": "LoginSession", "description": "LoginSession\n\nThe model returned to clients -- no PK/SK", "type": "object", "properties": { "EndedAt": { "title": "Endedat", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "InitiatedByEmail": { "title": "Initiatedbyemail", "type": "string" }, "InitiatedByType": { "title": "Initiatedbytype", "type": "string", "const": "support" }, "IpAddress": { "title": "Ipaddress", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SessionId": { "title": "Sessionid", "type": "string" }, "StartedAt": { "title": "Startedat", "type": "integer" }, "TargetOrganizationId": { "title": "Targetorganizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TargetUserId": { "title": "Targetuserid", "type": "string" }, "TargetWorkspaceId": { "title": "Targetworkspaceid", "type": "string" }, "UserAgent": { "title": "Useragent", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "SessionId", "TargetUserId", "TargetWorkspaceId", "InitiatedByEmail", "InitiatedByType", "StartedAt" ] }, "LoginSessionsPaginated": { "title": "LoginSessionsPaginated", "description": "Pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/LoginSession" } } }, "required": [ "records" ] }, "MakeSendMessage": { "title": "MakeSendMessage", "description": "MakeSendMessage - Input model for Make.com webhook", "type": "object", "properties": { "From": { "title": "From", "type": "string", "pattern": "^\\+\\d{10,15}$" }, "Message": { "title": "Message", "description": "The message text to send", "type": "string" }, "To": { "title": "To", "type": "string", "pattern": "^\\+\\d{10,15}$" } }, "required": [ "Message", "From", "To" ] }, "MakeSendMessageResponse": { "title": "MakeSendMessageResponse", "description": "MakeSendMessageResponse - Response model for Make.com webhook", "type": "object", "properties": { "MessageId": { "title": "Messageid", "description": "The ID of the sent message", "type": "string" }, "Status": { "title": "Status", "description": "Status of the message", "type": "string", "default": "sent" } }, "required": [ "MessageId" ] }, "MedicareProListTypeEnum": { "title": "MedicareProListTypeEnum", "description": "MedicarePr list type", "type": "string", "enum": [ "STATUSES" ] }, "MedicareProProperty": { "title": "MedicareProProperty", "description": "Meta for MedicarePro api property", "type": "object", "properties": { "FieldType": { "title": "Fieldtype", "type": "string" }, "FilterValues": { "title": "Filtervalues", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "default": [] }, "Label": { "title": "Label", "type": "string" }, "Name": { "title": "Name", "type": "string" } }, "required": [ "FieldType", "Label", "Name" ] }, "MedicareProWebhookSendMessage": { "title": "MedicareProWebhookSendMessage", "description": "MedicareProWebhookSendMessage", "type": "object", "properties": { "MessageBody": { "title": "Messagebody", "type": "string" }, "MessageMediaUrls": { "title": "Messagemediaurls", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "SourceAutomationUrl": { "title": "Sourceautomationurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ToNumber": { "title": "Tonumber", "type": "string", "pattern": "^\\+\\d{11}$" } }, "required": [ "MessageBody", "ToNumber" ] }, "MedicareProWebhookSendMessageResponse": { "title": "MedicareProWebhookSendMessageResponse", "description": "MedicareProWebhookSendMessageResponse", "type": "object", "properties": { "Id": { "title": "Id", "type": "string" } }, "required": [ "Id" ] }, "MessageBackfill": { "title": "MessageBackfill", "description": "MessageBackfill\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedBy": { "title": "Createdby", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "FileName": { "title": "Filename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FileUrl": { "title": "Fileurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageBackfillId": { "title": "Messagebackfillid", "type": "string" }, "Notes": { "title": "Notes", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Provider": { "anyOf": [ { "$ref": "#/components/schemas/MessageBackfillProviderEnum" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/MessageBackfillStatusEnum" }, { "type": "null" } ], "default": "PENDING" }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId", "MessageBackfillId", "CreatedTime" ] }, "MessageBackfillCreate": { "title": "MessageBackfillCreate", "description": "Create\n\nProperties to receive on messagebackfill creation", "type": "object", "properties": { "FileName": { "title": "Filename", "type": "string" }, "FileUrl": { "title": "Fileurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Notes": { "title": "Notes", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Provider": { "$ref": "#/components/schemas/MessageBackfillProviderEnum" }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/MessageBackfillStatusEnum" }, { "type": "null" } ], "default": "PENDING" } }, "required": [ "Provider", "FileName" ] }, "MessageBackfillProviderEnum": { "title": "MessageBackfillProviderEnum", "description": "MessageBackfill Provider Enum\n\nSupported providers for message backfill", "type": "string", "enum": [ "ZOOM", "MYREPCHAT", "RINGCENTRAL", "QUO", "GOOGLE", "INTULSE" ] }, "MessageBackfillStatusEnum": { "title": "MessageBackfillStatusEnum", "description": "MessageBackfill Status Enum\n\nStatus tracking for message backfills", "type": "string", "enum": [ "PENDING", "UPLOADED", "PROCESSING", "COMPLETED", "FAILED" ] }, "MessageBackfillUpdate": { "title": "MessageBackfillUpdate", "description": "Update\n\nProperties to receive on messagebackfill update", "type": "object", "properties": { "FileName": { "title": "Filename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FileUrl": { "title": "Fileurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Notes": { "title": "Notes", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Provider": { "anyOf": [ { "$ref": "#/components/schemas/MessageBackfillProviderEnum" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/MessageBackfillStatusEnum" }, { "type": "null" } ], "default": "PENDING" } } }, "MessageBackfillsPaginated": { "title": "MessageBackfillsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/MessageBackfill" } } }, "required": [ "records" ] }, "Milestones": { "title": "Milestones", "description": "Milestones\n\nMilestones provides fields for user milestones", "type": "object", "properties": { "IsCompletedOnboarding": { "title": "Iscompletedonboarding", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false } } }, "MilestonesInDB": { "title": "MilestonesInDB", "description": "Milestones\n\nSome more info not needed on ui", "type": "object", "properties": { "IsCompletedOnboarding": { "title": "Iscompletedonboarding", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false } } }, "NetworkAdminGrant": { "title": "NetworkAdminGrant", "description": "Input to grant network-admin (governor) rights on an existing Cognito user.\n\nSystem/internal only. Mirrors the signup shape: the Cognito user already\nexists (``CreatedUserId``); grant creates the non-billable governor User\nrecord (IsAdmin + NetworkId) and sets ``custom:network`` on the Cognito user.", "type": "object", "properties": { "CreatedUserId": { "title": "Createduserid", "type": "string" }, "Email": { "title": "Email", "type": "string" }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "type": "string" }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "NetworkId", "CreatedUserId", "Email" ] }, "Notification": { "title": "Notification", "description": "Notification\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Body": { "title": "Body", "type": "string" }, "CompletedTime": { "title": "Completedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "string" }, "Link": { "title": "Link", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "NotificationId": { "title": "Notificationid", "type": "string" }, "NotificationType": { "$ref": "#/components/schemas/NotificationTypeEnum" }, "ReadTime": { "title": "Readtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "$ref": "#/components/schemas/NotificationStatusEnum" }, "Title": { "title": "Title", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "NotificationType", "Status", "Title", "Body", "UserId", "NotificationId", "CreatedTime" ] }, "NotificationMarkAllReadResult": { "title": "NotificationMarkAllReadResult", "description": "MarkAllReadResult\n\nResponse for the read-all route", "type": "object", "properties": { "Updated": { "title": "Updated", "type": "integer" } }, "required": [ "Updated" ] }, "NotificationStatusEnum": { "title": "NotificationStatusEnum", "description": "Notification Status Enum\n\nLifecycle of a notification in the inbox", "type": "string", "enum": [ "UNREAD", "READ", "COMPLETED" ] }, "NotificationStatusUpdate": { "title": "NotificationStatusUpdate", "description": "StatusUpdate\n\nBody for the status-transition route. A dedicated model (not\nNotificationUpdate) since this route only ever changes Status.", "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/NotificationStatusEnum" } }, "required": [ "Status" ] }, "NotificationTypeEnum": { "title": "NotificationTypeEnum", "description": "Notification Type Enum\n\nSource event that produced the notification. New types (e.g.\nCONVERSATION_ASSIGNED, COMMENT_MENTION) are one-line additions here.", "type": "string", "enum": [ "MESSAGE_UNDELIVERED", "CRMSYNC_BROKEN" ] }, "NotificationUnreadCount": { "title": "NotificationUnreadCount", "description": "UnreadCount\n\nResponse for the unread-count route", "type": "object", "properties": { "Count": { "title": "Count", "type": "integer" } }, "required": [ "Count" ] }, "NotificationsPaginated": { "title": "NotificationsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Notification" } } }, "required": [ "records" ] }, "NudgeTypeEnum": { "title": "NudgeTypeEnum", "description": "NudgeType\n\nDiscriminator for a suggested nudge. Determines which set of type-specific\nfields apply and is the scope key used when resetting nudges by type.", "type": "string", "enum": [ "task", "conversation" ] }, "OrgA2p": { "title": "OrgA2p", "description": "OrgA2p\n\nThe model to be used for responses. Doesn't include internal PK/SK/GSI\nkeys, and doesn't include OrgA2pInternal fields (Twilio SIDs, Notes,\nIsDuplicated).", "type": "object", "properties": { "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeEmail": { "title": "Authorizedrepresentativeemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeFirstName": { "title": "Authorizedrepresentativefirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeLastName": { "title": "Authorizedrepresentativelastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativePhoneNumber": { "title": "Authorizedrepresentativephonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativePosition": { "title": "Authorizedrepresentativeposition", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeTitle": { "title": "Authorizedrepresentativetitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallerId": { "title": "Callerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedBy": { "title": "Createdby", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsSetupFeeCharged": { "title": "Issetupfeecharged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LegalName": { "title": "Legalname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalType": { "anyOf": [ { "$ref": "#/components/schemas/BusinessTypesEnum" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberType": { "anyOf": [ { "$ref": "#/components/schemas/RegistrationIdTypeEnum" }, { "type": "null" } ], "default": "EIN" }, "OrgA2pId": { "title": "Orga2Pid", "type": "string" }, "OrganizationId": { "title": "Organizationid", "type": "string" }, "PrivacyPolicyUrl": { "title": "Privacypolicyurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SetupFeeChargedTime": { "title": "Setupfeechargedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/OrgA2pStatusEnum" }, { "type": "null" } ], "default": "DRAFT" }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Website": { "title": "Website", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "OrganizationId", "OrgA2pId", "CreatedTime" ] }, "OrgA2pCreate": { "title": "OrgA2pCreate", "description": "Create\n\nProperties to receive on orga2p creation", "type": "object", "properties": { "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeEmail": { "title": "Authorizedrepresentativeemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeFirstName": { "title": "Authorizedrepresentativefirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeLastName": { "title": "Authorizedrepresentativelastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativePhoneNumber": { "title": "Authorizedrepresentativephonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativePosition": { "title": "Authorizedrepresentativeposition", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeTitle": { "title": "Authorizedrepresentativetitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallerId": { "title": "Callerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsSetupFeeCharged": { "title": "Issetupfeecharged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LegalName": { "title": "Legalname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalType": { "anyOf": [ { "$ref": "#/components/schemas/BusinessTypesEnum" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberType": { "anyOf": [ { "$ref": "#/components/schemas/RegistrationIdTypeEnum" }, { "type": "null" } ], "default": "EIN" }, "PrivacyPolicyUrl": { "title": "Privacypolicyurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SetupFeeChargedTime": { "title": "Setupfeechargedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/OrgA2pStatusEnum" }, { "type": "null" } ], "default": "DRAFT" }, "Website": { "title": "Website", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "OrgA2pStatusEnum": { "title": "OrgA2pStatusEnum", "description": "OrgA2p Status Enum\n\nStatus tracking for org a2ps", "type": "string", "enum": [ "DRAFT", "RECEIVED", "APPROVED", "REJECTED", "CORRECTED", "TWILIO_APPROVED", "TWILIO_REJECTED", "CANCELED" ] }, "OrgA2pUpdate": { "title": "OrgA2pUpdate", "description": "Update\n\nProperties to receive on orga2p update", "type": "object", "properties": { "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeEmail": { "title": "Authorizedrepresentativeemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeFirstName": { "title": "Authorizedrepresentativefirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeLastName": { "title": "Authorizedrepresentativelastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativePhoneNumber": { "title": "Authorizedrepresentativephonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativePosition": { "title": "Authorizedrepresentativeposition", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeTitle": { "title": "Authorizedrepresentativetitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CallerId": { "title": "Callerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsSetupFeeCharged": { "title": "Issetupfeecharged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LegalName": { "title": "Legalname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalType": { "anyOf": [ { "$ref": "#/components/schemas/BusinessTypesEnum" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumberType": { "anyOf": [ { "$ref": "#/components/schemas/RegistrationIdTypeEnum" }, { "type": "null" } ], "default": "EIN" }, "PrivacyPolicyUrl": { "title": "Privacypolicyurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SetupFeeChargedTime": { "title": "Setupfeechargedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/OrgA2pStatusEnum" }, { "type": "null" } ], "default": "DRAFT" }, "Website": { "title": "Website", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "OrgA2psPaginated": { "title": "OrgA2psPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/OrgA2p" } } }, "required": [ "records" ] }, "OrgSwitchRequest": { "title": "OrgSwitchRequest", "description": "OrgSwitchRequest\n\nRequest body for switching the CC admin (admin@cc.com) user into the\norganization of the user identified by `Email`.", "type": "object", "properties": { "Email": { "title": "Email", "type": "string" } }, "required": [ "Email" ] }, "Organization": { "title": "Organization", "description": "Organization\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingNotes": { "title": "Billingnotes", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "string" }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "type": "string" }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StripeCustomerId": { "title": "Stripecustomerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionId": { "title": "Subscriptionid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionStatus": { "anyOf": [ { "$ref": "#/components/schemas/StripeSubscriptionStatusEnum" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "OrganizationId", "CreatedTime" ] }, "OrganizationBillingContact": { "title": "OrganizationBillingContact", "description": "OrganizationBillingContact", "type": "object", "properties": { "Email": { "title": "Email", "type": "string" }, "Name": { "title": "Name", "type": "string" }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Name", "Email" ] }, "OrganizationCreate": { "title": "OrganizationCreate", "description": "OrganizationCreate\n\nProperties to receive on organization creation", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingNotes": { "title": "Billingnotes", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StripeCustomerId": { "title": "Stripecustomerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionId": { "title": "Subscriptionid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionStatus": { "anyOf": [ { "$ref": "#/components/schemas/StripeSubscriptionStatusEnum" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "OrganizationSubscription": { "title": "OrganizationSubscription", "description": "OrganizationSubscription", "type": "object", "properties": { "CurrentPeriodEndTime": { "title": "Currentperiodendtime", "type": "string" }, "SubscriptionStatus": { "title": "Subscriptionstatus", "type": "string" } }, "required": [ "SubscriptionStatus", "CurrentPeriodEndTime" ] }, "OrganizationUpdate": { "title": "OrganizationUpdate", "description": "Update\n\nProperties to receive on organization update", "type": "object", "properties": { "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingNotes": { "title": "Billingnotes", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StripeCustomerId": { "title": "Stripecustomerid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionId": { "title": "Subscriptionid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SubscriptionStatus": { "anyOf": [ { "$ref": "#/components/schemas/StripeSubscriptionStatusEnum" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "OrganizationUser": { "title": "OrganizationUser", "description": "OrganizationUser\n\nSimplified view of the users in an org", "type": "object", "properties": { "Email": { "title": "Email", "type": "string" }, "ImageUrl": { "title": "Imageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAdmin": { "title": "Isadmin", "type": "boolean" }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Name": { "title": "Name", "type": "string" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Name", "Email", "UserId", "IsAdmin" ] }, "OrganizationsPaginated": { "title": "OrganizationsPaginated", "description": "Pagination for organizations", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } }, "required": [ "records" ] }, "PhoneNumber": { "title": "PhoneNumber", "type": "object", "properties": { "InboxExists": { "title": "Inboxexists", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPortable": { "title": "Isportable", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "NotPortableReason": { "title": "Notportablereason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Pin": { "title": "Pin", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PinAndAccountNumberRequired": { "title": "Pinandaccountnumberrequired", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "ScheduledTime": { "title": "Scheduledtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/PhoneNumberStatusEnum" }, { "type": "null" } ] }, "Type": { "title": "Type", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "PhoneNumberStatusEnum": { "title": "PhoneNumberStatusEnum", "description": "PhoneNumber Status Enum\n\nStatus tracking for phone numbers in port ins", "type": "string", "enum": [ "WAITING_FOR_SIGNATURE", "WAITING_FOR_LOSING_CARRIER", "SCHEDULED", "PORTED", "DONE", "CANCELED", "CARRIER_REJECTED", "CARRIER_CANCELED", "UNKNOWN" ] }, "PortIn": { "title": "PortIn", "description": "PortIn\n\nThe model to be used for responses. Doesn't include internal PK/SK/GSI\nkeys, and doesn't include PortInInternal fields (Twilio SIDs, Notes,\nTargetDate, IsDuplicated, DuplicatedFrom).", "type": "object", "properties": { "AccountName": { "title": "Accountname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AccountNumber": { "title": "Accountnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AccountPhoneNumber": { "title": "Accountphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeEmail": { "title": "Authorizedrepresentativeemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeName": { "title": "Authorizedrepresentativename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingStatementFileName": { "title": "Billingstatementfilename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingStatementUrl": { "title": "Billingstatementurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Carrier": { "anyOf": [ { "$ref": "#/components/schemas/PortInCarrierEnum" }, { "type": "null" } ] }, "CarrierOther": { "title": "Carrierother", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedBy": { "title": "Createdby", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "IsBusiness": { "title": "Isbusiness", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsManual": { "title": "Ismanual", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTwilioToTwilio": { "title": "Istwiliototwilio", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumbers": { "title": "Phonenumbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, { "type": "null" } ] }, "PortInId": { "title": "Portinid", "type": "string" }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ScheduledTime": { "title": "Scheduledtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/PortInStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "UserId", "PortInId", "CreatedTime" ] }, "PortInCarrierEnum": { "title": "PortInCarrierEnum", "description": "PortIn Carrier Enum", "type": "string", "enum": [ "_8x8", "AT_AND_T", "COMCAST", "DIALPAD", "EVERFAST", "GOOGLE_VOICE_BUSINESS", "GOOGLE_VOICE_PERSONAL", "GOTO", "INTULSE", "INTERMEDIA", "KEAP", "MICROSOFT_TEAMS", "MYREPCHAT", "NEXTIVA", "NUMBERBARN", "OOMA", "QUO", "RINGCENTRAL", "SIMPLII", "TMOBILE", "TELEMESSAGE", "VERIZON", "VONAGE", "ZOOM", "OTHER" ] }, "PortInCreate": { "title": "PortInCreate", "description": "Create\n\nProperties to receive on portin creation", "type": "object", "properties": { "AccountName": { "title": "Accountname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AccountNumber": { "title": "Accountnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AccountPhoneNumber": { "title": "Accountphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeEmail": { "title": "Authorizedrepresentativeemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeName": { "title": "Authorizedrepresentativename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingStatementFileName": { "title": "Billingstatementfilename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingStatementUrl": { "title": "Billingstatementurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Carrier": { "anyOf": [ { "$ref": "#/components/schemas/PortInCarrierEnum" }, { "type": "null" } ] }, "CarrierOther": { "title": "Carrierother", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsBusiness": { "title": "Isbusiness", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsManual": { "title": "Ismanual", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTwilioToTwilio": { "title": "Istwiliototwilio", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumbers": { "title": "Phonenumbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ScheduledTime": { "title": "Scheduledtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/PortInStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "PortInStatusEnum": { "title": "PortInStatusEnum", "description": "PortIn Status Enum\n\nStatus tracking for port ins", "type": "string", "enum": [ "RECEIVED", "APPROVED", "REJECTED", "CORRECTED", "WAITING_FOR_SIGNATURE", "WAITING_FOR_LOSING_CARRIER", "SCHEDULED", "PORTED", "DONE", "CANCELED", "CARRIER_REJECTED", "CARRIER_CANCELED", "UNKNOWN" ] }, "PortInUpdate": { "title": "PortInUpdate", "description": "Update\n\nProperties to receive on portin update", "type": "object", "properties": { "AccountName": { "title": "Accountname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AccountNumber": { "title": "Accountnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AccountPhoneNumber": { "title": "Accountphonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeEmail": { "title": "Authorizedrepresentativeemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AuthorizedRepresentativeName": { "title": "Authorizedrepresentativename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingStatementFileName": { "title": "Billingstatementfilename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BillingStatementUrl": { "title": "Billingstatementurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Carrier": { "anyOf": [ { "$ref": "#/components/schemas/PortInCarrierEnum" }, { "type": "null" } ] }, "CarrierOther": { "title": "Carrierother", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsBusiness": { "title": "Isbusiness", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsManual": { "title": "Ismanual", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTwilioToTwilio": { "title": "Istwiliototwilio", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumbers": { "title": "Phonenumbers", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" } }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ScheduledTime": { "title": "Scheduledtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/PortInStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "PortInsPaginated": { "title": "PortInsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/PortIn" } } }, "required": [ "records" ] }, "PortOut": { "title": "PortOut", "description": "PortOut\n\nThe model to be used for responses. Doesn't include internal PK/SK/GSI\nkeys, and doesn't include PortOutInternal fields (Notes).", "type": "object", "properties": { "CreatedBy": { "title": "Createdby", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Pin": { "title": "Pin", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PortOutId": { "title": "Portoutid", "type": "string" }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/PortOutStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId", "PortOutId", "CreatedTime" ] }, "PortOutCreate": { "title": "PortOutCreate", "description": "Create\n\nProperties to receive on portout creation", "type": "object", "properties": { "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Pin": { "title": "Pin", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/PortOutStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" } } }, "PortOutStatusEnum": { "title": "PortOutStatusEnum", "description": "PortOut Status Enum\n\nStatus tracking for port outs", "type": "string", "enum": [ "RECEIVED", "APPROVED", "REJECTED", "WAITING_FOR_GAINING_CARRIER", "SCHEDULED", "DONE", "CANCELED" ] }, "PortOutsPaginated": { "title": "PortOutsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/PortOut" } } }, "required": [ "records" ] }, "Preferences": { "title": "Preferences", "description": "Preferences\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedTime": { "title": "Createdtime", "type": "integer" }, "InboxOrder": { "title": "Inboxorder", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "IsEnableDoNotDisturb": { "title": "Isenabledonotdisturb", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableHotkeys": { "title": "Isenablehotkeys", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableInAppCalling": { "title": "Isenableinappcalling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableSoundOnCompleted": { "title": "Isenablesoundoncompleted", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableSoundOnDialer": { "title": "Isenablesoundondialer", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableSoundOnReceive": { "title": "Isenablesoundonreceive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableSoundOnSend": { "title": "Isenablesoundonsend", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPromptCallNote": { "title": "Ispromptcallnote", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSendOnEnter": { "title": "Issendonenter", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsUseCarrierCalls": { "title": "Isusecarriercalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "PreferencesId": { "title": "Preferencesid", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId", "PreferencesId", "CreatedTime" ] }, "PreferencesUpdate": { "title": "PreferencesUpdate", "description": "Update\n\nProperties to receive on preferences update", "type": "object", "properties": { "InboxOrder": { "title": "Inboxorder", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "IsEnableDoNotDisturb": { "title": "Isenabledonotdisturb", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableHotkeys": { "title": "Isenablehotkeys", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableInAppCalling": { "title": "Isenableinappcalling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsEnableSoundOnCompleted": { "title": "Isenablesoundoncompleted", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableSoundOnDialer": { "title": "Isenablesoundondialer", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableSoundOnReceive": { "title": "Isenablesoundonreceive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsEnableSoundOnSend": { "title": "Isenablesoundonsend", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPromptCallNote": { "title": "Ispromptcallnote", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSendOnEnter": { "title": "Issendonenter", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsUseCarrierCalls": { "title": "Isusecarriercalls", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } } }, "PresignUrlPost": { "title": "PresignUrlPost", "description": "CreateUploadVideoLinkOut", "type": "object", "properties": { "post_fields": { "title": "Post Fields", "type": "object", "additionalProperties": true }, "post_headers": { "title": "Post Headers", "type": "object", "additionalProperties": true }, "post_url": { "title": "Post Url", "type": "string" } }, "required": [ "post_url", "post_fields", "post_headers" ] }, "PrivacyPolicy": { "title": "PrivacyPolicy", "description": "PrivacyPolicy\n\nThe model to be used for responses.", "type": "object", "properties": { "FileName": { "title": "Filename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Url": { "title": "Url", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ProductData": { "title": "ProductData", "description": "Registration Product\n\nRepresents the registration product in the billing config", "type": "object", "properties": { "PriceId": { "title": "Priceid", "type": "string" }, "ProductId": { "title": "Productid", "type": "string" }, "StripeCheckoutLineItems": { "title": "Stripecheckoutlineitems", "anyOf": [ { "type": "array", "items": { "type": "object", "additionalProperties": true } }, { "type": "null" } ] } }, "required": [ "ProductId", "PriceId" ] }, "Prompt": { "title": "Prompt", "description": "PromptBase\n\nPrompt input for openai text completion", "type": "object", "properties": { "Temperature": { "title": "Temperature", "anyOf": [ { "type": "number" }, { "type": "integer" }, { "type": "string" }, { "type": "null" } ] }, "TextIn": { "title": "Textin", "type": "string" } }, "required": [ "TextIn" ] }, "PromptContactDetails": { "title": "PromptContactDetails", "description": "PromptContactDetails\n\nPrompt contact details", "type": "object", "properties": { "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "PropertyValue": { "title": "PropertyValue", "description": "Hubspot property value model", "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "requestId": { "title": "Requestid", "type": "string" }, "source": { "title": "Source", "type": "string" }, "sourceId": { "title": "Sourceid", "type": "string" }, "sourceUpstreamDeployable": { "title": "Sourceupstreamdeployable", "type": "string" }, "sourceVid": { "title": "Sourcevid", "type": "array", "items": {} }, "timestamp": { "title": "Timestamp", "type": "integer" }, "updatedByUserId": { "title": "Updatedbyuserid", "type": "integer" }, "useTimestampAsPersistenceTimestamp": { "title": "Usetimestampaspersistencetimestamp", "type": "boolean" }, "value": { "title": "Value", "type": "string" } }, "required": [ "name", "value", "timestamp", "sourceId", "source", "sourceVid", "requestId", "updatedByUserId", "useTimestampAsPersistenceTimestamp", "sourceUpstreamDeployable" ] }, "PublicTeamMemberInvite": { "title": "PublicTeamMemberInvite", "description": "Response for public invite", "type": "object", "properties": { "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "type": "string" }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "InviterEmail": { "title": "Inviteremail", "type": "string" }, "InviterName": { "title": "Invitername", "type": "string" }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationName": { "title": "Organizationname", "type": "string" }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Email", "OrganizationName", "InviterName", "InviterEmail" ] }, "PublicTeamMemberJoinInvite": { "title": "PublicTeamMemberJoinInvite", "description": "Data to confirm join", "type": "object", "properties": { "Email": { "title": "Email", "type": "string" }, "FirstName": { "title": "Firstname", "type": "string" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "type": "string" } }, "required": [ "TeamMemberId", "Email", "FirstName", "LastName" ] }, "PublicTeamMemberJoinInviteResponse": { "title": "PublicTeamMemberJoinInviteResponse", "description": "Data response to confirm join", "type": "object", "properties": { "Email": { "title": "Email", "type": "string" }, "FirstName": { "title": "Firstname", "type": "string" }, "LastName": { "title": "Lastname", "type": "string" }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "type": "string" }, "TempPassword": { "title": "Temppassword", "type": "string" } }, "required": [ "TeamMemberId", "Email", "FirstName", "LastName", "TempPassword" ] }, "PublicVideo": { "title": "PublicVideo", "description": "VideoBase\n\nProvides user videos", "type": "object", "properties": { "BrowserFaviconUrl": { "title": "Browserfaviconurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrowserPageTitle": { "title": "Browserpagetitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorEmail": { "title": "Displayauthoremail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorName": { "title": "Displayauthorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorPhone": { "title": "Displayauthorphone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorTitle": { "title": "Displayauthortitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorUrl": { "title": "Displayauthorurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandActionLink": { "title": "Displaybrandactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandSize": { "title": "Displaybrandsize", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandUrl": { "title": "Displaybrandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayDescription": { "title": "Displaydescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayFooterLegal": { "title": "Displayfooterlegal", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "Powered by CurrentClient. All rights reserved." }, "DisplayPrimaryActionLink": { "title": "Displayprimaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayPrimaryActionText": { "title": "Displayprimaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionLink": { "title": "Displaysecondaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionText": { "title": "Displaysecondaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayTitle": { "title": "Displaytitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "EmbedUrl": { "title": "Embedurl", "type": "string" }, "IsDisplayPrimaryAction": { "title": "Isdisplayprimaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDisplaySecondaryAction": { "title": "Isdisplaysecondaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsHostedS3": { "title": "Ishosteds3", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPublic": { "title": "Ispublic", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LinkTagOEmbedJsonUrl": { "title": "Linktagoembedjsonurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LinkTagOEmbedXmlUrl": { "title": "Linktagoembedxmlurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MetaDescription": { "title": "Metadescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MetaTitle": { "title": "Metatitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleActionBannerBg": { "title": "Styleactionbannerbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleLegalFontColor": { "title": "Stylelegalfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionBg": { "title": "Styleprimaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionColor": { "title": "Styleprimaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryBgColor": { "title": "Styleprimarybgcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryFontColor": { "title": "Styleprimaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionBg": { "title": "Stylesecondaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionColor": { "title": "Stylesecondaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryFontColor": { "title": "Stylesecondaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ThumbnailUrl": { "title": "Thumbnailurl", "type": "string" }, "VideoId": { "title": "Videoid", "type": "string" } }, "required": [ "VideoId", "EmbedUrl", "ThumbnailUrl" ] }, "PublicVideoViewCreate": { "title": "PublicVideoViewCreate", "description": "Create\n\nProperties to receive on videoview creation", "type": "object", "properties": { "AnonymousId": { "title": "Anonymousid", "type": "string" }, "IsClickedPrimaryAction": { "title": "Isclickedprimaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsClickedSecondaryAction": { "title": "Isclickedsecondaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "VideoId": { "title": "Videoid", "type": "string" }, "VideoTitle": { "title": "Videotitle", "type": "string" } }, "required": [ "VideoId", "AnonymousId", "VideoTitle" ] }, "PublicVoice": { "title": "PublicVoice", "description": "VoiceBase\n\nProvides user voice", "type": "object", "properties": { "AudioUrl": { "title": "Audiourl", "type": "string" }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "DisplayAuthorEmail": { "title": "Displayauthoremail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorName": { "title": "Displayauthorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorPhone": { "title": "Displayauthorphone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorTitle": { "title": "Displayauthortitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorUrl": { "title": "Displayauthorurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandActionLink": { "title": "Displaybrandactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandSize": { "title": "Displaybrandsize", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandUrl": { "title": "Displaybrandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayFooterLegal": { "title": "Displayfooterlegal", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "Powered by CurrentClient. All rights reserved." }, "StyleActionBannerBg": { "title": "Styleactionbannerbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleLegalFontColor": { "title": "Stylelegalfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionBg": { "title": "Styleprimaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryActionColor": { "title": "Styleprimaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryBgColor": { "title": "Styleprimarybgcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StylePrimaryFontColor": { "title": "Styleprimaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionBg": { "title": "Stylesecondaryactionbg", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryActionColor": { "title": "Stylesecondaryactioncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StyleSecondaryFontColor": { "title": "Stylesecondaryfontcolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ThumbnailUrl": { "title": "Thumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionStatus": { "title": "Transcriptionstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "Transcriptiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VoiceId": { "title": "Voiceid", "type": "string" } }, "required": [ "VoiceId", "AudioUrl", "CreatedTime" ] }, "RadiusBobListTypeEnum": { "title": "RadiusBobListTypeEnum", "description": "RadiusBob list type", "type": "string", "enum": [ "STATES" ] }, "RegisteredNumber": { "title": "RegisteredNumber", "description": "RegisteredNumber", "type": "object", "properties": { "AddressRequirements": { "title": "Addressrequirements", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Capabilities": { "anyOf": [ { "$ref": "#/components/schemas/RegisteredNumberCapabilities" }, { "type": "null" } ] }, "DateCreated": { "title": "Datecreated", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DateUpdated": { "title": "Dateupdated", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FriendlyName": { "title": "Friendlyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Origin": { "title": "Origin", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "type": "string" }, "Sid": { "title": "Sid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsFallbackMethod": { "title": "Smsfallbackmethod", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsFallbackUrl": { "title": "Smsfallbackurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsMethod": { "title": "Smsmethod", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsUrl": { "title": "Smsurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusCallback": { "title": "Statuscallback", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "StatusCallbackMethod": { "title": "Statuscallbackmethod", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "PhoneNumber" ] }, "RegisteredNumberCapabilities": { "title": "RegisteredNumberCapabilities", "description": "RegisteredNumberCapabilities", "type": "object", "properties": { "IsMMSEnabled": { "title": "Ismmsenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsSMSEnabled": { "title": "Issmsenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsVoiceEnabled": { "title": "Isvoiceenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } } }, "RegisteredNumberUpdate": { "title": "RegisteredNumberUpdate", "description": "RegisteredNumberUpdate", "type": "object", "properties": { "PhoneNumber": { "title": "Phonenumber", "type": "string" }, "PhoneSid": { "title": "Phonesid", "type": "string" } }, "required": [ "PhoneNumber", "PhoneSid" ] }, "RegistrationIdTypeEnum": { "title": "RegistrationIdTypeEnum", "description": "Registration Id Type Enum\nType of id using to regsiter", "type": "string", "enum": [ "EIN", "DUNS" ] }, "RollCall": { "title": "RollCall", "description": "RollCall\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedTime": { "title": "Createdtime", "type": "integer" }, "Online": { "title": "Online", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "RollCallId": { "title": "Rollcallid", "type": "string" }, "Status": { "title": "Status", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "ViewingConversation": { "title": "Viewingconversation", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] } }, "required": [ "UserId", "RollCallId", "CreatedTime" ] }, "RollCallUpdate": { "title": "RollCallUpdate", "description": "Update\n\nProperties to receive on preferences update", "type": "object", "properties": { "Online": { "title": "Online", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Status": { "title": "Status", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "ViewingConversation": { "title": "Viewingconversation", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] } } }, "RollCallViewingUpdate": { "title": "RollCallViewingUpdate", "description": "RollCallViewingUpdate\n\nProperties to receive on viewing conversation", "type": "object", "properties": { "ConversationId": { "title": "Conversationid", "type": "string" }, "IsTyping": { "title": "Istyping", "type": "boolean", "default": false } }, "required": [ "ConversationId" ] }, "RoutingErrorSuppressionCheck": { "title": "RoutingErrorSuppressionCheck", "description": "Request body: claim-or-suppress a realtime routing error email.", "type": "object", "properties": { "ConnectorId": { "title": "Connectorid", "type": "string" }, "ErrorSignature": { "title": "Errorsignature", "type": "string" }, "TtlSeconds": { "title": "Ttlseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "ConnectorId", "ErrorSignature" ] }, "RoutingErrorSuppressionResult": { "title": "RoutingErrorSuppressionResult", "description": "Whether this failure should send an email, plus the suppressed count.", "type": "object", "properties": { "ShouldSend": { "title": "Shouldsend", "type": "boolean" }, "SuppressedCount": { "title": "Suppressedcount", "type": "integer", "default": 0 } }, "required": [ "ShouldSend" ] }, "RoutingEventNamesEnum": { "title": "RoutingEventNamesEnum", "description": "Routing event names\n\nThis enum is copied in the module-routing", "type": "string", "enum": [ "MESSAGE_INCOMING", "MESSAGE_UPDATED", "CALL_MISSED", "NEW_SUBMISSION", "CONTACT_VERSIONED", "CONTACT_UPDATED", "CONTACT_CREATED", "SMS_SENT", "SMS_LOG", "CALL_LOG", "CALL_UPDATED", "VOICEMAIL_RECEIVED", "CALL_RECORDING_COMPLETED", "VIDEO_UPLOADED", "SMS_UNDELIVERED", "CALL_TRANSCRIPT_COMPLETED", "TETHER_WIDGET_SUBMISSION", "CALL_AI_SUMMARY_COMPLETED", "CRMSYNC_BROKEN", "NEW_LEAD", "MESSAGE_ALL" ] }, "RoutingFrequencyEnum": { "title": "RoutingFrequencyEnum", "description": "Routing frequency names\n\nThis enum is copied in the module-routing", "type": "string", "enum": [ "STREAM", "DAILY", "HOURLY", "WEEKLY" ] }, "RoutingRule": { "title": "RoutingRule", "description": "RoutingRule\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "ConnectorId": { "title": "Connectorid", "type": "string" }, "ConnectorMeta": { "title": "Connectormeta", "anyOf": [ { "$ref": "#/components/schemas/ConnectorMetaAgencyBloc" }, { "$ref": "#/components/schemas/ConnectorMetaAgentCore" }, { "$ref": "#/components/schemas/ConnectorMetaEmail" }, { "$ref": "#/components/schemas/ConnectorMetaMedicarePro" }, { "$ref": "#/components/schemas/ConnectorMetaMobile" }, { "$ref": "#/components/schemas/ConnectorMetaHubspotOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaSlant" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBoxOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaRadiusBob" }, { "$ref": "#/components/schemas/ConnectorMetaRedtail" }, { "$ref": "#/components/schemas/ConnectorMetaSlackOauth" }, { "$ref": "#/components/schemas/ConnectorMetaGoogleDrive" }, { "$ref": "#/components/schemas/ConnectorMetaTeams" }, { "$ref": "#/components/schemas/ConnectorMetaSMS" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBox" }, { "$ref": "#/components/schemas/ConnectorMetaWebhooks" }, { "$ref": "#/components/schemas/ConnectorMetaOAuth" }, {} ] }, "ConnectorName": { "title": "Connectorname", "type": "string" }, "ConnectorSecureParamName": { "title": "Connectorsecureparamname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorType": { "$ref": "#/components/schemas/ConnectorTypeEnum" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "CrmSyncMeta": { "title": "Crmsyncmeta", "anyOf": [ {}, { "type": "null" } ] }, "EventName": { "$ref": "#/components/schemas/RoutingEventNamesEnum" }, "Frequency": { "$ref": "#/components/schemas/RoutingFrequencyEnum" }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsFirm": { "title": "Isfirm", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsMobileManaged": { "title": "Ismobilemanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "RoutingRuleId": { "title": "Routingruleid", "type": "string" }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "UserNumber": { "title": "Usernumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "EventName", "Frequency", "ConnectorId", "ConnectorName", "ConnectorType", "ConnectorMeta", "UserId", "RoutingRuleId", "CreatedAt" ] }, "RoutingRuleCreate": { "title": "RoutingRuleCreate", "description": "Create\n\nProperties to receive on routingrule creation", "type": "object", "properties": { "ConnectorId": { "title": "Connectorid", "type": "string" }, "ConnectorMeta": { "title": "Connectormeta", "anyOf": [ { "$ref": "#/components/schemas/ConnectorMetaAgencyBloc" }, { "$ref": "#/components/schemas/ConnectorMetaAgentCore" }, { "$ref": "#/components/schemas/ConnectorMetaEmail" }, { "$ref": "#/components/schemas/ConnectorMetaMedicarePro" }, { "$ref": "#/components/schemas/ConnectorMetaMobile" }, { "$ref": "#/components/schemas/ConnectorMetaHubspotOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaSlant" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBoxOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaRadiusBob" }, { "$ref": "#/components/schemas/ConnectorMetaRedtail" }, { "$ref": "#/components/schemas/ConnectorMetaSlackOauth" }, { "$ref": "#/components/schemas/ConnectorMetaGoogleDrive" }, { "$ref": "#/components/schemas/ConnectorMetaTeams" }, { "$ref": "#/components/schemas/ConnectorMetaSMS" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBox" }, { "$ref": "#/components/schemas/ConnectorMetaWebhooks" }, { "$ref": "#/components/schemas/ConnectorMetaOAuth" }, {} ] }, "ConnectorName": { "title": "Connectorname", "type": "string" }, "ConnectorSecureParamName": { "title": "Connectorsecureparamname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorType": { "$ref": "#/components/schemas/ConnectorTypeEnum" }, "CrmSyncMeta": { "title": "Crmsyncmeta", "anyOf": [ {}, { "type": "null" } ] }, "EventName": { "$ref": "#/components/schemas/RoutingEventNamesEnum" }, "Frequency": { "$ref": "#/components/schemas/RoutingFrequencyEnum" }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsFirm": { "title": "Isfirm", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsMobileManaged": { "title": "Ismobilemanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserNumber": { "title": "Usernumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "EventName", "Frequency", "ConnectorId", "ConnectorName", "ConnectorType", "ConnectorMeta" ] }, "RoutingRuleUpdate": { "title": "RoutingRuleUpdate", "description": "Update\n\nProperties to receive on routingrule update", "type": "object", "properties": { "ConnectorId": { "title": "Connectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorMeta": { "title": "Connectormeta", "anyOf": [ { "$ref": "#/components/schemas/ConnectorMetaAgencyBloc" }, { "$ref": "#/components/schemas/ConnectorMetaAgentCore" }, { "$ref": "#/components/schemas/ConnectorMetaEmail" }, { "$ref": "#/components/schemas/ConnectorMetaMedicarePro" }, { "$ref": "#/components/schemas/ConnectorMetaMobile" }, { "$ref": "#/components/schemas/ConnectorMetaHubspotOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaSlant" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBoxOAuth" }, { "$ref": "#/components/schemas/ConnectorMetaRadiusBob" }, { "$ref": "#/components/schemas/ConnectorMetaRedtail" }, { "$ref": "#/components/schemas/ConnectorMetaSlackOauth" }, { "$ref": "#/components/schemas/ConnectorMetaGoogleDrive" }, { "$ref": "#/components/schemas/ConnectorMetaTeams" }, { "$ref": "#/components/schemas/ConnectorMetaSMS" }, { "$ref": "#/components/schemas/ConnectorMetaWealthBox" }, { "$ref": "#/components/schemas/ConnectorMetaWebhooks" }, { "$ref": "#/components/schemas/ConnectorMetaOAuth" }, {}, { "type": "null" } ] }, "ConnectorName": { "title": "Connectorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorSecureParamName": { "title": "Connectorsecureparamname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorType": { "anyOf": [ { "$ref": "#/components/schemas/ConnectorTypeEnum" }, { "type": "null" } ] }, "CrmSyncMeta": { "title": "Crmsyncmeta", "anyOf": [ {}, { "type": "null" } ] }, "EventName": { "anyOf": [ { "$ref": "#/components/schemas/RoutingEventNamesEnum" }, { "type": "null" } ] }, "Frequency": { "anyOf": [ { "$ref": "#/components/schemas/RoutingFrequencyEnum" }, { "type": "null" } ] }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": true }, "IsFirm": { "title": "Isfirm", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsMobileManaged": { "title": "Ismobilemanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "RoutingRuleId": { "title": "Routingruleid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserNumber": { "title": "Usernumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "RoutingRulesPaginated": { "title": "RoutingRulesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/RoutingRule" } } }, "required": [ "records" ] }, "Sequence": { "title": "Sequence", "description": "Sequence\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ScheduledCount": { "title": "Scheduledcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SentCount": { "title": "Sentcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SequenceId": { "title": "Sequenceid", "type": "string" }, "SequenceItems": { "title": "Sequenceitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SequenceItem" } }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Title", "UserId", "SequenceId", "CreatedAt" ] }, "SequenceChannelTypeEnum": { "title": "SequenceChannelTypeEnum", "description": "Channel types", "type": "string", "enum": [ "SMS", "EMAIL" ] }, "SequenceCreate": { "title": "SequenceCreate", "description": "Create\n\nProperties to receive on automationrule creation", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ScheduledCount": { "title": "Scheduledcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SentCount": { "title": "Sentcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SequenceItems": { "title": "Sequenceitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SequenceItem" } }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" } }, "required": [ "Title" ] }, "SequenceItem": { "title": "SequenceItem", "description": "SequenceItem", "type": "object", "properties": { "ChannelType": { "$ref": "#/components/schemas/SequenceChannelTypeEnum" }, "ItemId": { "title": "Itemid", "type": "string" }, "MessageBody": { "title": "Messagebody", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageMediaItems": { "title": "Messagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "SendAtTime": { "title": "Sendattime", "type": "string" }, "SendDateDegree": { "title": "Senddatedegree", "type": "integer" } }, "required": [ "ItemId", "SendDateDegree", "SendAtTime", "ChannelType" ] }, "SequenceUpdate": { "title": "SequenceUpdate", "description": "Update\n\nProperties to receive on automationrule update", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ScheduledCount": { "title": "Scheduledcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SentCount": { "title": "Sentcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SequenceItems": { "title": "Sequenceitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SequenceItem" } }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "SequencesPaginated": { "title": "SequencesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Sequence" } } }, "required": [ "records" ] }, "SetupIntentResponse": { "title": "SetupIntentResponse", "description": "Response containing the client secret for a Stripe SetupIntent", "type": "object", "properties": { "ClientSecret": { "title": "Clientsecret", "type": "string" } }, "required": [ "ClientSecret" ] }, "ShortUrl": { "title": "ShortUrl", "description": "ShortUrl\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "ClickCount": { "title": "Clickcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "type": "string" }, "Domain": { "title": "Domain", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumDaysUntilExpire": { "title": "Numdaysuntilexpire", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ShortId": { "title": "Shortid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrlId": { "title": "Shorturlid", "type": "string" }, "TargetUrl": { "title": "Targeturl", "type": "string" }, "UniqueCount": { "title": "Uniquecount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "TargetUrl", "UserId", "ShortUrlId", "CreatedAt" ] }, "ShortUrlClickDay": { "title": "ShortUrlClickDay", "description": "Click count for a single calendar day.", "type": "object", "properties": { "Count": { "title": "Count", "type": "integer", "default": 0 }, "Date": { "title": "Date", "type": "string" } }, "required": [ "Date" ] }, "ShortUrlClickEvent": { "title": "ShortUrlClickEvent", "description": "A single click event (response model).", "type": "object", "properties": { "Country": { "title": "Country", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsUnique": { "title": "Isunique", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Referrer": { "title": "Referrer", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortId": { "title": "Shortid", "type": "string" }, "Timestamp": { "title": "Timestamp", "type": "string" }, "UserAgent": { "title": "Useragent", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ShortId", "Timestamp" ] }, "ShortUrlClickSeries": { "title": "ShortUrlClickSeries", "description": "Daily click timeseries + headline stats for a short url.", "type": "object", "properties": { "Days": { "title": "Days", "type": "integer" }, "LastClickedAt": { "title": "Lastclickedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PreviousTotal": { "title": "Previoustotal", "type": "integer", "default": 0 }, "Total": { "title": "Total", "type": "integer", "default": 0 }, "TrendPercent": { "title": "Trendpercent", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/ShortUrlClickDay" } } }, "required": [ "records", "Days" ] }, "ShortUrlClicksPaginated": { "title": "ShortUrlClicksPaginated", "description": "Paginated click events.", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/ShortUrlClickEvent" } } }, "required": [ "records" ] }, "ShortUrlCreate": { "title": "ShortUrlCreate", "description": "Create\n\nProperties to receive on shorturl creation", "type": "object", "properties": { "Domain": { "title": "Domain", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumDaysUntilExpire": { "title": "Numdaysuntilexpire", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ShortId": { "title": "Shortid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TargetUrl": { "title": "Targeturl", "type": "string" } }, "required": [ "TargetUrl" ] }, "ShortUrlUpdate": { "title": "ShortUrlUpdate", "description": "Update\n\nProperties to receive on shorturl update", "type": "object", "properties": { "Domain": { "title": "Domain", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NumDaysUntilExpire": { "title": "Numdaysuntilexpire", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ShortId": { "title": "Shortid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TargetUrl": { "title": "Targeturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ShortUrlsPaginated": { "title": "ShortUrlsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/ShortUrl" } } }, "required": [ "records" ] }, "SlantContactTypeEnum": { "title": "SlantContactTypeEnum", "description": "Slant contact creation type \u2014 drives which Slant entity wraps the person", "type": "string", "enum": [ "Prospect", "Client", "Contact" ] }, "SlugAvailability": { "title": "SlugAvailability", "description": "Response for slug availability check", "type": "object", "properties": { "available": { "title": "Available", "type": "boolean" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "slug", "available" ] }, "SmsHosting": { "title": "SmsHosting", "description": "SmsHosting\n\nThe model to be used for responses. Doesn't include internal PK/SK/GSI\nkeys, and doesn't include SmsHostingInternal fields (Twilio order SID,\nNotes, eligibility-check results).", "type": "object", "properties": { "Carrier": { "anyOf": [ { "$ref": "#/components/schemas/PortInCarrierEnum" }, { "type": "null" } ] }, "CarrierOther": { "title": "Carrierother", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedBy": { "title": "Createdby", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "IsTwilioToTwilio": { "title": "Istwiliototwilio", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumberType": { "title": "Phonenumbertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsHostingId": { "title": "Smshostingid", "type": "string" }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/SmsHostingStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId", "SmsHostingId", "CreatedTime" ] }, "SmsHostingCreate": { "title": "SmsHostingCreate", "description": "Create\n\nProperties to receive on smshosting creation", "type": "object", "properties": { "Carrier": { "anyOf": [ { "$ref": "#/components/schemas/PortInCarrierEnum" }, { "type": "null" } ] }, "CarrierOther": { "title": "Carrierother", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsTwilioToTwilio": { "title": "Istwiliototwilio", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumberType": { "title": "Phonenumbertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/SmsHostingStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" } } }, "SmsHostingStatusEnum": { "title": "SmsHostingStatusEnum", "description": "SmsHosting Status Enum\n\nStatus tracking for SMS hostings", "type": "string", "enum": [ "RECEIVED", "APPROVED", "REJECTED", "CORRECTED", "DONE", "CANCELED" ] }, "SmsHostingUpdate": { "title": "SmsHostingUpdate", "description": "Update\n\nProperties to receive on smshosting update", "type": "object", "properties": { "Carrier": { "anyOf": [ { "$ref": "#/components/schemas/PortInCarrierEnum" }, { "type": "null" } ] }, "CarrierOther": { "title": "Carrierother", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsTwilioToTwilio": { "title": "Istwiliototwilio", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumber": { "title": "Phonenumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PhoneNumberType": { "title": "Phonenumbertype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RejectionReason": { "title": "Rejectionreason", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "anyOf": [ { "$ref": "#/components/schemas/SmsHostingStatusEnum" }, { "type": "null" } ], "default": "RECEIVED" } } }, "SmsHostingsPaginated": { "title": "SmsHostingsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/SmsHosting" } } }, "required": [ "records" ] }, "SmsTemplate": { "title": "SmsTemplate", "description": "SmsTemplate\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "CreatedByUserBrandImageUrl": { "title": "Createdbyuserbrandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedByUserId": { "title": "Createdbyuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedByUserName": { "title": "Createdbyusername", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Message": { "title": "Message", "type": "string" }, "MessageMediaItems": { "title": "Messagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SmsTemplateId": { "title": "Smstemplateid", "type": "string" }, "Title": { "title": "Title", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Title", "Message", "UserId", "SmsTemplateId", "CreatedAt" ] }, "SmsTemplateCreate": { "title": "SmsTemplateCreate", "description": "Create\n\nProperties to receive on smstemplate creation", "type": "object", "properties": { "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Message": { "title": "Message", "type": "string" }, "MessageMediaItems": { "title": "Messagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" } }, "required": [ "Title", "Message" ] }, "SmsTemplateUpdate": { "title": "SmsTemplateUpdate", "description": "Update\n\nProperties to receive on smstemplate update", "type": "object", "properties": { "IsManaged": { "title": "Ismanaged", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Message": { "title": "Message", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageMediaItems": { "title": "Messagemediaitems", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/MessageMediaItem" } }, { "type": "null" } ] }, "MessageMeta": { "title": "Messagemeta", "anyOf": [ { "type": "object", "additionalProperties": true }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "SmsTemplatesPaginated": { "title": "SmsTemplatesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/SmsTemplate" } } }, "required": [ "records" ] }, "SocialLink": { "title": "SocialLink", "description": "Social media link", "type": "object", "properties": { "Label": { "title": "Label", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Platform": { "$ref": "#/components/schemas/SocialPlatformEnum" }, "Url": { "title": "Url", "type": "string" } }, "required": [ "Platform", "Url" ] }, "SocialPlatformEnum": { "title": "SocialPlatformEnum", "description": "Supported social media platforms", "type": "string", "enum": [ "FACEBOOK", "TWITTER", "INSTAGRAM", "LINKEDIN", "YOUTUBE", "TIKTOK", "GITHUB", "OTHER" ] }, "StripeSubscriptionStatusEnum": { "title": "StripeSubscriptionStatusEnum", "description": "StripeSubscriptionStatusEnum\n\nStatus of the stripe subscription\nDocs: https://stripe.com/docs/api/subscriptions/object#subscription_object-status", "type": "string", "enum": [ "active", "past_due", "unpaid", "canceled", "incomplete", "incomplete_expired", "trialing" ] }, "SubscriptionCreateResponse": { "title": "SubscriptionCreateResponse", "description": "Response from creating a subscription", "type": "object", "properties": { "ClientSecret": { "title": "Clientsecret", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Status": { "title": "Status", "type": "string" }, "SubscriptionId": { "title": "Subscriptionid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Status" ] }, "SubscriptionCreateSchema": { "title": "SubscriptionCreateSchema", "description": "Request body for creating a subscription with a payment method", "type": "object", "properties": { "PaymentMethodId": { "title": "Paymentmethodid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PriceIds": { "title": "Priceids", "type": "array", "items": { "type": "string" } }, "PromotionCode": { "title": "Promotioncode", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Quantity": { "title": "Quantity", "type": "integer", "default": 1 } }, "required": [ "PriceIds" ] }, "SuggestedNudge": { "title": "SuggestedNudge", "description": "SuggestedNudge\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "ActedOnTime": { "title": "Actedontime", "description": "When the advisor opened the chat from the nudge, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ContactId": { "title": "Contactid", "description": "Unique identifier of the associated contact", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "description": "Display name of the associated contact", "type": "string" }, "ContactNumber": { "title": "Contactnumber", "description": "Phone number of the associated contact (e.g. +1\u2026)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationId": { "title": "Conversationid", "description": "Unique identifier of the conversation", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "type": "string" }, "FollowupType": { "title": "Followuptype", "description": "Follow-up type: awaiting_our_reply, awaiting_their_reply, or check_in", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdId": { "title": "Householdid", "description": "Unique identifier of the associated household", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "description": "Display name of the associated household", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsDismissed": { "title": "Isdismissed", "description": "Whether the nudge has been dismissed by the user", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTaskPastDue": { "title": "Istaskpastdue", "description": "Whether the task is past its due date", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsUnread": { "title": "Isunread", "description": "Whether the conversation has unread messages", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastMessageDirection": { "title": "Lastmessagedirection", "description": "Direction of the last message: \"SENT\" or \"RECEIVED\"", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastMessagePreview": { "title": "Lastmessagepreview", "description": "Preview of the last message (\u2264160 chars)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageSentTime": { "title": "Messagesenttime", "description": "When the advisor sent a message from the nudge, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "NudgeType": { "description": "Discriminator: \"task\" or \"conversation\"", "$ref": "#/components/schemas/NudgeTypeEnum" }, "OpenedTime": { "title": "Openedtime", "description": "When the advisor first opened the nudge detail, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "QuietDays": { "title": "Quietdays", "description": "Number of days since the last message", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Reason": { "title": "Reason", "description": "Why this nudge is being suggested", "type": "string" }, "Score": { "title": "Score", "description": "Urgency score, higher = more urgent. Sortable numeric", "type": "integer" }, "SuggestedNudgeId": { "title": "Suggestednudgeid", "type": "string" }, "TaskCategory": { "title": "Taskcategory", "description": "Category or type of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDescription": { "title": "Taskdescription", "description": "Description or details of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDueDate": { "title": "Taskduedate", "description": "Task due date as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TaskId": { "title": "Taskid", "description": "Unique identifier of the CRM task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskLinkUrl": { "title": "Tasklinkurl", "description": "URL link to the task in the source system", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskName": { "title": "Taskname", "description": "Display name of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskPriority": { "title": "Taskpriority", "description": "Priority level (high, normal, medium, low)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskSourceType": { "title": "Tasksourcetype", "description": "Source CRM system type (e.g. WEALTHBOX, REDTAIL, HUBSPOT)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "examples": [ { "ContactId": "contact-456", "ContactName": "Jane Smith", "ContactNumber": "+15551234567", "HouseholdId": "household-789", "HouseholdName": "Smith Family", "IsTaskPastDue": false, "NudgeType": "task", "Reason": "Policy renewal is due in 3 days and no recent contact", "Score": 80, "TaskCategory": "Follow-Up", "TaskDescription": "Review the policy details and contact client", "TaskDueDate": 1740000000, "TaskId": "task-abc-123", "TaskLinkUrl": "https://crm.example.com/tasks/abc-123", "TaskName": "Follow up on policy renewal", "TaskPriority": "high", "TaskSourceType": "WEALTHBOX" }, { "ContactId": "c-456", "ContactName": "John Smith", "ContactNumber": "+14155559999", "ConversationId": "1555...TO1555...", "FollowupType": "awaiting_our_reply", "IsUnread": true, "LastMessageDirection": "RECEIVED", "LastMessagePreview": "did that paperwork go through?", "NudgeType": "conversation", "QuietDays": 9, "Reason": "Asked about rollover, never answered", "Score": 75 } ], "required": [ "NudgeType", "Score", "ContactName", "Reason", "UserId", "SuggestedNudgeId", "CreatedAt" ] }, "SuggestedNudgeCreate": { "title": "SuggestedNudgeCreate", "description": "Create\n\nProperties to receive on suggestednudge creation. Validation is per\nNudgeType: a task nudge needs task fields, a conversation nudge needs\nconversation fields, and the opposite type's fields are treated as absent.", "type": "object", "properties": { "ActedOnTime": { "title": "Actedontime", "description": "When the advisor opened the chat from the nudge, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ContactId": { "title": "Contactid", "description": "Unique identifier of the associated contact", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "description": "Display name of the associated contact", "type": "string" }, "ContactNumber": { "title": "Contactnumber", "description": "Phone number of the associated contact (e.g. +1\u2026)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationId": { "title": "Conversationid", "description": "Unique identifier of the conversation", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FollowupType": { "title": "Followuptype", "description": "Follow-up type: awaiting_our_reply, awaiting_their_reply, or check_in", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdId": { "title": "Householdid", "description": "Unique identifier of the associated household", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "description": "Display name of the associated household", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsDismissed": { "title": "Isdismissed", "description": "Whether the nudge has been dismissed by the user", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTaskPastDue": { "title": "Istaskpastdue", "description": "Whether the task is past its due date", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsUnread": { "title": "Isunread", "description": "Whether the conversation has unread messages", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastMessageDirection": { "title": "Lastmessagedirection", "description": "Direction of the last message: \"SENT\" or \"RECEIVED\"", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastMessagePreview": { "title": "Lastmessagepreview", "description": "Preview of the last message (\u2264160 chars)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageSentTime": { "title": "Messagesenttime", "description": "When the advisor sent a message from the nudge, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "NudgeType": { "description": "Discriminator: \"task\" or \"conversation\"", "$ref": "#/components/schemas/NudgeTypeEnum" }, "OpenedTime": { "title": "Openedtime", "description": "When the advisor first opened the nudge detail, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "QuietDays": { "title": "Quietdays", "description": "Number of days since the last message", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Reason": { "title": "Reason", "description": "Why this nudge is being suggested", "type": "string" }, "Score": { "title": "Score", "description": "Urgency score, higher = more urgent. Sortable numeric", "type": "integer" }, "TaskCategory": { "title": "Taskcategory", "description": "Category or type of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDescription": { "title": "Taskdescription", "description": "Description or details of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDueDate": { "title": "Taskduedate", "description": "Task due date as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TaskId": { "title": "Taskid", "description": "Unique identifier of the CRM task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskLinkUrl": { "title": "Tasklinkurl", "description": "URL link to the task in the source system", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskName": { "title": "Taskname", "description": "Display name of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskPriority": { "title": "Taskpriority", "description": "Priority level (high, normal, medium, low)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskSourceType": { "title": "Tasksourcetype", "description": "Source CRM system type (e.g. WEALTHBOX, REDTAIL, HUBSPOT)", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "examples": [ { "ContactId": "contact-456", "ContactName": "Jane Smith", "ContactNumber": "+15551234567", "HouseholdId": "household-789", "HouseholdName": "Smith Family", "IsTaskPastDue": false, "NudgeType": "task", "Reason": "Policy renewal is due in 3 days and no recent contact", "Score": 80, "TaskCategory": "Follow-Up", "TaskDescription": "Review the policy details and contact client", "TaskDueDate": 1740000000, "TaskId": "task-abc-123", "TaskLinkUrl": "https://crm.example.com/tasks/abc-123", "TaskName": "Follow up on policy renewal", "TaskPriority": "high", "TaskSourceType": "WEALTHBOX" }, { "ContactId": "c-456", "ContactName": "John Smith", "ContactNumber": "+14155559999", "ConversationId": "1555...TO1555...", "FollowupType": "awaiting_our_reply", "IsUnread": true, "LastMessageDirection": "RECEIVED", "LastMessagePreview": "did that paperwork go through?", "NudgeType": "conversation", "QuietDays": 9, "Reason": "Asked about rollover, never answered", "Score": 75 } ], "required": [ "NudgeType", "Score", "ContactName", "Reason" ] }, "SuggestedNudgeUpdate": { "title": "SuggestedNudgeUpdate", "description": "Update\n\nProperties to receive on suggestednudge update", "type": "object", "properties": { "ActedOnTime": { "title": "Actedontime", "description": "When the advisor opened the chat from the nudge, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ContactId": { "title": "Contactid", "description": "Unique identifier of the associated contact", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "description": "Display name of the associated contact", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactNumber": { "title": "Contactnumber", "description": "Phone number of the associated contact (e.g. +1\u2026)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConversationId": { "title": "Conversationid", "description": "Unique identifier of the conversation", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FollowupType": { "title": "Followuptype", "description": "Follow-up type: awaiting_our_reply, awaiting_their_reply, or check_in", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdId": { "title": "Householdid", "description": "Unique identifier of the associated household", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HouseholdName": { "title": "Householdname", "description": "Display name of the associated household", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsDismissed": { "title": "Isdismissed", "description": "Whether the nudge has been dismissed by the user", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTaskPastDue": { "title": "Istaskpastdue", "description": "Whether the task is past its due date", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsUnread": { "title": "Isunread", "description": "Whether the conversation has unread messages", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastMessageDirection": { "title": "Lastmessagedirection", "description": "Direction of the last message: \"SENT\" or \"RECEIVED\"", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastMessagePreview": { "title": "Lastmessagepreview", "description": "Preview of the last message (\u2264160 chars)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessageSentTime": { "title": "Messagesenttime", "description": "When the advisor sent a message from the nudge, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "NudgeType": { "description": "Discriminator: \"task\" or \"conversation\"", "anyOf": [ { "$ref": "#/components/schemas/NudgeTypeEnum" }, { "type": "null" } ] }, "OpenedTime": { "title": "Openedtime", "description": "When the advisor first opened the nudge detail, as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "QuietDays": { "title": "Quietdays", "description": "Number of days since the last message", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Reason": { "title": "Reason", "description": "Why this nudge is being suggested", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Score": { "title": "Score", "description": "Urgency score, higher = more urgent. Sortable numeric", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TaskCategory": { "title": "Taskcategory", "description": "Category or type of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDescription": { "title": "Taskdescription", "description": "Description or details of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskDueDate": { "title": "Taskduedate", "description": "Task due date as a unix timestamp (epoch seconds)", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "TaskId": { "title": "Taskid", "description": "Unique identifier of the CRM task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskLinkUrl": { "title": "Tasklinkurl", "description": "URL link to the task in the source system", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskName": { "title": "Taskname", "description": "Display name of the task", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskPriority": { "title": "Taskpriority", "description": "Priority level (high, normal, medium, low)", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TaskSourceType": { "title": "Tasksourcetype", "description": "Source CRM system type (e.g. WEALTHBOX, REDTAIL, HUBSPOT)", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "SuggestedNudgesPaginated": { "title": "SuggestedNudgesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/SuggestedNudge" } } }, "required": [ "records" ] }, "SwitchWorkspaceRequest": { "title": "SwitchWorkspaceRequest", "description": "Request to switch workspace", "type": "object", "properties": { "WorkspaceId": { "title": "Workspaceid", "type": "string" } }, "required": [ "WorkspaceId" ] }, "TeamMember": { "title": "TeamMember", "description": "TeamMember\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CognitoUserId": { "title": "Cognitouserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "type": "string" }, "Email": { "title": "Email", "type": "string" }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsInvited": { "title": "Isinvited", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsJoined": { "title": "Isjoined", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMember": { "title": "Ismember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsXypnMember": { "title": "Isxypnmember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Email", "UserId", "TeamMemberId", "CreatedAt" ] }, "TeamMemberCreate": { "title": "TeamMemberCreate", "description": "Create\n\nProperties to receive on teammember creation", "type": "object", "properties": { "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CognitoUserId": { "title": "Cognitouserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "type": "string" }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsInvited": { "title": "Isinvited", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsJoined": { "title": "Isjoined", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMember": { "title": "Ismember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsXypnMember": { "title": "Isxypnmember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Email" ] }, "TeamMemberExtra": { "title": "TeamMemberExtra", "description": "TeamMemberExtra\n\nTeam member for response with extra fields", "type": "object", "properties": { "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CognitoUserId": { "title": "Cognitouserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "type": "string" }, "Email": { "title": "Email", "type": "string" }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAdmin": { "title": "Isadmin", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsInvited": { "title": "Isinvited", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsJoined": { "title": "Isjoined", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMember": { "title": "Ismember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsXypnMember": { "title": "Isxypnmember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberId": { "title": "Teammemberid", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Email", "UserId", "TeamMemberId", "CreatedAt" ] }, "TeamMemberUpdate": { "title": "TeamMemberUpdate", "description": "Update\n\nProperties to receive on teammember update", "type": "object", "properties": { "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CognitoUserId": { "title": "Cognitouserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsInvited": { "title": "Isinvited", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsJoined": { "title": "Isjoined", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMember": { "title": "Ismember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsXypnMember": { "title": "Isxypnmember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "TeamMembersPaginated": { "title": "TeamMembersPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/TeamMemberExtra" } } }, "required": [ "records" ] }, "TeamsNotificationProvisionIn": { "title": "TeamsNotificationProvisionIn", "description": "Request body for provisioning Teams notifications for the current user.", "type": "object", "properties": { "aadObjectId": { "title": "Aadobjectid", "type": "string" }, "tenantId": { "title": "Tenantid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "aadObjectId" ] }, "TeamsNotificationSettingsIn": { "title": "TeamsNotificationSettingsIn", "description": "Request body for updating Teams notification settings.\n\n``IsEnabled`` is the master on/off (applies to every event). ``Events`` is a\npartial per-event map ({event_name: bool}); omitted events are left as-is.\nBoth fields are optional so callers can update either independently.", "type": "object", "properties": { "Events": { "title": "Events", "anyOf": [ { "type": "object", "additionalProperties": { "type": "boolean" }, "propertyNames": { "$ref": "#/components/schemas/RoutingEventNamesEnum" } }, { "type": "null" } ] }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } } }, "TeamsNotificationState": { "title": "TeamsNotificationState", "description": "Current Teams notification state for a user.\n\nReturned by the read, provision, and settings endpoints so the frontend\nalways works against a single consistent shape.", "type": "object", "properties": { "AadObjectId": { "title": "Aadobjectid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ConnectorId": { "title": "Connectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Events": { "title": "Events", "type": "object", "additionalProperties": { "type": "boolean" }, "propertyNames": { "$ref": "#/components/schemas/RoutingEventNamesEnum" } }, "IsEnabled": { "title": "Isenabled", "type": "boolean" }, "IsProvisioned": { "title": "Isprovisioned", "type": "boolean" }, "IsStale": { "title": "Isstale", "type": "boolean" }, "TenantId": { "title": "Tenantid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "IsProvisioned", "IsEnabled", "IsStale", "Events" ] }, "TetherLink": { "title": "TetherLink", "description": "TetherLink\n\nThe model to be used for responses. Doesn't include internal PK and SK", "type": "object", "properties": { "BookingClickCount": { "title": "Bookingclickcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "BookingUrl": { "title": "Bookingurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandLogoSize": { "title": "Brandlogosize", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "BrandLogoUrl": { "title": "Brandlogourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Components": { "title": "Components", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TetherLinkComponent" } }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HitCount": { "title": "Hitcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProfileImageUrl": { "title": "Profileimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SaveContactClickCount": { "title": "Savecontactclickcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ShortUrlDomain": { "title": "Shorturldomain", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrlId": { "title": "Shorturlid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Slug": { "title": "Slug", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SocialLinks": { "title": "Sociallinks", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SocialLink" } }, { "type": "null" } ] }, "TetherLinkId": { "title": "Tetherlinkid", "type": "string" }, "Theme": { "title": "Theme", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ThemeColor": { "title": "Themecolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VcfUrl": { "title": "Vcfurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "UserId", "TetherLinkId", "CreatedTime" ] }, "TetherLinkButtonEnum": { "title": "TetherLinkButtonEnum", "description": "Trackable buttons on the public TetherLink page.\n\nValues are the wire format sent by the public page's click beacon; each\nmaps to its own lifetime counter field on the record.", "type": "string", "enum": [ "book", "save-contact" ] }, "TetherLinkComponent": { "title": "TetherLinkComponent", "description": "Content component for TetherLink page", "type": "object", "properties": { "ButtonActionType": { "anyOf": [ { "$ref": "#/components/schemas/ButtonActionTypeEnum" }, { "type": "null" } ] }, "ButtonLabel": { "title": "Buttonlabel", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ButtonStyle": { "title": "Buttonstyle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ButtonUrl": { "title": "Buttonurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ComponentId": { "title": "Componentid", "type": "string" }, "LinkLabel": { "title": "Linklabel", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LinkUrl": { "title": "Linkurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MarkdownContent": { "title": "Markdowncontent", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Order": { "title": "Order", "type": "integer", "default": 0 }, "Type": { "$ref": "#/components/schemas/ComponentTypeEnum" }, "VideoTitle": { "title": "Videotitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VideoUrl": { "title": "Videourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "ComponentId", "Type" ] }, "TetherLinkCreate": { "title": "TetherLinkCreate", "description": "Create\n\nProperties to receive on TetherLink creation", "type": "object", "properties": { "BookingUrl": { "title": "Bookingurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandLogoSize": { "title": "Brandlogosize", "anyOf": [ { "type": "integer", "maximum": 200.0, "minimum": 16.0 }, { "type": "null" } ] }, "BrandLogoUrl": { "title": "Brandlogourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "Components": { "title": "Components", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TetherLinkComponent" } }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "type": "string", "maxLength": 100, "minLength": 1 }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProfileImageUrl": { "title": "Profileimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Slug": { "title": "Slug", "type": "string", "maxLength": 100, "minLength": 1 }, "SocialLinks": { "title": "Sociallinks", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SocialLink" } }, { "type": "null" } ] }, "Theme": { "title": "Theme", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ThemeColor": { "title": "Themecolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "VcfUrl": { "title": "Vcfurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Name", "Slug" ] }, "TetherLinkPublic": { "title": "TetherLinkPublic", "description": "TetherLinkPublic\n\nPublic-facing model for published TetherLinks", "type": "object", "properties": { "BookingUrl": { "title": "Bookingurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandLogoSize": { "title": "Brandlogosize", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "BrandLogoUrl": { "title": "Brandlogourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Components": { "title": "Components", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TetherLinkComponent" } }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisclosureText": { "title": "Disclosuretext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "HitCount": { "title": "Hitcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProfileImageUrl": { "title": "Profileimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Slug": { "title": "Slug", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SocialLinks": { "title": "Sociallinks", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SocialLink" } }, { "type": "null" } ] }, "TetherLinkId": { "title": "Tetherlinkid", "type": "string" }, "Theme": { "title": "Theme", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ThemeColor": { "title": "Themecolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VcfUrl": { "title": "Vcfurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "TetherLinkId" ] }, "TetherLinkUpdate": { "title": "TetherLinkUpdate", "description": "Update\n\nProperties to receive on TetherLink update", "type": "object", "properties": { "BookingUrl": { "title": "Bookingurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandLogoSize": { "title": "Brandlogosize", "anyOf": [ { "type": "integer", "maximum": 200.0, "minimum": 16.0 }, { "type": "null" } ] }, "BrandLogoUrl": { "title": "Brandlogourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "Components": { "title": "Components", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/TetherLinkComponent" } }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string", "maxLength": 1000 }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Name": { "title": "Name", "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ProfileImageUrl": { "title": "Profileimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Slug": { "title": "Slug", "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ] }, "SocialLinks": { "title": "Sociallinks", "anyOf": [ { "type": "array", "items": { "$ref": "#/components/schemas/SocialLink" } }, { "type": "null" } ] }, "Theme": { "title": "Theme", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ThemeColor": { "title": "Themecolor", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ] }, "VcfUrl": { "title": "Vcfurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "TetherLinksPaginated": { "title": "TetherLinksPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/TetherLink" } } }, "required": [ "records" ] }, "TetherSubmissionRecord": { "title": "TetherSubmissionRecord", "description": "TetherSubmissionRecord\n\nThe model to be used for responses. Doesn't include internal PK and SK", "type": "object", "properties": { "CreatedTime": { "title": "Createdtime", "type": "integer" }, "InboxNumber": { "title": "Inboxnumber", "type": "string" }, "Message": { "title": "Message", "type": "string" }, "Name": { "title": "Name", "type": "string" }, "Phone": { "title": "Phone", "type": "string" }, "SourceDomain": { "title": "Sourcedomain", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TetherSubmissionId": { "title": "Tethersubmissionid", "type": "string" }, "TetherWidgetId": { "title": "Tetherwidgetid", "type": "string" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Name", "Phone", "Message", "InboxNumber", "TetherWidgetId", "UserId", "TetherSubmissionId", "CreatedTime" ] }, "TetherSubmissionsPaginated": { "title": "TetherSubmissionsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/TetherSubmissionRecord" } } }, "required": [ "records" ] }, "TetherWidget": { "title": "TetherWidget", "description": "TetherWidget\n\nThe model to be used for responses. Doesn't include internal PK and SK", "type": "object", "properties": { "AllowedDomains": { "title": "Alloweddomains", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "ButtonColor": { "title": "Buttoncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "DisclosureText": { "title": "Disclosuretext", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "GreetingMessage": { "title": "Greetingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "HeaderText": { "title": "Headertext", "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "default": "Talk to us" }, "InboxNumber": { "title": "Inboxnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "PrivacyPolicyUrl": { "title": "Privacypolicyurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "ReplyMessage": { "title": "Replymessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "TetherWidgetId": { "title": "Tetherwidgetid", "type": "string" }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "UserId", "TetherWidgetId", "CreatedTime" ] }, "TetherWidgetPublic": { "title": "TetherWidgetPublic", "description": "TetherWidgetPublic\n\nPublic-facing model that excludes sensitive fields", "type": "object", "properties": { "ButtonColor": { "title": "Buttoncolor", "type": "string" }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "DisclosureText": { "title": "Disclosuretext", "type": "string" }, "GreetingMessage": { "title": "Greetingmessage", "type": "string" }, "HeaderText": { "title": "Headertext", "type": "string", "default": "Talk to us" }, "IsEnabled": { "title": "Isenabled", "type": "boolean" }, "PrivacyPolicyUrl": { "title": "Privacypolicyurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "TetherWidgetId": { "title": "Tetherwidgetid", "type": "string" } }, "required": [ "TetherWidgetId", "IsEnabled", "ButtonColor", "GreetingMessage", "DisclosureText" ] }, "TetherWidgetSubmission": { "title": "TetherWidgetSubmission", "description": "TetherWidgetSubmission\n\nForm submission from the widget", "type": "object", "properties": { "IdempotencyKey": { "title": "Idempotencykey", "anyOf": [ { "type": "string", "maxLength": 64 }, { "type": "null" } ] }, "Message": { "title": "Message", "type": "string", "maxLength": 500, "minLength": 1 }, "Name": { "title": "Name", "type": "string", "maxLength": 100 }, "Phone": { "title": "Phone", "type": "string", "pattern": "^\\+1\\d{10}$" } }, "required": [ "Phone", "Message" ] }, "TetherWidgetSubmissionResponse": { "title": "TetherWidgetSubmissionResponse", "description": "TetherWidgetSubmissionResponse\n\nResponse after form submission", "type": "object", "properties": { "message": { "title": "Message", "type": "string" }, "success": { "title": "Success", "type": "boolean" } }, "required": [ "success", "message" ] }, "TetherWidgetUpdate": { "title": "TetherWidgetUpdate", "description": "Update\n\nProperties to receive on tether widget update", "type": "object", "properties": { "AllowedDomains": { "title": "Alloweddomains", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "ButtonColor": { "title": "Buttoncolor", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "DisclosureText": { "title": "Disclosuretext", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "EmailsTo": { "title": "Emailsto", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "GreetingMessage": { "title": "Greetingmessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "HeaderText": { "title": "Headertext", "anyOf": [ { "type": "string", "maxLength": 16 }, { "type": "null" } ], "default": "Talk to us" }, "InboxNumber": { "title": "Inboxnumber", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsEnabled": { "title": "Isenabled", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "PrivacyPolicyUrl": { "title": "Privacypolicyurl", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" }, "ReplyMessage": { "title": "Replymessage", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "" } } }, "UpdateMilestones": { "title": "UpdateMilestones", "description": "UpdateMilestones\n\nUpdate the milestones details", "type": "object", "properties": { "IsCompletedOnboarding": { "title": "Iscompletedonboarding", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false } } }, "UsageAllowance": { "title": "UsageAllowance", "description": "UsageAllowance\n\nThe included allowance for one usage-based add-on before overage\napplies, read live from its Stripe graduated-pricing \"usage\" price\n(PRO-7284) -- never hardcoded, since a wrong denominator on a\nbilling page is worse than none. ``IncludedAmount`` is None when\nthe price can't be resolved; callers must treat that as \"no\nallowance available\", not as zero.", "type": "object", "properties": { "IncludedAmount": { "title": "Includedamount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "UsageUnit": { "title": "Usageunit", "type": "string" } }, "required": [ "UsageUnit" ] }, "UsageAllowances": { "title": "UsageAllowances", "description": "UsageAllowances\n\nIncluded per-seat/per-workspace/credit allowances for each\nusage-based add-on (PRO-7284), so a client can build a real usage\npercent bar instead of guessing a denominator.", "type": "object", "properties": { "AiCallSummaries": { "$ref": "#/components/schemas/UsageAllowance" }, "AiVoiceAgent": { "$ref": "#/components/schemas/UsageAllowance" }, "OutreachEngine": { "$ref": "#/components/schemas/UsageAllowance" } }, "required": [ "AiCallSummaries", "AiVoiceAgent", "OutreachEngine" ] }, "UsageRecord": { "title": "UsageRecord", "description": "UsageRecord\n\nStripes usage record object\nhttps://stripe.com/docs/api/usage_records", "type": "object", "properties": { "Action": { "title": "Action", "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "increment" }, "Quantity": { "title": "Quantity", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "SubscriptionItemId": { "title": "Subscriptionitemid", "type": "string" }, "Timestamp": { "title": "Timestamp", "type": "integer" } }, "required": [ "SubscriptionItemId", "Timestamp" ] }, "User": { "title": "User", "description": "User\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CognitoUserId": { "title": "Cognitouserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "string" }, "Email": { "title": "Email", "type": "string" }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAdmin": { "title": "Isadmin", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsInvited": { "title": "Isinvited", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsJoined": { "title": "Isjoined", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsMember": { "title": "Ismember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedTime": { "title": "Updatedtime", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Email", "UserId", "CreatedTime" ] }, "UserAudio": { "title": "UserAudio", "description": "UserAudio\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DurationSeconds": { "title": "Durationseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "MediaUrl": { "title": "Mediaurl", "type": "string" }, "Title": { "title": "Title", "type": "string" }, "UserAudioId": { "title": "Useraudioid", "type": "string" }, "UserId": { "title": "Userid", "type": "string" } }, "required": [ "Title", "MediaUrl", "UserId", "UserAudioId", "CreatedAt" ] }, "UserAudioCreate": { "title": "UserAudioCreate", "description": "Create\n\nProperties to receive on useraudio creation", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DurationSeconds": { "title": "Durationseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "MediaUrl": { "title": "Mediaurl", "type": "string" }, "Title": { "title": "Title", "type": "string" } }, "required": [ "Title", "MediaUrl" ] }, "UserAudioPaginated": { "title": "UserAudioPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/UserAudio" } } }, "required": [ "records" ] }, "UserAudioUpdate": { "title": "UserAudioUpdate", "description": "Update\n\nProperties to receive on useraudio update", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DurationSeconds": { "title": "Durationseconds", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "MediaUrl": { "title": "Mediaurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "UserMedia": { "title": "UserMedia", "description": "UserMedia\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "CreatedAt": { "title": "Createdat", "type": "string" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaType": { "title": "Mediatype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaUrl": { "title": "Mediaurl", "type": "string" }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "UserMediaId": { "title": "Usermediaid", "type": "string" } }, "required": [ "MediaUrl", "UserMediaId", "UserId", "CreatedAt" ] }, "UserMediaCreate": { "title": "UserMediaCreate", "description": "Create\n\nProperties to receive on usermedia creation", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaType": { "title": "Mediatype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaUrl": { "title": "Mediaurl", "type": "string" }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserMediaId": { "title": "Usermediaid", "type": "string" } }, "required": [ "MediaUrl", "UserMediaId" ] }, "UserMediaPaginated": { "title": "UserMediaPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/UserMedia" } } }, "required": [ "records" ] }, "UserMediaUpdate": { "title": "UserMediaUpdate", "description": "Update\n\nProperties to receive on usermedia update", "type": "object", "properties": { "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaType": { "title": "Mediatype", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaUrl": { "title": "Mediaurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "UserProfile": { "title": "UserProfile", "description": "UserProfile\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminBrandImageUrl": { "title": "Adminbrandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminEmail": { "title": "Adminemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminFirstName": { "title": "Adminfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminImageUrl": { "title": "Adminimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminLastName": { "title": "Adminlastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Billing": { "anyOf": [ { "$ref": "#/components/schemas/Billing" }, { "type": "null" } ] }, "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Crm": { "title": "Crm", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAllowAiContactCreate": { "title": "Isallowaicontactcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDeleteRequested": { "title": "Isdeleterequested", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHasCrmSync": { "title": "Ishascrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTeamMember": { "title": "Isteammember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsUser": { "title": "Isuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessagingServiceId": { "title": "Messagingserviceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Milestones": { "anyOf": [ { "$ref": "#/components/schemas/Milestones" }, { "type": "null" } ] }, "NetworkEnrolledAt": { "title": "Networkenrolledat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RegisteredNumber": { "anyOf": [ { "$ref": "#/components/schemas/RegisteredNumber" }, { "type": "null" } ] }, "SourceAttribution": { "title": "Sourceattribution", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "UserId" ] }, "UserProfileAdminPaginated": { "title": "UserProfileAdminPaginated", "description": "UserProfileAdminPaginated", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/UserProfileInDBAdmin" } } }, "required": [ "records" ] }, "UserProfileInDBAdmin": { "title": "UserProfileInDBAdmin", "description": "UserProfileInDBAdmin\n\nBase plus additional billing", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminBrandImageUrl": { "title": "Adminbrandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminEmail": { "title": "Adminemail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminFirstName": { "title": "Adminfirstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminImageUrl": { "title": "Adminimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "AdminLastName": { "title": "Adminlastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Billing": { "anyOf": [ { "$ref": "#/components/schemas/BillingInDB" }, { "type": "null" } ] }, "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedAt": { "title": "Createdat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Crm": { "title": "Crm", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAllowAiContactCreate": { "title": "Isallowaicontactcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDeleteRequested": { "title": "Isdeleterequested", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHasCrmSync": { "title": "Ishascrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTeamMember": { "title": "Isteammember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsUser": { "title": "Isuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessagingServiceId": { "title": "Messagingserviceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Milestones": { "anyOf": [ { "$ref": "#/components/schemas/MilestonesInDB" }, { "type": "null" } ] }, "NetworkEnrolledAt": { "title": "Networkenrolledat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RegisteredNumber": { "anyOf": [ { "$ref": "#/components/schemas/RegisteredNumber" }, { "type": "null" } ] }, "SourceAttribution": { "title": "Sourceattribution", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "UserId" ] }, "UserProfileMilestonesUpdate": { "title": "UserProfileMilestonesUpdate", "description": "Update\n\nProperties to receive on miletones update", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Crm": { "title": "Crm", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAllowAiContactCreate": { "title": "Isallowaicontactcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDeleteRequested": { "title": "Isdeleterequested", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHasCrmSync": { "title": "Ishascrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTeamMember": { "title": "Isteammember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsUser": { "title": "Isuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessagingServiceId": { "title": "Messagingserviceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Milestones": { "$ref": "#/components/schemas/Milestones" }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RegisteredNumber": { "anyOf": [ { "$ref": "#/components/schemas/RegisteredNumber" }, { "type": "null" } ] }, "SourceAttribution": { "title": "Sourceattribution", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Milestones" ] }, "UserProfileNumber": { "title": "UserProfileNumber", "description": "UserProfileNumber\n\nReturns users number", "type": "object", "properties": { "Number": { "title": "Number", "type": "string" } }, "required": [ "Number" ] }, "UserProfileRegisteredNumberUpdate": { "title": "UserProfileRegisteredNumberUpdate", "description": "UserProfileRegisteredNumberUpdate\n\nProperties to receive on userprofile RegisteredNumber update", "type": "object", "properties": { "RegisteredNumber": { "$ref": "#/components/schemas/RegisteredNumber" } }, "required": [ "RegisteredNumber" ] }, "UserProfileUpdate": { "title": "UserProfileUpdate", "description": "Update\n\nProperties to receive on userprofile update", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Crm": { "title": "Crm", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAllowAiContactCreate": { "title": "Isallowaicontactcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDeleteRequested": { "title": "Isdeleterequested", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHasCrmSync": { "title": "Ishascrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTeamMember": { "title": "Isteammember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsUser": { "title": "Isuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessagingServiceId": { "title": "Messagingserviceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Milestones": { "anyOf": [ { "$ref": "#/components/schemas/Milestones" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RegisteredNumber": { "anyOf": [ { "$ref": "#/components/schemas/RegisteredNumber" }, { "type": "null" } ] }, "SourceAttribution": { "title": "Sourceattribution", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "UserSetupCreate": { "title": "UserSetupCreate", "description": "UserSetupCreate\n\nProperties to receive on user setup (second step after signup).\nCreates organization, Stripe customer, and billing.", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedUserId": { "title": "Createduserid", "type": "string" }, "Crm": { "title": "Crm", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAllowAiContactCreate": { "title": "Isallowaicontactcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDeleteRequested": { "title": "Isdeleterequested", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHasCrmSync": { "title": "Ishascrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTeamMember": { "title": "Isteammember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsUser": { "title": "Isuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceAttribution": { "title": "Sourceattribution", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "CreatedUserId" ] }, "UserSignupCreate": { "title": "UserSignupCreate", "description": "UserSignup\n\nProperties to receive on user signup", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedUserId": { "title": "Createduserid", "type": "string" }, "Crm": { "title": "Crm", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "type": "string" }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAllowAiContactCreate": { "title": "Isallowaicontactcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDeleteRequested": { "title": "Isdeleterequested", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHasCrmSync": { "title": "Ishascrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTeamMember": { "title": "Isteammember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsUser": { "title": "Isuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "type": "string" }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceAttribution": { "title": "Sourceattribution", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName", "Email", "CreatedUserId" ] }, "VCard": { "title": "VCard", "description": "Response model. Doesn't include internal PK and SK.", "type": "object", "properties": { "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Country": { "title": "Country", "type": "string", "default": "USA" }, "CreatedAt": { "title": "Createdat", "type": "string" }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "ImageUrl": { "title": "Imageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Kind": { "anyOf": [ { "$ref": "#/components/schemas/VCardKindEnum" }, { "type": "null" } ], "default": "individual" }, "LastName": { "title": "Lastname", "type": "string" }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Note": { "title": "Note", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Org": { "title": "Org", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VCardId": { "title": "Vcardid", "type": "string" }, "VCardUrl": { "title": "Vcardurl", "type": "string" }, "WebsiteUrl": { "title": "Websiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName", "UserId", "CreatedAt", "VCardId", "VCardUrl" ] }, "VCardCreate": { "title": "VCardCreate", "description": "Properties to receive on vcard creation.", "type": "object", "properties": { "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Country": { "title": "Country", "type": "string", "default": "USA" }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "type": "string" }, "ImageUrl": { "title": "Imageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Kind": { "anyOf": [ { "$ref": "#/components/schemas/VCardKindEnum" }, { "type": "null" } ], "default": "individual" }, "LastName": { "title": "Lastname", "type": "string" }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Note": { "title": "Note", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Org": { "title": "Org", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WebsiteUrl": { "title": "Websiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "FirstName", "LastName" ] }, "VCardKindEnum": { "title": "VCardKindEnum", "description": "Kind property (informational; not emitted in vCard 3.0).", "type": "string", "enum": [ "individual", "org" ] }, "VCardPaginated": { "title": "VCardPaginated", "description": "Paginated response.", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/VCard" } } }, "required": [ "records" ] }, "VCardParsed": { "title": "VCardParsed", "description": "Response model for parsing an inbound vcf attachment.", "type": "object", "properties": { "Emails": { "title": "Emails", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/VCardParsedEmail" } }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FullName": { "title": "Fullname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MediaUrl": { "title": "Mediaurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phones": { "title": "Phones", "type": "array", "default": [], "items": { "$ref": "#/components/schemas/VCardParsedPhone" } } } }, "VCardParsedEmail": { "title": "VCardParsedEmail", "description": "Email entry from a parsed inbound vcf.", "type": "object", "properties": { "Address": { "title": "Address", "type": "string" }, "Types": { "title": "Types", "type": "array", "default": [], "items": { "type": "string" } } }, "required": [ "Address" ] }, "VCardParsedPhone": { "title": "VCardParsedPhone", "description": "Phone entry from a parsed inbound vcf.", "type": "object", "properties": { "Number": { "title": "Number", "type": "string" }, "Types": { "title": "Types", "type": "array", "default": [], "items": { "type": "string" } } }, "required": [ "Number" ] }, "VCardUpdate": { "title": "VCardUpdate", "description": "Properties to receive on vcard update.", "type": "object", "properties": { "Address": { "title": "Address", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Country": { "title": "Country", "type": "string", "default": "USA" }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ImageUrl": { "title": "Imageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Kind": { "anyOf": [ { "$ref": "#/components/schemas/VCardKindEnum" }, { "type": "null" } ], "default": "individual" }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Nickname": { "title": "Nickname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Note": { "title": "Note", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Org": { "title": "Org", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "VCardUrl": { "title": "Vcardurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WebsiteUrl": { "title": "Websiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "Video": { "title": "Video", "description": "Video\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrowserFaviconUrl": { "title": "Browserfaviconurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrowserPageTitle": { "title": "Browserpagetitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ClickedPrimaryActionCount": { "title": "Clickedprimaryactioncount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ClickedSecondaryActionCount": { "title": "Clickedsecondaryactioncount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorEmail": { "title": "Displayauthoremail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorName": { "title": "Displayauthorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorPhone": { "title": "Displayauthorphone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorTitle": { "title": "Displayauthortitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorUrl": { "title": "Displayauthorurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandSize": { "title": "Displaybrandsize", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayDescription": { "title": "Displaydescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayPrimaryActionLink": { "title": "Displayprimaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayPrimaryActionText": { "title": "Displayprimaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionLink": { "title": "Displaysecondaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionText": { "title": "Displaysecondaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayTitle": { "title": "Displaytitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Duration": { "title": "Duration", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsDisplayPrimaryAction": { "title": "Isdisplayprimaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDisplaySecondaryAction": { "title": "Isdisplaysecondaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPublic": { "title": "Ispublic", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ {}, { "type": "null" } ] }, "MetaDescription": { "title": "Metadescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MetaTitle": { "title": "Metatitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SenderMemberId": { "title": "Sendermemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrl": { "title": "Shorturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Source": { "title": "Source", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceEmbedHtml": { "title": "Sourceembedhtml", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceJumpShareThumbnailUrl": { "title": "Sourcejumpsharethumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceJumpShareVideoId": { "title": "Sourcejumpsharevideoid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceLoomVideoId": { "title": "Sourceloomvideoid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceLoomVideoSigningId": { "title": "Sourceloomvideosigningid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceUploadFilename": { "title": "Sourceuploadfilename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceUploadVideoUrl": { "title": "Sourceuploadvideourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VideoId": { "title": "Videoid", "type": "string" }, "ViewCount": { "title": "Viewcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Title", "UserId", "VideoId", "CreatedTime" ] }, "VideoCreate": { "title": "VideoCreate", "description": "Create\n\nProperties to receive on video creation", "type": "object", "properties": { "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrowserFaviconUrl": { "title": "Browserfaviconurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrowserPageTitle": { "title": "Browserpagetitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ClickedPrimaryActionCount": { "title": "Clickedprimaryactioncount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ClickedSecondaryActionCount": { "title": "Clickedsecondaryactioncount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorEmail": { "title": "Displayauthoremail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorName": { "title": "Displayauthorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorPhone": { "title": "Displayauthorphone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorTitle": { "title": "Displayauthortitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorUrl": { "title": "Displayauthorurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandSize": { "title": "Displaybrandsize", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayDescription": { "title": "Displaydescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayPrimaryActionLink": { "title": "Displayprimaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayPrimaryActionText": { "title": "Displayprimaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionLink": { "title": "Displaysecondaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionText": { "title": "Displaysecondaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayTitle": { "title": "Displaytitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Duration": { "title": "Duration", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsDisplayPrimaryAction": { "title": "Isdisplayprimaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDisplaySecondaryAction": { "title": "Isdisplaysecondaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPublic": { "title": "Ispublic", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ {}, { "type": "null" } ] }, "MetaDescription": { "title": "Metadescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MetaTitle": { "title": "Metatitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SenderMemberId": { "title": "Sendermemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrl": { "title": "Shorturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Source": { "title": "Source", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceEmbedHtml": { "title": "Sourceembedhtml", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceJumpShareThumbnailUrl": { "title": "Sourcejumpsharethumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceJumpShareVideoId": { "title": "Sourcejumpsharevideoid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceLoomVideoId": { "title": "Sourceloomvideoid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceLoomVideoSigningId": { "title": "Sourceloomvideosigningid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceUploadFilename": { "title": "Sourceuploadfilename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceUploadVideoUrl": { "title": "Sourceuploadvideourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "ViewCount": { "title": "Viewcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "Title" ] }, "VideoTutorial": { "title": "VideoTutorial", "description": "VideoTutorial\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "Tags": { "title": "Tags", "type": "array", "items": { "type": "string" } }, "ThumbnailUrl": { "title": "Thumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Time": { "title": "Time", "type": "string" }, "Title": { "title": "Title", "type": "string" }, "VideoId": { "title": "Videoid", "type": "string" } }, "required": [ "VideoId", "Title", "Tags", "Time" ] }, "VideoTutorialsPaginated": { "title": "VideoTutorialsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/VideoTutorial" } } }, "required": [ "records" ] }, "VideoUpdate": { "title": "VideoUpdate", "description": "Update\n\nProperties to receive on video update", "type": "object", "properties": { "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrowserFaviconUrl": { "title": "Browserfaviconurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrowserPageTitle": { "title": "Browserpagetitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ClickedPrimaryActionCount": { "title": "Clickedprimaryactioncount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ClickedSecondaryActionCount": { "title": "Clickedsecondaryactioncount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "Description": { "title": "Description", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorEmail": { "title": "Displayauthoremail", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorName": { "title": "Displayauthorname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorPhone": { "title": "Displayauthorphone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorTitle": { "title": "Displayauthortitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayAuthorUrl": { "title": "Displayauthorurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayBrandSize": { "title": "Displaybrandsize", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayDescription": { "title": "Displaydescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayPrimaryActionLink": { "title": "Displayprimaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayPrimaryActionText": { "title": "Displayprimaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionLink": { "title": "Displaysecondaryactionlink", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplaySecondaryActionText": { "title": "Displaysecondaryactiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "DisplayTitle": { "title": "Displaytitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Duration": { "title": "Duration", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "IsDisplayPrimaryAction": { "title": "Isdisplayprimaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDisplaySecondaryAction": { "title": "Isdisplaysecondaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsPublic": { "title": "Ispublic", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ {}, { "type": "null" } ] }, "MetaDescription": { "title": "Metadescription", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MetaTitle": { "title": "Metatitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SenderMemberId": { "title": "Sendermemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrl": { "title": "Shorturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Source": { "title": "Source", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceEmbedHtml": { "title": "Sourceembedhtml", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceId": { "title": "Sourceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceJumpShareThumbnailUrl": { "title": "Sourcejumpsharethumbnailurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceJumpShareVideoId": { "title": "Sourcejumpsharevideoid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceLoomVideoId": { "title": "Sourceloomvideoid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceLoomVideoSigningId": { "title": "Sourceloomvideosigningid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceUploadFilename": { "title": "Sourceuploadfilename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "SourceUploadVideoUrl": { "title": "Sourceuploadvideourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ViewCount": { "title": "Viewcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } } }, "VideoView": { "title": "VideoView", "description": "VideoView\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "AnonymousId": { "title": "Anonymousid", "type": "string" }, "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "IsClickedPrimaryAction": { "title": "Isclickedprimaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsClickedSecondaryAction": { "title": "Isclickedsecondaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ {}, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VideoId": { "title": "Videoid", "type": "string" }, "VideoTitle": { "title": "Videotitle", "type": "string" }, "VideoViewId": { "title": "Videoviewid", "type": "string" }, "ViewCount": { "title": "Viewcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "VideoId", "AnonymousId", "VideoTitle", "UserId", "VideoViewId", "CreatedTime" ] }, "VideoViewCreate": { "title": "VideoViewCreate", "description": "Create\n\nProperties to receive on videoview creation", "type": "object", "properties": { "AnonymousId": { "title": "Anonymousid", "type": "string" }, "ContactId": { "title": "Contactid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ContactName": { "title": "Contactname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsClickedPrimaryAction": { "title": "Isclickedprimaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsClickedSecondaryAction": { "title": "Isclickedsecondaryaction", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "Meta": { "title": "Meta", "anyOf": [ {}, { "type": "null" } ] }, "VideoId": { "title": "Videoid", "type": "string" }, "VideoTitle": { "title": "Videotitle", "type": "string" }, "ViewCount": { "title": "Viewcount", "anyOf": [ { "type": "integer" }, { "type": "null" } ] } }, "required": [ "VideoId", "AnonymousId", "VideoTitle" ] }, "VideoViewsPaginated": { "title": "VideoViewsPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/VideoView" } } }, "required": [ "records" ] }, "VideosPaginated": { "title": "VideosPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Video" } } }, "required": [ "records" ] }, "Voice": { "title": "Voice", "description": "Voice\n\nThe model to be used for responses. Doesnt include internal PK and SK", "type": "object", "properties": { "AudioUrl": { "title": "Audiourl", "type": "string" }, "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedTime": { "title": "Createdtime", "type": "integer" }, "IsEvergreen": { "title": "Isevergreen", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "SenderMemberId": { "title": "Sendermemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrl": { "title": "Shorturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "TranscriptionStatus": { "title": "Transcriptionstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "Transcriptiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UpdatedAt": { "title": "Updatedat", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "UserId": { "title": "Userid", "type": "string" }, "VoiceId": { "title": "Voiceid", "type": "string" } }, "required": [ "Title", "AudioUrl", "UserId", "VoiceId", "CreatedTime" ] }, "VoiceCreate": { "title": "VoiceCreate", "description": "Create\n\nProperties to receive on voice creation", "type": "object", "properties": { "AudioUrl": { "title": "Audiourl", "type": "string" }, "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsEvergreen": { "title": "Isevergreen", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "SenderMemberId": { "title": "Sendermemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrl": { "title": "Shorturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "type": "string" }, "TranscriptionStatus": { "title": "Transcriptionstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "Transcriptiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Title", "AudioUrl" ] }, "VoiceUpdate": { "title": "VoiceUpdate", "description": "Update\n\nProperties to receive on voice update", "type": "object", "properties": { "AudioUrl": { "title": "Audiourl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandUrl": { "title": "Brandurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsEvergreen": { "title": "Isevergreen", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "SenderMemberId": { "title": "Sendermemberid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ShortUrl": { "title": "Shorturl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Title": { "title": "Title", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionStatus": { "title": "Transcriptionstatus", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TranscriptionText": { "title": "Transcriptiontext", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "VoicesPaginated": { "title": "VoicesPaginated", "description": "Pagination\n\nReturns pages of records and meta data about pagination", "type": "object", "properties": { "meta": { "anyOf": [ { "$ref": "#/components/schemas/ResponseMetaBase" }, { "type": "null" } ] }, "records": { "title": "Records", "type": "array", "items": { "$ref": "#/components/schemas/Voice" } } }, "required": [ "records" ] }, "WhaleUserCallForwarding": { "title": "WhaleUserCallForwarding", "description": "WhaleUserCallForwarding\n\nProvide a phone to set as the call forwarding number", "type": "object", "properties": { "Number": { "title": "Number", "type": "string" } }, "required": [ "Number" ] }, "WhaleUserComplianceMessage": { "title": "WhaleUserComplianceMessage", "description": "WhaleUserComplianceMessage\n\nProvide a comppliance message to set as the compliance message", "type": "object", "properties": { "Message": { "title": "Message", "type": "string" } }, "required": [ "Message" ] }, "WhaleUserSetupArchiver": { "title": "WhaleUserSetupArchiver", "description": "WhaleUserSetupArchiver", "type": "object", "properties": { "ConnectorEmail": { "title": "Connectoremail", "type": "string" }, "ConnectorName": { "title": "Connectorname", "type": "string" }, "ConnectorType": { "$ref": "#/components/schemas/ConnectorTypeEnum" } }, "required": [ "ConnectorName", "ConnectorType", "ConnectorEmail" ] }, "WhaleUserSignupCreate": { "title": "WhaleUserSignupCreate", "description": "WhaleUserSignupCreate\n\nUsed to signup a user by admin whale script", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Bio": { "title": "Bio", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "BrandImageUrl": { "title": "Brandimageurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CreatedUserId": { "title": "Createduserid", "type": "string" }, "Crm": { "title": "Crm", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalConnectorId": { "title": "Externalconnectorid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalData": { "anyOf": [ { "$ref": "#/components/schemas/ExternalDataWealthBox" }, { "type": "null" } ] }, "ExternalId": { "title": "Externalid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ExternalLastUpdated": { "title": "Externallastupdated", "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "ExternalType": { "anyOf": [ { "$ref": "#/components/schemas/ExternalTypeEnum" }, { "type": "null" } ] }, "FirstName": { "title": "Firstname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Industry": { "title": "Industry", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "IsActive": { "title": "Isactive", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsAllowAiContactCreate": { "title": "Isallowaicontactcreate", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsDeleteRequested": { "title": "Isdeleterequested", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsFree": { "title": "Isfree", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsGovernor": { "title": "Isgovernor", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsHasCrmSync": { "title": "Ishascrmsync", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "IsTeamMember": { "title": "Isteammember", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "IsUser": { "title": "Isuser", "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": false }, "JobTitle": { "title": "Jobtitle", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "MessagingServiceId": { "title": "Messagingserviceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Milestones": { "anyOf": [ { "$ref": "#/components/schemas/Milestones" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "OrganizationId": { "title": "Organizationid", "type": "string" }, "Phone": { "title": "Phone", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "RegisteredNumber": { "anyOf": [ { "$ref": "#/components/schemas/RegisteredNumber" }, { "type": "null" } ] }, "SourceAttribution": { "title": "Sourceattribution", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "TeamMemberUserId": { "title": "Teammemberuserid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceId": { "title": "Workspaceid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "OrganizationId", "CreatedUserId" ] }, "WhaleUserSignupPhone": { "title": "WhaleUserSignupPhone", "description": "WhaleUserSignupPhone\n\nProvide a phone to stub out for the user\n\nSupply PhoneSid to lookup in twilio", "type": "object", "properties": { "IsVoiceEnabled": { "title": "Isvoiceenabled", "type": "boolean" }, "Phone": { "title": "Phone", "type": "string" }, "PhoneSid": { "title": "Phonesid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "Phone", "IsVoiceEnabled" ] }, "WorkspaceBillingUpdate": { "title": "WorkspaceBillingUpdate", "description": "Request to update workspace billing", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "WorkspaceCreateIn": { "title": "WorkspaceCreateIn", "description": "Request to create workspace", "type": "object", "properties": { "AddOnProductIds": { "title": "Addonproductids", "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "Address1": { "title": "Address1", "type": "string" }, "Address2": { "title": "Address2", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "City": { "title": "City", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "CompanyName": { "title": "Companyname", "type": "string" }, "CompanyWebsiteUrl": { "title": "Companywebsiteurl", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "Email": { "title": "Email", "type": "string" }, "FirstName": { "title": "Firstname", "type": "string" }, "IsManagedBilling": { "title": "Ismanagedbilling", "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "LastName": { "title": "Lastname", "type": "string" }, "LegalDisclosure": { "title": "Legaldisclosure", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "NetworkId": { "title": "Networkid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "PlanProductId": { "title": "Planproductid", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "State": { "title": "State", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "WorkspaceName": { "title": "Workspacename", "type": "string" }, "Zip": { "title": "Zip", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "WorkspaceName", "Email", "FirstName", "LastName", "CompanyName" ] }, "AgentInteraction": { "type": "object", "properties": { "agentId": { "type": "string" }, "agentName": { "type": [ "string", "null" ] }, "conversationId": { "type": [ "string", "null" ] }, "dialplanId": { "type": [ "string", "null" ] }, "firmName": { "type": [ "string", "null" ] }, "nextNodeId": { "type": [ "string", "null" ] } }, "required": [ "agentId" ] }, "AnalysisStatus": { "type": "string", "enum": [ "queued", "processing", "completed", "error" ] }, "Attachment": { "type": "object", "properties": { "Content": { "type": "string" }, "ContentType": { "type": "string" }, "Filename": { "type": "string" } }, "required": [ "Filename", "ContentType", "Content" ] }, "CallParams": { "type": "object", "properties": { "contactNumber": { "type": [ "string", "null" ] }, "cursor": { "type": [ "string", "null" ] }, "direction": { "anyOf": [ { "$ref": "#/components/schemas/Direction" }, { "type": "null" } ] }, "dispositionId": { "type": [ "string", "null" ] }, "isAgentCall": { "type": [ "boolean", "null" ] }, "isContact": { "type": [ "boolean", "null" ] }, "isVoicemail": { "type": [ "boolean", "null" ] }, "limit": { "type": "integer", "format": "uint16", "default": 100, "maximum": 65535, "minimum": 0 }, "search": { "type": [ "string", "null" ] }, "since": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "until": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "userNumber": { "type": [ "string", "null" ] } } }, "CallQualityReport": { "type": "object", "properties": { "appVersion": { "type": [ "string", "null" ] }, "callSid": { "type": "string" }, "cellularGeneration": { "description": "e.g. \"4g\" | \"5g\", when on cellular.", "type": [ "string", "null" ] }, "clientTimestamp": { "type": "string" }, "contactNumber": { "type": [ "string", "null" ] }, "direction": { "type": "string" }, "durationSeconds": { "type": "number", "format": "double" }, "networkChanged": { "description": "True when the transport changed mid-call (wifi <-> cellular handoff).", "type": [ "boolean", "null" ] }, "networkType": { "description": "NetInfo transport at ship time, e.g. \"wifi\" | \"cellular\" | \"none\".", "type": [ "string", "null" ] }, "networkTypes": { "description": "Every distinct transport seen during the call, in first-seen order.", "type": "array", "default": [], "items": { "type": "string" } }, "osVersion": { "type": [ "string", "null" ] }, "platform": { "description": "\"ios\" | \"android\". Absent for web clients.", "type": [ "string", "null" ] }, "sampleCount": { "type": "integer", "format": "uint32", "minimum": 0 }, "samples": { "type": "array", "items": { "$ref": "#/components/schemas/RtcSample" } }, "userNumber": { "type": [ "string", "null" ] }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/CallQualityWarning" } } }, "required": [ "callSid", "direction", "sampleCount", "durationSeconds", "samples", "warnings", "clientTimestamp" ] }, "CallQualityWarning": { "type": "object", "properties": { "name": { "type": "string" }, "timestamp": { "type": "integer", "format": "uint64", "minimum": 0 } }, "required": [ "name", "timestamp" ] }, "CallStatus": { "type": "string", "enum": [ "created", "initiated", "ringing", "in-progress", "transferred", "blocked", "completed", "failed", "busy", "no-answer", "cancelled" ] }, "ChannelType": { "type": "string", "enum": [ "sms", "whatsapp" ] }, "Comment": { "type": "object", "properties": { "Comment": { "type": [ "string", "null" ] }, "CreatedByUserId": { "type": [ "string", "null" ] }, "CreatedByUserName": { "type": [ "string", "null" ] }, "CreatedTime": { "$ref": "#/components/schemas/StringInt" }, "MessageCommentId": { "anyOf": [ { "$ref": "#/components/schemas/StringInt" }, { "type": "null" } ] }, "UpdatedAt": { "type": [ "string", "null" ] } }, "required": [ "CreatedTime" ] }, "ConversationParams": { "type": "object", "properties": { "cursor": { "type": [ "string", "null" ] }, "folderId": { "type": [ "string", "null" ] }, "isSnoozed": { "type": [ "boolean", "null" ] }, "isUnread": { "type": [ "boolean", "null" ] }, "limit": { "type": "integer", "format": "uint16", "default": 100, "maximum": 65535, "minimum": 0 }, "search": { "type": [ "string", "null" ] }, "status": { "anyOf": [ { "$ref": "#/components/schemas/Status" }, { "type": "null" } ] }, "userNumber": { "type": [ "string", "null" ] } } }, "ConversationStreamItem": { "oneOf": [ { "type": "object", "properties": { "TYPE": { "type": "string", "const": "MESSAGE" } }, "allOf": [ { "$ref": "#/components/schemas/Message" } ], "required": [ "TYPE" ] }, { "type": "object", "properties": { "TYPE": { "type": "string", "const": "CALL" } }, "allOf": [ { "$ref": "#/components/schemas/Call" } ], "required": [ "TYPE" ] } ] }, "CountUnreadParams": { "type": "object", "properties": { "userNumber": { "type": [ "string", "null" ] } } }, "Direction": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ] }, "Direction2": { "type": "string", "enum": [ "SENT", "RECEIVED" ] }, "Extension": { "type": "object", "properties": { "ExtensionNumber": { "type": "string" }, "OwnerId": { "type": "string" }, "OwnerType": { "$ref": "#/components/schemas/ExtensionOwnerType" }, "RoutingTags": { "type": "array", "default": [], "items": { "type": "string" } }, "WorkspaceId": { "type": "string" } }, "required": [ "ExtensionNumber", "OwnerType", "OwnerId", "WorkspaceId" ] }, "ExtensionOwner": { "description": "Payload for PUT /api/v1/extensions/:extension_number", "type": "object", "properties": { "OwnerId": { "type": "string" }, "OwnerType": { "$ref": "#/components/schemas/ExtensionOwnerType" }, "RoutingTags": { "type": "array", "default": [], "items": { "type": "string" } } }, "required": [ "OwnerType", "OwnerId" ] }, "ExtensionOwnerType": { "type": "string", "enum": [ "inbox", "team_member" ] }, "Fax": { "description": "Read model for an outbound fax, returned by the `/faxes` list/get APIs\n (Plan 07 slice 4). Deserialized from the DynamoDB fax record; storage-only\n attributes (keys, `StatusWeight`, `S3Key`) are ignored.", "type": "object", "properties": { "CreatedTime": { "$ref": "#/components/schemas/UnixTimestamp" }, "Direction": { "description": "Always `OUTBOUND` for now (inbound fax lands as a call record).", "type": "string" }, "FaxId": { "type": "string" }, "FromNumber": { "type": "string" }, "PageCount": { "description": "Pages transmitted so far / total on `sent`. Absent until reported.", "type": [ "integer", "null" ], "format": "uint32", "minimum": 0 }, "Status": { "description": "Lifecycle status: `queued` | `dialing` | `transmitting` | `sent` | `failed`.", "type": "string" }, "ToNumber": { "type": "string" }, "UpdatedTime": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "UserId": { "type": "string" } }, "required": [ "FaxId", "UserId", "FromNumber", "ToNumber", "Direction", "Status", "CreatedTime" ] }, "InitRequest": { "type": "object", "properties": { "agent_id": { "type": "string" }, "call_sid": { "type": "string" }, "called_number": { "type": "string" }, "caller_id": { "type": "string" }, "conversation_id": { "type": "string" } }, "required": [ "caller_id", "agent_id", "called_number", "call_sid", "conversation_id" ] }, "InitResponse": { "type": "object", "properties": { "type": { "type": "string" }, "dynamic_variables": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": [ "type", "dynamic_variables" ] }, "ListFaxesParams": { "type": "object", "properties": { "limit": { "type": "integer", "format": "uint16", "default": 100, "maximum": 65535, "minimum": 0 } } }, "MediaItem": { "type": "object", "properties": { "ChatServiceId": { "type": [ "string", "null" ] }, "FileName": { "type": [ "string", "null" ] }, "MediaId": { "type": [ "string", "null" ] }, "MediaType": { "type": "string" }, "MediaUrl": { "type": [ "string", "null" ] } }, "required": [ "MediaType" ] }, "MessageOrder": { "type": "string", "enum": [ "asc", "desc" ] }, "MessageParams": { "type": "object", "properties": { "contactNumber": { "type": [ "string", "null" ] }, "cursor": { "type": [ "string", "null" ] }, "includeGroups": { "type": [ "boolean", "null" ] }, "limit": { "type": "integer", "format": "uint16", "default": 100, "maximum": 65535, "minimum": 0 }, "order": { "description": "PRO-4251: `asc` for oldest-first, `desc` (default) for newest-first.", "anyOf": [ { "$ref": "#/components/schemas/MessageOrder" }, { "type": "null" } ] }, "search": { "type": [ "string", "null" ] }, "since": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "until": { "anyOf": [ { "$ref": "#/components/schemas/UnixTimestamp" }, { "type": "null" } ] }, "userNumber": { "type": [ "string", "null" ] } } }, "Meta": { "type": "object", "properties": { "cursor": { "type": [ "string", "null" ] }, "total": { "type": "integer", "format": "uint", "minimum": 0 } }, "required": [ "total" ] }, "Paginated_for_Call": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/Call" } } }, "required": [ "meta", "records" ] }, "Paginated_for_Conversation": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } } }, "required": [ "meta", "records" ] }, "Paginated_for_ConversationStreamItem": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ConversationStreamItem" } } }, "required": [ "meta", "records" ] }, "Paginated_for_Extension": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/Extension" } } }, "required": [ "meta", "records" ] }, "Paginated_for_Fax": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/Fax" } } }, "required": [ "meta", "records" ] }, "Paginated_for_Message": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } }, "required": [ "meta", "records" ] }, "Paginated_for_PersonalVoicemail": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalVoicemail" } } }, "required": [ "meta", "records" ] }, "Participant": { "type": "object", "properties": { "CallSid": { "type": [ "string", "null" ] }, "CallStatus": { "type": [ "string", "null" ] }, "ContactId": { "type": [ "string", "null" ] }, "Name": { "type": [ "string", "null" ] }, "Number": { "type": [ "string", "null" ] }, "TeamMemberId": { "type": [ "string", "null" ] }, "Type": { "$ref": "#/components/schemas/ParticipantKind" } }, "required": [ "Type" ] }, "Participant2": { "type": "object", "properties": { "ContactId": { "type": [ "string", "null" ] }, "Name": { "type": [ "string", "null" ] }, "Number": { "type": [ "string", "null" ] }, "Type": { "$ref": "#/components/schemas/ParticipantKind2" } }, "required": [ "Type" ] }, "ParticipantKind": { "type": "string", "enum": [ "contact", "team", "notetaker" ] }, "ParticipantKind2": { "type": "string", "enum": [ "contact", "team" ] }, "PersonalVoicemail": { "type": "object", "properties": { "TeamMemberId": { "type": "string" }, "VoicemailAudioUrl": { "type": "string" }, "WorkspaceId": { "type": "string" } }, "required": [ "TeamMemberId", "WorkspaceId", "VoicemailAudioUrl" ] }, "Raw": { "type": "object", "properties": { "Attachments": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "BodyContent": { "type": "string" }, "SendBCC": { "type": "array", "default": [], "items": { "type": "string" } }, "SendCC": { "type": "array", "default": [], "items": { "type": "string" } }, "SendFrom": { "type": "string" }, "SendSubject": { "type": "string" }, "SendTo": { "type": "array", "items": { "type": "string" } } }, "required": [ "SendFrom", "SendTo", "SendSubject", "BodyContent" ] }, "RecordingStatus": { "type": "string", "enum": [ "in-progress", "completed", "absent" ] }, "RtcSample": { "description": "Subset of Twilio RTCSample fields used for server-side aggregation.\n Unknown fields in the payload are silently ignored.", "type": "object", "properties": { "jitter": { "description": "Jitter in MILLISECONDS. Both clients send ms: the web SDK multiplies the\n raw WebRTC seconds by 1000 before placing them in `RTCSample`, and\n cc-mob-app converts explicitly (`IMobileRtcSample.jitter`). Do NOT\n \"correct\" this to seconds \u2014 `compute_aggregates` reports it as ms and a\n unit change here would corrupt the web AND mobile datasets at once.", "type": [ "number", "null" ], "format": "double" }, "mos": { "type": [ "number", "null" ], "format": "double" }, "packetsLostFraction": { "type": [ "number", "null" ], "format": "double" }, "rtt": { "description": "Round-trip time in MILLISECONDS. See `jitter` above.", "type": [ "number", "null" ], "format": "double" } } }, "SendMessageParams": { "type": "object", "properties": { "setStatus": { "anyOf": [ { "$ref": "#/components/schemas/Status" }, { "type": "null" } ] } } }, "SendMessageRequest": { "type": "object", "properties": { "ArchiverIds": true, "ChannelType": { "anyOf": [ { "$ref": "#/components/schemas/ChannelType" }, { "type": "null" } ] }, "Comments": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/Comment" } }, "ContactId": { "type": [ "string", "null" ] }, "ContactName": { "type": [ "string", "null" ] }, "ContactNumber": { "type": "string" }, "ConversationId": { "type": [ "string", "null" ] }, "CrmIds": true, "ErrorCode": { "type": [ "string", "null" ] }, "ErrorMessage": { "type": [ "string", "null" ] }, "IsIgnored": { "type": [ "boolean", "null" ] }, "IsSilenced": { "type": [ "boolean", "null" ] }, "LocalMessageId": { "type": [ "string", "null" ] }, "Message": { "type": [ "string", "null" ] }, "MessageMediaItems": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/MediaItem" } }, "Meta": true, "SenderMemberId": { "type": [ "string", "null" ] }, "SenderName": { "type": [ "string", "null" ] }, "Tags": { "type": [ "array", "null" ], "items": { "type": "string" } }, "UserId": { "type": "string" }, "UserNumber": { "type": [ "string", "null" ] } }, "required": [ "UserId", "ContactNumber" ] }, "Status": { "type": "string", "enum": [ "OPEN", "CLOSED" ] }, "Status2": { "type": "string", "enum": [ "created", "ready", "blockednumber", "cannotroute", "error", "invalid", "nosms", "presenderror", "senderror", "unsubscribed", "unsubscriber", "accepted", "delivered", "failed", "queued", "read", "sending", "sent", "undelivered", "received", "receiving" ] }, "StreamParams": { "type": "object", "properties": { "cursor": { "type": [ "string", "null" ] }, "limit": { "type": "integer", "format": "uint16", "default": 100, "maximum": 65535, "minimum": 0 }, "search": { "type": [ "string", "null" ] } } }, "StringInt": { "anyOf": [ { "type": "string" }, { "type": "integer", "format": "uint64", "minimum": 0 } ] }, "TransferParticipant": { "type": "object", "properties": { "Number": { "type": [ "string", "null" ] }, "TeamMemberId": { "type": [ "string", "null" ] }, "Type": { "$ref": "#/components/schemas/TransferParticipantType" } }, "required": [ "Type" ] }, "TransferParticipantType": { "description": "Mirrors Python `CallParticipantType` \u2014 the app sends lowercase `\"team\"` /\n `\"contact\"`. Uppercase aliases accepted for robustness.", "type": "string", "enum": [ "team", "contact" ] }, "TransferQuery": { "type": "object", "properties": { "attended": { "type": "boolean", "default": false }, "userId": { "description": "Impersonated user id (workspace admin acting on a member's behalf).", "type": [ "string", "null" ] } } }, "UnixTimestamp": { "description": "Unix timestamp in seconds", "type": "integer" }, "A2pRegistrationParams": { "description": "Query params for `a2p-registrations` (LOCKED CONTRACT, PRO-4794). Deliberately\n plain snake_case (no `rename_all`) \u2014 cc-ops-billing sends `charged_after`/\n `charged_before`/`cursor` literally, not camelCase.", "type": "object", "properties": { "charged_after": { "type": [ "integer", "null" ], "format": "int64" }, "charged_before": { "type": [ "integer", "null" ], "format": "int64" }, "cursor": { "type": [ "string", "null" ] } } }, "AccessSource": { "description": "Where a feature's effective access decision came from \u2014 returned alongside the\n boolean for UI display (\"why is this on/off\").", "oneOf": [ { "description": "A workspace-tier explicit value decided it.", "type": "string", "const": "workspace" }, { "description": "An organization-tier explicit value decided it.", "type": "string", "const": "organization" }, { "description": "A network-tier explicit value decided it.", "type": "string", "const": "network" }, { "description": "No tier set it; the feature default ([`Feature::default_access`]) decided it.", "type": "string", "const": "default" }, { "description": "Forced OFF by the network hard-ceiling lock (overrides any lower tier).", "type": "string", "const": "networkLocked" }, { "description": "Forced OFF because the workspace's subscription does not entitle the feature.", "type": "string", "const": "subscriptionExcluded" } ] }, "AnnouncementConfig": { "description": "A tier's persisted recording-announcement config. Carries no persistence\n keys; the data layer converts its record into this shape.\n\n `enabled: None` / `prompt_ref: None` mean \"unset at this tier\" and defer to\n the next tier up \u2014 the same \"absent = defer up\" semantics as\n [`FeatureConfig`], just expressed as `Option` fields instead of a\n present/absent map entry (there is only one setting here, not a map of\n them).", "type": "object", "properties": { "Enabled": { "description": "Unset (`None`) defers to the next tier up.", "type": [ "boolean", "null" ] }, "Locked": { "description": "Network-tier-only hard ceiling: forces every lower tier (workspace,\n inbox) to inherit this tier's `enabled` + `prompt_ref` outright. Always\n `false` on a non-network tier (enforced by [`AnnouncementConfigUpsert::validate`]).", "type": "boolean", "default": false }, "PromptRef": { "description": "Reference to which prompt to play (opaque id/URL owned by PRO-5676).\n Independent of `enabled` so a tier can pre-stage a prompt before\n flipping the feature on.", "type": [ "string", "null" ] }, "Tier": { "$ref": "#/components/schemas/Tier" }, "TierId": { "type": "string" }, "UpdatedTime": { "type": "integer", "format": "int64" } }, "required": [ "Tier", "TierId", "UpdatedTime" ] }, "AnnouncementConfigUpsert": { "description": "Upsert input for a tier's config. The tier + tier id come from the request\n path, not the body.", "type": "object", "properties": { "Enabled": { "type": [ "boolean", "null" ] }, "Locked": { "type": "boolean", "default": false }, "PromptRef": { "type": [ "string", "null" ] } } }, "AnnouncementSource": { "description": "Where a resolved value came from.", "oneOf": [ { "type": "string", "enum": [ "workspace", "network" ] }, { "description": "Neither tier set it: default OFF (unlike the boolean-feature default of\n \"enabled\", this is a new, no-prompt-configured setting \u2014 defaulting to\n enabled would mean bridging calls with no prompt to play).", "type": "string", "const": "default" } ] }, "ArchivingRule": { "description": "A network-level archiving rule as returned to clients. Carries no persistence\n keys; the data layer converts its record into this shape.", "type": "object", "properties": { "ConnectorId": { "description": "Id of the specific configured connector instance.", "type": "string" }, "ConnectorMeta": { "description": "Denormalized connector delivery config (recipients, SMTP settings, secret\n param name, ...) copied from the connector at create time. Mirrors Python\n `RoutingRule.ConnectorMeta` \u2014 a flexible object the Python archive channels\n read directly for delivery. Stored verbatim as JSON (like `ConnectorType`),\n not remodelled into a Rust type, so the large connector-meta taxonomy is\n not reinvented/drifted here. Optional so pre-PRO-5071 rows still deserialize." }, "ConnectorName": { "description": "Optional human-readable connector name.", "type": [ "string", "null" ] }, "ConnectorSecureParamName": { "description": "Name of the SSM parameter holding the connector's secret (secure\n connectors only). Mirrors Python `RoutingRule.ConnectorSecureParamName`.", "type": [ "string", "null" ] }, "ConnectorType": { "description": "Archiver connector kind, e.g. `GLOBALRELAY` (Python `RoutingTypeEnum`;\n stored verbatim as a string).", "type": "string" }, "CreatedTime": { "type": "integer", "format": "int64" }, "EventName": { "description": "Event that triggers archiving, e.g. `MESSAGE_ALL` (Python\n `RoutingEventNamesEnum`; stored verbatim as a string).", "type": "string" }, "Frequency": { "$ref": "#/components/schemas/Frequency" }, "IsAutoOptIn": { "description": "Whether new participants are automatically opted into archiving.", "type": "boolean" }, "IsEnabled": { "description": "Master on/off for the rule.", "type": "boolean" }, "NetworkId": { "description": "The network this rule belongs to (path context, echoed back for clients).", "type": "string" }, "RuleId": { "description": "Server-minted stable id for the rule (`AR` + ULID).", "type": "string" }, "UpdatedTime": { "type": [ "integer", "null" ], "format": "int64" } }, "required": [ "NetworkId", "RuleId", "EventName", "Frequency", "ConnectorType", "ConnectorId", "IsEnabled", "IsAutoOptIn", "CreatedTime" ] }, "ArchivingRuleCreate": { "description": "Properties to receive when creating an archiving rule. `NetworkId`/`RuleId`\n are NOT client-supplied \u2014 the network comes from the path and the id is\n minted by the data layer.", "type": "object", "properties": { "ConnectorId": { "type": "string", "maxLength": 256, "minLength": 1 }, "ConnectorMeta": { "description": "Denormalized connector delivery config. In Python this is populated from\n the connector record's `Meta` at create time; connector records live only\n in the Python `cc-api-users` (not in this Rust service), so here it is\n accepted from the caller \u2014 the create caller/admin-UI must supply it (and\n `ConnectorSecureParamName`) for a network archive rule to deliver." }, "ConnectorName": { "type": [ "string", "null" ] }, "ConnectorSecureParamName": { "description": "SSM parameter name for the connector's secret (secure connectors only).", "type": [ "string", "null" ] }, "ConnectorType": { "type": "string", "maxLength": 64, "minLength": 1 }, "EventName": { "type": "string", "maxLength": 64, "minLength": 1 }, "Frequency": { "$ref": "#/components/schemas/Frequency" }, "IsAutoOptIn": { "description": "Defaults to `false` when the client omits it.", "type": "boolean", "default": false }, "IsEnabled": { "description": "Master on/off; required on create (mirrors the Python routing-rule create,\n where `IsEnabled` is required).", "type": "boolean" } }, "required": [ "EventName", "Frequency", "ConnectorType", "ConnectorId", "IsEnabled" ] }, "ArchivingRuleSuppression": { "description": "One workspace's active suppression of one network archiving rule. Presence of\n the record IS the active suppression; `IsSuppressed` is always `true` for a\n stored record (removal deletes the record rather than flipping the flag), but\n is carried explicitly so the wire shape names the intent and the Python union\n can defensively re-check it.", "type": "object", "properties": { "IsSuppressed": { "description": "Always `true` for a stored suppression. See the type doc.", "type": "boolean" }, "NetworkRuleId": { "description": "The network archiving rule's id (`ArchivingRule::rule_id`) being suppressed.", "type": "string" }, "UpdatedTime": { "description": "Unix seconds of the last write, when known.", "type": [ "integer", "null" ], "format": "int64" }, "WorkspaceId": { "description": "The workspace that has opted out of the network rule.", "type": "string" } }, "required": [ "WorkspaceId", "NetworkRuleId", "IsSuppressed" ] }, "ArchivingRuleUpdate": { "description": "Partial-update input for an archiving rule. Every field is a plain `Option`:\n absent (`None`) leaves the attribute unchanged, present (`Some`) SETs it. The\n identity fields (`EventName`, `ConnectorId`) are NOT here \u2014 they are part of\n the rule's key, so changing them means deleting and recreating the rule. This\n mirrors the single-`UpdateItem` partial-update style established by\n `NetworkUpdate`, minus the clear (`REMOVE`) semantics these always-present\n scalar fields don't need.", "type": "object", "properties": { "ConnectorName": { "type": [ "string", "null" ] }, "ConnectorType": { "type": [ "string", "null" ] }, "Frequency": { "anyOf": [ { "$ref": "#/components/schemas/Frequency" }, { "type": "null" } ] }, "IsAutoOptIn": { "type": [ "boolean", "null" ] }, "IsEnabled": { "type": [ "boolean", "null" ] } } }, "FeatureAccess": { "description": "Effective access for one feature: the boolean the client gates on plus the\n deciding [`AccessSource`].", "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Source": { "$ref": "#/components/schemas/AccessSource" } }, "required": [ "Enabled", "Source" ] }, "FeatureAccessResponse": { "description": "The `GET /features/access/{workspaceId}` response: the workspace it resolved for and the flat\n per-feature access map (every feature is present).", "type": "object", "properties": { "Features": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FeatureAccess" } }, "WorkspaceId": { "type": "string" } }, "required": [ "WorkspaceId", "Features" ] }, "FeatureConfig": { "description": "A tier's persisted feature config, returned to clients. Carries no persistence\n keys; the data layer converts its record into this shape.", "type": "object", "properties": { "Features": { "description": "Bi-state feature map. A feature absent from the map is \"unset\" and defers\n to the next tier up; only present features carry an explicit value.", "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FeatureState" } }, "Locked": { "description": "Network-tier-only hard-ceiling locks. A feature mapped to `true` is a hard\n ceiling a lower tier cannot lift. Empty (omitted) on non-network tiers.", "type": "object", "additionalProperties": { "type": "boolean" } }, "Tier": { "$ref": "#/components/schemas/Tier" }, "TierId": { "type": "string" }, "UpdatedTime": { "description": "Unix seconds of the last write (a config is a settings blob overwritten in\n place, so a single last-modified stamp is all it carries).", "type": "integer", "format": "int64" } }, "required": [ "Tier", "TierId", "Features", "UpdatedTime" ] }, "FeatureConfigUpsert": { "description": "Upsert input for a tier's feature config. The tier + tier id come from the\n request path (repo arguments), not the body; the body carries only the map(s).", "type": "object", "properties": { "Features": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/FeatureState" } }, "Locked": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "required": [ "Features" ] }, "FeatureState": { "description": "Bi-state value for a feature at a single tier. A feature is only present in\n the map when it has an explicit `Enabled`/`Disabled` value; an absent feature\n is \"unset\" and defers to the next tier up.", "type": "string", "enum": [ "enabled", "disabled" ] }, "Frequency": { "description": "How often events accumulate before the archiver connector is fed. Mirrors the\n Python `RoutingFrequenciesEnum` exactly (a small, stable control vocabulary,\n so it is worth a typed enum). Serialized as the SCREAMING_SNAKE wire values\n the rest of the platform already uses (`STREAM`/`HOURLY`/`DAILY`/`WEEKLY`).", "type": "string", "enum": [ "STREAM", "HOURLY", "DAILY", "WEEKLY" ] }, "ListParams": { "type": "object", "properties": { "cursor": { "type": [ "string", "null" ] }, "limit": { "type": [ "integer", "null" ], "format": "int32" } } }, "ListParams2": { "type": "object", "properties": { "cursor": { "type": [ "string", "null" ] }, "enabled": { "description": "Optional enabled-state filter (PRO-5021). `?enabled=true` returns only the\n network's enabled rules \u2014 what the PRO-4204 event path reads; absent\n returns every rule regardless of state.", "type": [ "boolean", "null" ] }, "eventName": { "description": "Optional single-event filter. When present, only that event's rules are\n returned (list-by-event); absent lists every rule in the network.", "type": [ "string", "null" ] }, "limit": { "type": [ "integer", "null" ], "format": "int32" } } }, "Network": { "description": "The network model returned to clients: a bare id + name + timestamps. Carries\n no persistence keys; the data layer converts its record into this shape.", "type": "object", "properties": { "A2pDiscountEndTime": { "description": "Network-level cap end time (unix seconds) for the 40% A2P 10DLC\n registration discount (PRO-4673). `None` (omitted) means the discount is\n inactive for this network.", "type": [ "integer", "null" ], "format": "int64" }, "A2pDiscountRate": { "description": "Network-level A2P 10DLC discount rate \u2014 the discount *fraction*, e.g.\n `0.40` for 40% off (PRO-4673). `None` (omitted) means unset. Served\n verbatim; the Python consumer applies it so it stops hardcoding the rate.", "type": [ "number", "null" ], "format": "double" }, "CreatedTime": { "type": "integer", "format": "int64" }, "Name": { "type": [ "string", "null" ] }, "NetworkId": { "type": "string" }, "StripeCustomerId": { "description": "Consolidated Stripe payer/customer id for the network (PRO-4552). Present\n once the network has been provisioned in Stripe by the cc-ops-billing\n tool; `None` (omitted) means the network is not yet provisioned. Persisted\n under the same `StripeCustomerId` attribute the billing engine reads off\n the shared NETWORK item.", "type": [ "string", "null" ] }, "SubscriptionId": { "description": "Consolidated subscription id for the network (PRO-4552). Present once the\n network has been provisioned in Stripe; `None` (omitted) means not yet\n provisioned. Persisted under the same `SubscriptionId` attribute the\n billing engine reads off the shared NETWORK item.", "type": [ "string", "null" ] }, "UpdatedTime": { "type": [ "integer", "null" ], "format": "int64" } }, "required": [ "NetworkId", "CreatedTime" ] }, "NetworkCreate": { "description": "Properties to receive on network creation. `Name` is required and bounded.", "type": "object", "properties": { "A2pDiscountEndTime": { "description": "Optional network-level cap end time (unix seconds) for the 40% A2P 10DLC\n registration discount (PRO-4673). Default unset (`None`) means the\n discount is inactive for the network. The actual per-registration charge\n lives in the Python `cc-api-users`; this is only the operator-authored\n end date persisted on the shared NETWORK item.", "type": [ "integer", "null" ], "format": "int64" }, "A2pDiscountRate": { "description": "Optional network-level A2P 10DLC discount rate \u2014 the discount *fraction*,\n e.g. `0.40` for 40% off (PRO-4673). Default unset (`None`). Stored and\n served verbatim; the Python `cc-api-users` consumer applies it (no\n `1 - x` / clamping happens in Rust) so it stops hardcoding the multiplier.", "type": [ "number", "null" ], "format": "double" }, "Name": { "type": "string", "maxLength": 255, "minLength": 1 } }, "required": [ "Name" ] }, "NetworkEnrollRequest": { "description": "Request body for `POST /network/enroll`. Carries ONLY the target network;\n the workspace is always the authenticated caller's own (self-scoped).", "type": "object", "properties": { "NetworkId": { "description": "The network the caller's workspace should join.", "type": "string" } }, "required": [ "NetworkId" ] }, "NetworkEnrollResponse": { "description": "Response for a completed enrollment.\n\n PRO-4607: surfaces the prepaid-overhang refund and the month-end cutover so\n the frontend can show \"you'll see a refund of $X soon; XYPN charges you on\n the 1st.\"", "type": "object", "properties": { "NetworkId": { "type": "string" }, "RefundAmountCents": { "description": "The overhang refunded to the customer, in cents (`0` when there was no\n active self-pay subscription/charge to refund).", "type": "integer", "format": "int64" }, "RefundCurrency": { "description": "Lowercase ISO-4217 currency of the refund (e.g. `\"usd\"`).", "type": "string" }, "SubscriptionEndsAt": { "description": "When the self-pay subscription is scheduled to cancel \u2014 the last second\n of the current calendar month, RFC 3339 (UTC). XYPN's managed billing\n takes over from the 1st.", "type": "string" }, "Success": { "type": "boolean" }, "WorkspaceId": { "description": "The workspace that was enrolled (always the caller's own).", "type": "string" } }, "required": [ "Success", "WorkspaceId", "NetworkId", "RefundAmountCents", "RefundCurrency", "SubscriptionEndsAt" ] }, "NetworkOrganizationCreate": { "description": "Create a new organization AND its owner workspace inside the caller's network\n (PRO-4189). The owner Cognito account is minted by the service from `Email`\n (new-accounts-only, mirroring the XYPN owner path); the org and the workspace\n both inherit the caller's `NetworkId`.", "type": "object", "properties": { "CompanyName": { "type": [ "string", "null" ], "default": null }, "Email": { "type": "string" }, "FirstName": { "type": [ "string", "null" ], "default": null }, "LastName": { "type": [ "string", "null" ], "default": null } }, "required": [ "Email" ] }, "NetworkOrganizationCreated": { "description": "The created organization plus its provisioned owner workspace (PRO-4189).", "type": "object", "properties": { "Organization": { "$ref": "#/components/schemas/Organization" }, "Workspace": { "$ref": "#/components/schemas/UserProfile" } }, "required": [ "Organization", "Workspace" ] }, "NetworkUpdate": { "description": "Partial-update input for a network (PRO-4673 / PRO-4552). Each field is a\n serde \"double option\" so a PATCH applies ONLY the fields it actually supplies\n \u2014 a field absent from the body is left unchanged, never clobbered. This is\n critical because two independent writers touch the shared NETWORK item (ops\n sets the A2P discount window/rate; the cc-ops-billing tool sets the Stripe\n link). Per field:\n * ABSENT from the body -> `None` -> leave the attribute unchanged (no-op)\n * explicit `null` -> `Some(None)` -> REMOVE the attribute (clear it)\n * a value -> `Some(Some)` -> SET the attribute\n\n The whole struct feeds a single [`crate::data::NetworkRepository::update_network`]\n call that assembles one `UpdateItem` from exactly the present fields; new\n fields (like the Stripe link) extend this struct rather than adding new repo\n methods. Presence of the Stripe link is the \"configured = has link attribute\"\n signal the XYPN consolidated billing engine reads.", "type": "object", "properties": { "A2pDiscountEndTime": { "type": [ "integer", "null" ], "format": "int64" }, "A2pDiscountRate": { "type": [ "number", "null" ], "format": "double" }, "StripeCustomerId": { "type": [ "string", "null" ] }, "SubscriptionId": { "type": [ "string", "null" ] } } }, "NetworkUserCreate": { "description": "Create a new owner workspace (+ its own organization) directly in a named\n network, with a permanent password set immediately and no invite email\n (PRO-5377). For the internal/system-guarded admin surface (e.g. cc-admin\n test-user creation) rather than network-admin self-service \u2014 see\n [`super::super::network_admin_api::NetworkAdminService::create_network_user`].", "type": "object", "properties": { "CompanyName": { "type": [ "string", "null" ], "default": null }, "Email": { "type": "string" }, "FirstName": { "type": [ "string", "null" ], "default": null }, "LastName": { "type": [ "string", "null" ], "default": null }, "Password": { "description": "Set as the account's PERMANENT Cognito password immediately \u2014 the caller\n (an admin tool) decides it; there is no invite/accept step here.", "type": "string" } }, "required": [ "Email", "Password" ] }, "NetworkWithdrawResponse": { "description": "Response for a completed withdrawal.", "type": "object", "properties": { "PreviousNetworkId": { "description": "The network the workspace was withdrawn from, or `null` when it was not\n in a network (an idempotent no-op withdrawal).", "type": [ "string", "null" ] }, "Success": { "type": "boolean" }, "WorkspaceId": { "description": "The workspace that was withdrawn (always the caller's own).", "type": "string" } }, "required": [ "Success", "WorkspaceId" ] }, "NetworkWorkspaceCreate": { "description": "Create an additional workspace under an EXISTING organization in the caller's\n network (PRO-4189). The workspace inherits the org's `NetworkId` +\n `OrganizationId`. The target org MUST already belong to the caller's network;\n a cross-network `OrganizationId` is rejected (no cross-network leakage).", "type": "object", "properties": { "Email": { "type": "string" }, "FirstName": { "type": [ "string", "null" ], "default": null }, "LastName": { "type": [ "string", "null" ], "default": null }, "OrganizationId": { "type": "string" } }, "required": [ "OrganizationId", "Email" ] }, "OwnerAcceptRequest": { "description": "Owner-accept request body (PRO-4680). PascalCase to match every other XYPN\n model and the frontend wire convention.", "type": "object", "properties": { "Password": { "description": "The owner's chosen password. SECRET \u2014 never logged or echoed.", "type": "string" }, "Token": { "description": "The single-use owner invite token from the welcome-email link. SECRET.", "type": "string" } }, "required": [ "Token", "Password" ] }, "OwnerAcceptResponse": { "description": "Owner-accept response (PRO-4680): on success the owner can now sign in. The\n `email` is the owner's own address (resolved from their profile), returned so\n the welcome page can auto-sign-in with `(email, the password just set)`. This\n is not a leak: the caller possesses the single-use token and just set this\n account's password \u2014 it is their own email. `None` when the profile read\n could not surface an email (the accept still succeeded); the client falls\n back to the manual sign-in redirect.", "type": "object", "properties": { "Email": { "type": [ "string", "null" ] }, "Success": { "type": "boolean" } }, "required": [ "Success" ] }, "Paginated_for_ArchivingRule": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivingRule" } } }, "required": [ "meta", "records" ] }, "Paginated_for_ArchivingRuleSuppression": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/ArchivingRuleSuppression" } } }, "required": [ "meta", "records" ] }, "Paginated_for_Network": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/Network" } } }, "required": [ "meta", "records" ] }, "Paginated_for_Organization": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/Organization" } } }, "required": [ "meta", "records" ] }, "Paginated_for_TeamMemberExtra": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/TeamMemberExtra" } } }, "required": [ "meta", "records" ] }, "Paginated_for_UserProfile": { "type": "object", "properties": { "meta": { "$ref": "#/components/schemas/Meta" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/UserProfile" } } }, "required": [ "meta", "records" ] }, "TeamMemberInviteResult": { "description": "One member's invite result.", "type": "object", "properties": { "Detail": { "description": "Optional human-readable detail (e.g. the failure reason). Never echoes\n secrets or the configured network id.", "type": [ "string", "null" ] }, "Email": { "type": "string" }, "Status": { "$ref": "#/components/schemas/TeamMemberInviteStatus" } }, "required": [ "Email", "Status" ] }, "TeamMemberInviteStatus": { "description": "Per-team-member outcome of the XYPN bootstrap invite (PRO-4519).\n\n The team-member invite loop is BEST-EFFORT and fail-soft: each member is\n provisioned independently and a failure on one neither aborts the others nor\n the (already-completed) owner provisioning. The status records what happened\n so callers/ops can see partial failures.", "oneOf": [ { "description": "Fully provisioned: Cognito user created (or reused), the `AUTHID` lookup\n written, and the branded invite email sent.", "type": "string", "const": "Invited" }, { "description": "Already invited on a prior run (a TEAMMEMBER record exists for this\n email). Skipped \u2014 no duplicate Cognito user, `AUTHID`, or email.", "type": "string", "const": "AlreadyInvited" }, { "description": "Provisioning failed before the TEAMMEMBER record was written (Cognito\n create / group / attribute / DynamoDB write). No record exists, so a\n retry re-attempts this member (Cognito create is idempotent).", "type": "string", "const": "InviteFailed" }, { "description": "The member was fully provisioned (Cognito user + `AUTHID` record exist,\n so `/join` acceptance works) but the invite email failed to send. The\n record exists, so a retry treats the member as `AlreadyInvited` and does\n NOT auto-resend \u2014 re-invite via the authenticated team-member flow. This\n is the accepted best-effort boundary for the non-transactional email.", "type": "string", "const": "EmailFailed" } ] }, "TeamMemberParams": { "type": "object", "properties": { "isActive": { "type": [ "boolean", "null" ] } } }, "Tier": { "description": "The tier a config record belongs to. Drives which entity partition the record\n is keyed under (see [`crate::data::feature_configs`]).", "type": "string", "enum": [ "network", "organization", "workspace" ] }, "WorkspaceAnnouncementResolution": { "description": "The `GET /announcements/recording/resolve/{workspaceId}` response: the\n resolved workspace-level config, ready for a lower tier (an inbox, in\n cc-api-outbounds / cc-rust-api-outbounds) to merge one level further.", "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Locked": { "description": "True when the network LOCKED its setting: the caller (a lower tier \u2014\n workspace here, or inbox one level further up the call chain) MUST use\n `enabled`/`prompt_ref` as-is and may not override them.", "type": "boolean" }, "PromptRef": { "type": [ "string", "null" ] }, "Source": { "$ref": "#/components/schemas/AnnouncementSource" }, "WorkspaceId": { "type": "string" } }, "required": [ "WorkspaceId", "Enabled", "Source", "Locked" ] }, "XypnJoinResponse": { "description": "Response for a completed XYPN signup. The owner is always fully provisioned\n (or the call fails); `team_members` reports each invite's outcome.", "type": "object", "properties": { "Success": { "type": "boolean" }, "TeamMembers": { "description": "Per-team-member invite outcome for THIS call. **Always empty on a\n resend** \u2014 a repeat submission for an owner who was already fully\n provisioned by an earlier call but has not yet accepted their invite\n (PRO-6781) re-sends only the owner's own welcome email and\n deliberately does not touch team members (see\n `XypnSignupService::resend_owner_invite`: an unauthenticated retry\n re-running the invite loop against this call's body would let anyone\n who merely knows a pending owner's email provision Cognito users into\n that owner's org). An empty list here does not mean the ORIGINAL\n invites failed \u2014 do not render it as an error on a resend.", "type": "array", "items": { "$ref": "#/components/schemas/TeamMemberInviteResult" } } }, "required": [ "Success", "TeamMembers" ] }, "XypnMembershipReconcileInput": { "description": "Reconcile `IsXypnMember` for every team member across a network against a\n caller-supplied roster of member emails (PRO-5622).\n\n This exists because the network-enroll (transfer) flow \u2014 how most existing\n firms, including long-established ones, actually join a network \u2014 never\n touches `TeamMember` records at all, and there is no other automated signal\n for XYPN membership in the system (the only precedent is a manual, offline\n CSV-vs-database comparison script). This endpoint is the write side: given\n the current roster, it is idempotent and safe to re-run on every refresh \u2014\n an email match sets `true`, everything else in the network sets `false`, so\n a lapsed member correctly flips back off on the next run.", "type": "object", "properties": { "Emails": { "description": "Member emails from the XYPN roster. Matched case-insensitively against\n each team member's stored email.", "type": "array", "items": { "type": "string" } } }, "required": [ "Emails" ] }, "XypnMembershipReconcileResult": { "description": "Summary of a completed reconciliation run.", "type": "object", "properties": { "Matched": { "description": "Members whose email matched the roster (regardless of whether a write\n was actually needed).", "type": "integer", "format": "uint", "minimum": 0 }, "MembersScanned": { "type": "integer", "format": "uint", "minimum": 0 }, "Updated": { "description": "Members whose stored `IsXypnMember` changed this run.", "type": "integer", "format": "uint", "minimum": 0 }, "WorkspacesScanned": { "type": "integer", "format": "uint", "minimum": 0 } }, "required": [ "WorkspacesScanned", "MembersScanned", "Matched", "Updated" ] }, "XypnSignup": { "description": "The XYPN signup body. NEW-ACCOUNTS-ONLY: there is no caller-supplied Cognito\n id \u2014 the service creates the owner account keyed on `Email`. The network the\n workspace joins is NOT taken from the body either; it is the configured XYPN\n network.", "type": "object", "properties": { "AddOnNames": { "type": "array", "default": [], "items": { "type": "string" } }, "AddOnPriceIds": { "type": "array", "default": [], "items": { "type": "string" } }, "AddOnProductIds": { "type": "array", "default": [], "items": { "type": "string" } }, "BillingInterval": { "type": [ "string", "null" ] }, "CompanyName": { "type": [ "string", "null" ] }, "Email": { "description": "The workspace owner's email. The service creates the owner Cognito account\n keyed on this address; an email that already has an account is rejected\n toward the authenticated enroll flow.", "type": "string" }, "FirstName": { "type": [ "string", "null" ] }, "LastName": { "type": [ "string", "null" ] }, "PlanName": { "type": [ "string", "null" ] }, "PlanPriceId": { "type": [ "string", "null" ] }, "PlanProductId": { "type": [ "string", "null" ] }, "Quantity": { "type": [ "integer", "null" ], "format": "int64" }, "SourceAttribution": { "description": "Always `\"xypn\"` from the frontend; stored on the owner profile.", "type": "string" }, "TeamMembers": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/XypnTeamMember" } } }, "required": [ "Email", "SourceAttribution" ] }, "XypnTeamMember": { "description": "A team member to provision alongside the workspace owner. Mirrors the\n frontend `IXypnTeamMember`. Only an invited record is written here \u2014 the\n member's Cognito user is created later, when they accept the invite.", "type": "object", "properties": { "Email": { "type": "string" }, "FirstName": { "type": [ "string", "null" ] }, "IsXypnMember": { "description": "Whether this seat is a discounted XYPN member seat (PRO-4521).", "type": [ "boolean", "null" ] }, "LastName": { "type": [ "string", "null" ] } }, "required": [ "Email" ] } } }, "tags": [ { "name": "contacts" } ], "servers": [ { "url": "https://api.currentclient.com", "description": "Production" }, { "url": "https://api.currentclient.io", "description": "Development" } ] }