> For the complete documentation index, see [llms.txt](https://tsanet.gitbook.io/connect/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tsanet.gitbook.io/connect/api-reference/models.md).

# Models

## The AttachmentConfigDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"AttachmentConfigDTO":{"type":"object","properties":{"submitter":{"$ref":"#/components/schemas/CompanyAttachmentConfigDTO"},"receiver":{"$ref":"#/components/schemas/CompanyAttachmentConfigDTO"}}},"CompanyAttachmentConfigDTO":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64"},"parameters":{"type":"object","additionalProperties":{"type":"object"}}}}}}}
```

## The CompanyAttachmentConfigDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CompanyAttachmentConfigDTO":{"type":"object","properties":{"companyId":{"type":"integer","format":"int64"},"parameters":{"type":"object","additionalProperties":{"type":"object"}}}}}}}
```

## The ErrorResponse object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The ValidationError object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"ValidationError":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}}}
```

## The NormalizedHttpsAttachmentConfigDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"NormalizedHttpsAttachmentConfigDTO":{"required":["domain","expiration","httpsPath","httpsPort","password"],"type":"object","properties":{"domain":{"type":"string"},"password":{"type":"string"},"expiration":{"type":"string","format":"date-time"},"httpsPath":{"type":"string"},"httpsPort":{"type":"integer","format":"int32"}}}}}}
```

## The WebhookSubscriptionV2ResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookSubscriptionV2ResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"callbackUrl":{"type":"string"},"eventTypes":{"type":"array","items":{"type":"string","enum":["org.tsanet.connect.collaboration-request.created","org.tsanet.connect.collaboration-request.closed","org.tsanet.connect.collaboration-request.note.created","org.tsanet.connect.collaboration-request.response.created","org.tsanet.connect.collaboration-request.response.updated"]}},"active":{"type":"boolean"},"secret":{"type":"string","description":"HMAC secret for signing webhooks (only returned on creation — use POST /v1/webhooks/{id}/secret to rotate)"},"callbackAuthType":{"type":"string","description":"The authentication type configured for this subscription. Credential values are never returned."},"createdAt":{"type":"string","format":"date-time"}}}}}}
```

## The CreateWebhookSubscriptionV2RequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CreateWebhookSubscriptionV2RequestDTO":{"required":["callbackUrl"],"type":"object","properties":{"callbackUrl":{"type":"string","description":"The URL to receive webhook events. Must be accessible via HTTPS in production.","format":"uri"},"eventTypes":{"type":"array","description":"Optional list of CloudEvent type strings to subscribe to. If empty or null, all 5 event types are delivered. Values must match `WebhookEventTypeV2` exactly. ","items":{"type":"string","description":"Optional list of CloudEvent type strings to subscribe to. If empty or null, all 5 event types are delivered. Values must match `WebhookEventTypeV2` exactly. ","enum":["org.tsanet.connect.collaboration-request.created","org.tsanet.connect.collaboration-request.closed","org.tsanet.connect.collaboration-request.note.created","org.tsanet.connect.collaboration-request.response.created","org.tsanet.connect.collaboration-request.response.updated"]}},"callbackAuth":{"$ref":"#/components/schemas/WebhookCallbackAuthDTO"}}},"WebhookCallbackAuthDTO":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","BASIC","BEARER","HEADER"]},"username":{"type":"string","description":"Required when type is BASIC."},"password":{"type":"string","description":"Required when type is BASIC."},"token":{"type":"string","description":"Required when type is BEARER."},"headerName":{"type":"string","description":"Required when type is HEADER. The name of the custom header to send."},"headerValue":{"type":"string","description":"Required when type is HEADER. The value of the custom header to send."}}}}}}
```

## The WebhookCallbackAuthDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookCallbackAuthDTO":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","BASIC","BEARER","HEADER"]},"username":{"type":"string","description":"Required when type is BASIC."},"password":{"type":"string","description":"Required when type is BASIC."},"token":{"type":"string","description":"Required when type is BEARER."},"headerName":{"type":"string","description":"Required when type is HEADER. The name of the custom header to send."},"headerValue":{"type":"string","description":"Required when type is HEADER. The value of the custom header to send."}}}}}}
```

## The WebhookSubscriptionResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookSubscriptionResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"callbackUrl":{"type":"string"},"eventTypes":{"type":"array","items":{"type":"string","enum":["collaboration-request.created","note.created"]}},"payloadVersion":{"type":"string","enum":["V1","V2"]},"active":{"type":"boolean"},"secret":{"type":"string","description":"HMAC secret for signing webhooks (only returned on creation — use POST /v1/webhooks/{id}/secret to rotate)"},"callbackAuthType":{"type":"string","description":"The authentication type configured for this subscription. Credential values are never returned."},"createdAt":{"type":"string","format":"date-time"}}}}}}
```

## The CreateWebhookSubscriptionRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CreateWebhookSubscriptionRequestDTO":{"required":["callbackUrl"],"type":"object","properties":{"callbackUrl":{"type":"string","description":"The URL to receive webhook events. Must be accessible via HTTPS in production.","format":"uri"},"eventTypes":{"type":"array","description":"Optional list of V1 event types to subscribe to. If empty or null, both `collaboration-request.created` and `note.created` are delivered. ","items":{"type":"string","description":"Optional list of V1 event types to subscribe to. If empty or null, both `collaboration-request.created` and `note.created` are delivered. ","enum":["collaboration-request.created","note.created"]}},"callbackAuth":{"$ref":"#/components/schemas/WebhookCallbackAuthDTO"}}},"WebhookCallbackAuthDTO":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["NONE","BASIC","BEARER","HEADER"]},"username":{"type":"string","description":"Required when type is BASIC."},"password":{"type":"string","description":"Required when type is BASIC."},"token":{"type":"string","description":"Required when type is BEARER."},"headerName":{"type":"string","description":"Required when type is HEADER. The name of the custom header to send."},"headerValue":{"type":"string","description":"Required when type is HEADER. The value of the custom header to send."}}}}}}
```

## The WebhookSecretRotationResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookSecretRotationResponseDTO":{"type":"object","properties":{"id":{"type":"integer","description":"Webhook subscription ID","format":"int64"},"secret":{"type":"string","description":"New HMAC-SHA256 signing secret. This value is only returned once. Store it immediately — it cannot be retrieved again. "},"rotatedAt":{"type":"string","description":"Timestamp when the secret was rotated","format":"date-time"}}}}}}
```

## The TokenDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"TokenDTO":{"type":"object","properties":{"accessToken":{"type":"string","description":"JWT access token"},"tokenType":{"type":"string"},"expiresIn":{"type":"integer","format":"int32"}}}}}}
```

## The LoginRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"LoginRequestDTO":{"required":["password","username"],"type":"object","properties":{"username":{"type":"string","description":"Username for authentication"},"password":{"type":"string","description":"Password for authentication"}}}}}}
```

## The CaseCustomFieldStatusDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}}}}}
```

## The CaseNoteDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}
```

## The CaseResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}
```

## The CollaborationRequestStatusDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CollaborationRequestStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"submitCompanyName":{"type":"string"},"submitCompanyId":{"type":"integer","format":"int64"},"submitterCaseNumber":{"type":"string"},"receiveCompanyName":{"type":"string"},"receiveCompanyId":{"type":"integer","format":"int64"},"receiverCaseNumber":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string","enum":["OUTBOUND","INBOUND"]},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"respondBy":{"type":"string","format":"date-time"},"feedbackRequested":{"type":"boolean"},"reminderSent":{"type":"boolean"},"priorityNote":{"type":"string"},"escalationInstructions":{"type":"string"},"contactDocumentId":{"type":"integer","description":"ID of the contact document used to create this case","format":"int64"},"contactDocumentName":{"type":"string","description":"Name of the contact document used to create this case"},"testCase":{"type":"boolean"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseCustomFieldStatusDTO"}},"submittedBy":{"$ref":"#/components/schemas/UserDTO"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"receiverContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"caseNotes":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}},"caseResponses":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponseDTO"}}}},"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}
```

## The ContactDetailsDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}}}}}
```

## The UserDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}}}}}
```

## The CollaborationRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CollaborationRequestDTO":{"required":["customFields","documentId","internalCaseNumber","internalNotes","priority","problemDescription","problemSummary","testSubmission"],"type":"object","properties":{"documentId":{"type":"integer","format":"int64"},"internalCaseNumber":{"type":"string"},"receiverInternalCaseNumber":{"type":"string"},"problemSummary":{"type":"string"},"problemDescription":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"adminNote":{"type":"string"},"escalationInstructions":{"type":"string"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/FieldMetadataDTO"}},"internalNotes":{"type":"array","items":{"$ref":"#/components/schemas/InternalNoteDTO"}},"testSubmission":{"type":"boolean"}}},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"FieldMetadataDTO":{"required":["displayOrder","fieldId","label","required","section","type"],"type":"object","properties":{"fieldId":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"label":{"type":"string"},"options":{"type":"string"},"additionalSettings":{"type":"string"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]},"displayOrder":{"type":"integer","format":"int32"},"validationRules":{"type":"string"},"value":{"type":"string"},"selections":{"type":"array","items":{"$ref":"#/components/schemas/SelectionDTO"}},"required":{"type":"boolean"}}},"SelectionDTO":{"type":"object","properties":{"value":{"type":"string"},"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SelectionDTO"}}}},"InternalNoteDTO":{"type":"object","properties":{"note":{"type":"string"}}}}}}
```

## The FieldMetadataDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"FieldMetadataDTO":{"required":["displayOrder","fieldId","label","required","section","type"],"type":"object","properties":{"fieldId":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"label":{"type":"string"},"options":{"type":"string"},"additionalSettings":{"type":"string"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]},"displayOrder":{"type":"integer","format":"int32"},"validationRules":{"type":"string"},"value":{"type":"string"},"selections":{"type":"array","items":{"$ref":"#/components/schemas/SelectionDTO"}},"required":{"type":"boolean"}}},"SelectionDTO":{"type":"object","properties":{"value":{"type":"string"},"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SelectionDTO"}}}}}}}
```

## The InternalNoteDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"InternalNoteDTO":{"type":"object","properties":{"note":{"type":"string"}}}}}}
```

## The SelectionDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"SelectionDTO":{"type":"object","properties":{"value":{"type":"string"},"children":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/SelectionDTO"}}}}}}}
```

## The CaseRejectionDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseRejectionDTO":{"required":["engineerEmail","engineerName","reason"],"type":"object","properties":{"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"reason":{"type":"string"}}}}}}
```

## The CaseNoteTemplateDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseNoteTemplateDTO":{"required":["description","priority","summary"],"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"submittedBy":{"$ref":"#/components/schemas/UserDTO"}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}}}}}
```

## The CaseInformationResponseDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseInformationResponseDTO":{"required":["requestedInformation"],"type":"object","properties":{"requestedInformation":{"type":"string"}}}}}}
```

## The CaseInformationRequestDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseInformationRequestDTO":{"required":["engineerEmail","engineerName","requestedInformation"],"type":"object","properties":{"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"requestedInformation":{"type":"string"}}}}}}
```

## The AttachmentForwardResultDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"AttachmentForwardResultDTO":{"type":"object","properties":{"fileName":{"type":"string"},"receiverStatus":{"type":"string","enum":["SUCCESS","CONFIG_MISSING","CONFIG_INVALID","FORWARD_FAILED","CONTENT_ERROR","UNKNOWN"]},"receiverMessage":{"type":"string"},"submitterStatus":{"type":"string","enum":["SUCCESS","CONFIG_MISSING","CONFIG_INVALID","FORWARD_FAILED","CONTENT_ERROR","UNKNOWN"]},"submitterMessage":{"type":"string"},"completeSuccess":{"type":"boolean"},"partialSuccess":{"type":"boolean"}}}}}}
```

## The CaseApprovalDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseApprovalDTO":{"required":["caseNumber","engineerEmail","engineerName","nextSteps"],"type":"object","properties":{"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"}}}}}}
```

## The CollaborationRequestSubmitterUpdateDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CollaborationRequestSubmitterUpdateDTO":{"type":"object","properties":{"internalCaseNumber":{"$ref":"#/components/schemas/JsonNullableString"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"}}},"JsonNullableString":{"type":"object","properties":{"present":{"type":"boolean"}},"description":"Internal case number for the submitter's tracking system"},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}}}}}
```

## The JsonNullableString object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"JsonNullableString":{"type":"object","properties":{"present":{"type":"boolean"}},"description":"Internal case number for the submitter's tracking system"}}}}
```

## The CaseApprovalUpdateDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CaseApprovalUpdateDTO":{"type":"object","properties":{"caseNumber":{"$ref":"#/components/schemas/JsonNullableString"},"engineerName":{"$ref":"#/components/schemas/JsonNullableString"},"engineerPhone":{"$ref":"#/components/schemas/JsonNullableString"},"engineerEmail":{"$ref":"#/components/schemas/JsonNullableString"},"nextSteps":{"$ref":"#/components/schemas/JsonNullableString"}}},"JsonNullableString":{"type":"object","properties":{"present":{"type":"boolean"}},"description":"Internal case number for the submitter's tracking system"}}}}
```

## The WebhookSubscriptionV2DTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookSubscriptionV2DTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"callbackUrl":{"type":"string"},"eventTypes":{"type":"array","items":{"type":"string","enum":["org.tsanet.connect.collaboration-request.created","org.tsanet.connect.collaboration-request.closed","org.tsanet.connect.collaboration-request.note.created","org.tsanet.connect.collaboration-request.response.created","org.tsanet.connect.collaboration-request.response.updated"]}},"active":{"type":"boolean"},"callbackAuthType":{"type":"string","description":"The authentication type configured for this subscription. Credential values are never returned."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}
```

## The PagedResponse object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"PagedResponse":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/CollaborationRequestStatusDTO"}},"number":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"first":{"type":"boolean"},"last":{"type":"boolean"}}},"CollaborationRequestStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"submitCompanyName":{"type":"string"},"submitCompanyId":{"type":"integer","format":"int64"},"submitterCaseNumber":{"type":"string"},"receiveCompanyName":{"type":"string"},"receiveCompanyId":{"type":"integer","format":"int64"},"receiverCaseNumber":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"direction":{"type":"string","enum":["OUTBOUND","INBOUND"]},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["OPEN","INFORMATION","REJECTED","ACCEPTED","CLOSED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"deletedAt":{"type":"string","format":"date-time"},"responded":{"type":"boolean"},"respondBy":{"type":"string","format":"date-time"},"feedbackRequested":{"type":"boolean"},"reminderSent":{"type":"boolean"},"priorityNote":{"type":"string"},"escalationInstructions":{"type":"string"},"contactDocumentId":{"type":"integer","description":"ID of the contact document used to create this case","format":"int64"},"contactDocumentName":{"type":"string","description":"Name of the contact document used to create this case"},"testCase":{"type":"boolean"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CaseCustomFieldStatusDTO"}},"submittedBy":{"$ref":"#/components/schemas/UserDTO"},"submitterContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"receiverContactDetails":{"$ref":"#/components/schemas/ContactDetailsDTO"},"caseNotes":{"type":"array","items":{"$ref":"#/components/schemas/CaseNoteDTO"}},"caseResponses":{"type":"array","items":{"$ref":"#/components/schemas/CaseResponseDTO"}}}},"CaseCustomFieldStatusDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"section":{"type":"string","enum":["CONTACT_SECTION","COMMON_CUSTOMER_SECTION","PROBLEM_SECTION"]},"fieldName":{"type":"string"},"value":{"type":"string"},"displayOrder":{"type":"integer","format":"int32"},"type":{"type":"string","enum":["STRING","INTEGER","EMAIL","PHONE","URL","TEXT","HIDDEN","CUSTOM","SELECT","TIERSELECT","GROUPSELECT","COPY","DB_SELECT","TIMEZONE"]}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}},"ContactDetailsDTO":{"required":["email","name","phone"],"type":"object","properties":{"name":{"type":"string","description":"Full name of the contact"},"email":{"type":"string","description":"Email address of the contact"},"phone":{"type":"string","description":"Phone number of the contact"}}},"CaseNoteDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"caseId":{"type":"integer","format":"int64"},"companyName":{"type":"string"},"creatorUsername":{"type":"string"},"creatorEmail":{"type":"string"},"creatorName":{"type":"string"},"summary":{"type":"string"},"description":{"type":"string"},"priority":{"type":"string","enum":["LOW","MEDIUM","HIGH"]},"status":{"type":"string","enum":["ENTERED","READ","RESPONDED","REMOVED"]},"token":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}},"CaseResponseDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["APPROVAL","INFORMATION_REQUEST","INFORMATION_RESPONSE","REJECTION"]},"caseNumber":{"type":"string"},"engineerName":{"type":"string"},"engineerPhone":{"type":"string"},"engineerEmail":{"type":"string"},"nextSteps":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}
```

## The ProblemDetail object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"ProblemDetail":{"type":"object","properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer","format":"int32"},"detail":{"type":"string"},"instance":{"type":"string","format":"uri"}}}}}}
```

## The WebhookSubscriptionDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookSubscriptionDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"callbackUrl":{"type":"string"},"eventTypes":{"type":"array","items":{"type":"string","enum":["collaboration-request.created","note.created"]}},"payloadVersion":{"type":"string","enum":["V1","V2"]},"active":{"type":"boolean"},"callbackAuthType":{"type":"string","description":"The authentication type configured for this subscription. Credential values are never returned."},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}}}}}}
```

## The WebhookDeliveryLogDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookDeliveryLogDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"cloudEventId":{"type":"string"},"eventType":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"attemptNumber":{"type":"integer","format":"int32"},"success":{"type":"boolean"},"requestBody":{"type":"string"},"responseBody":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}
```

## The WebhookDeliveryLogPageDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"WebhookDeliveryLogPageDTO":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDeliveryLogDTO"}},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"number":{"type":"integer","format":"int32"}}},"WebhookDeliveryLogDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"cloudEventId":{"type":"string"},"eventType":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"attemptNumber":{"type":"integer","format":"int32"},"success":{"type":"boolean"},"requestBody":{"type":"string"},"responseBody":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}
```

## The PartnerSelectionDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"PartnerSelectionDTO":{"type":"object","properties":{"label":{"type":"string"},"companyName":{"type":"string"},"departmentName":{"type":"string"},"companyId":{"type":"integer","format":"int64"},"departmentId":{"type":"integer","format":"int64"},"documentId":{"type":"integer","format":"int64"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/TagDTO"}}}},"TagDTO":{"type":"object","properties":{"tag":{"type":"string"}}}}}}
```

## The TagDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"TagDTO":{"type":"object","properties":{"tag":{"type":"string"}}}}}}
```

## The CompanyDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"CompanyDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"domain":{"type":"string"}}}}}}
```

## The UserContextDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"UserContextDTO":{"type":"object","properties":{"company":{"$ref":"#/components/schemas/CompanyDTO"},"user":{"$ref":"#/components/schemas/UserDTO"}}},"CompanyDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"domain":{"type":"string"}}},"UserDTO":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"username":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"phoneCountryCode":{"type":"string"},"city":{"type":"string"},"emailCheckFailData":{"type":"string"}}}}}}
```

## The HealthDTO object

```json
{"openapi":"3.0.1","info":{"title":"OpenAPI definition","version":"v0"},"components":{"schemas":{"HealthDTO":{"type":"object","properties":{"status":{"type":"string"}}}}}}
```
