{ "openapi": "3.1.0", "info": { "title": "Voyant Operator API", "version": "0.0.0", "description": "Generated from the composed operator app. Do not edit by hand." }, "servers": [ { "url": "/", "description": "This deployment (same origin)" } ], "components": { "schemas": { "CatalogSearchFilter": { "anyOf": [ { "type": "object", "properties": { "kind": { "type": "string", "enum": ["eq"] }, "field": { "type": "string", "minLength": 1 }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } }, "required": ["kind", "field", "value"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["in"] }, "field": { "type": "string", "minLength": 1 }, "values": { "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "number" } ] } } }, "required": ["kind", "field", "values"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["range"] }, "field": { "type": "string", "minLength": 1 }, "gte": { "type": "number" }, "lte": { "type": "number" } }, "required": ["kind", "field"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["and"] }, "clauses": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSearchFilter" } } }, "required": ["kind", "clauses"] }, { "type": "object", "properties": { "kind": { "type": "string", "enum": ["or"] }, "clauses": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSearchFilter" } } }, "required": ["kind", "clauses"] } ] } }, "parameters": {} }, "paths": { "/v1/admin/relationships/organizations": { "get": { "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "ownerId", "in": "query" }, { "schema": { "type": "string", "enum": ["client", "partner", "supplier", "other"] }, "required": false, "name": "relation", "in": "query" }, { "schema": { "type": "string", "enum": ["active", "inactive", "archived"] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "search", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "taxId", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "tax_id", "in": "query" }, { "schema": { "type": "string", "enum": ["name", "industry", "relation", "status", "createdAt", "updatedAt"], "default": "updatedAt" }, "required": false, "name": "sortBy", "in": "query" }, { "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" }, "required": false, "name": "sortDir", "in": "query" } ], "responses": { "200": { "description": "Paginated list of organizations", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] }, "taxId": { "type": ["string", "null"] }, "industry": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "ownerId": { "type": ["string", "null"] }, "defaultCurrency": { "type": ["string", "null"] }, "preferredLanguage": { "type": ["string", "null"] }, "paymentTerms": { "type": ["integer", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "notes": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] } }, "required": [ "id", "name", "legalName", "website", "taxId", "industry", "relation", "ownerId", "defaultCurrency", "preferredLanguage", "paymentTerms", "status", "source", "sourceRef", "tags", "customFields", "notes", "createdAt", "updatedAt", "archivedAt" ] } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": ["data", "total", "limit", "offset"] } } } } }, "operationId": "getAdminRelationshipsOrganizations", "summary": "GET /v1/admin/relationships/organizations", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "legalName": { "type": ["string", "null"] }, "website": { "anyOf": [ { "type": ["string", "null"], "format": "uri" }, { "type": "string", "enum": [""] }, { "type": "null" } ] }, "taxId": { "type": ["string", "null"] }, "industry": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "ownerId": { "type": ["string", "null"] }, "defaultCurrency": { "type": ["string", "null"], "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$" }, "preferredLanguage": { "type": ["string", "null"] }, "paymentTerms": { "type": ["integer", "null"], "exclusiveMinimum": 0, "maximum": 365 }, "status": { "type": "string", "enum": ["active", "inactive", "archived"], "default": "active" }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] }, "customFields": { "type": "object", "additionalProperties": {} }, "notes": { "type": ["string", "null"] } }, "required": ["name"] } } } }, "responses": { "201": { "description": "The created organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] }, "taxId": { "type": ["string", "null"] }, "industry": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "ownerId": { "type": ["string", "null"] }, "defaultCurrency": { "type": ["string", "null"] }, "preferredLanguage": { "type": ["string", "null"] }, "paymentTerms": { "type": ["integer", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "notes": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] } }, "required": [ "id", "name", "legalName", "website", "taxId", "industry", "relation", "ownerId", "defaultCurrency", "preferredLanguage", "paymentTerms", "status", "source", "sourceRef", "tags", "customFields", "notes", "createdAt", "updatedAt", "archivedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsOrganizations", "summary": "POST /v1/admin/relationships/organizations", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/organizations/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "An organization by id", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] }, "taxId": { "type": ["string", "null"] }, "industry": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "ownerId": { "type": ["string", "null"] }, "defaultCurrency": { "type": ["string", "null"] }, "preferredLanguage": { "type": ["string", "null"] }, "paymentTerms": { "type": ["integer", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "notes": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] } }, "required": [ "id", "name", "legalName", "website", "taxId", "industry", "relation", "ownerId", "defaultCurrency", "preferredLanguage", "paymentTerms", "status", "source", "sourceRef", "tags", "customFields", "notes", "createdAt", "updatedAt", "archivedAt" ] } }, "required": ["data"] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsOrganizationsById", "summary": "GET /v1/admin/relationships/organizations/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "legalName": { "type": ["string", "null"] }, "website": { "anyOf": [ { "type": ["string", "null"], "format": "uri" }, { "type": "string", "enum": [""] }, { "type": "null" } ] }, "taxId": { "type": ["string", "null"] }, "industry": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "ownerId": { "type": ["string", "null"] }, "defaultCurrency": { "type": ["string", "null"], "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$" }, "preferredLanguage": { "type": ["string", "null"] }, "paymentTerms": { "type": ["integer", "null"], "exclusiveMinimum": 0, "maximum": 365 }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "notes": { "type": ["string", "null"] } } } } } }, "responses": { "200": { "description": "The updated organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] }, "taxId": { "type": ["string", "null"] }, "industry": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "ownerId": { "type": ["string", "null"] }, "defaultCurrency": { "type": ["string", "null"] }, "preferredLanguage": { "type": ["string", "null"] }, "paymentTerms": { "type": ["integer", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "notes": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] } }, "required": [ "id", "name", "legalName", "website", "taxId", "industry", "relation", "ownerId", "defaultCurrency", "preferredLanguage", "paymentTerms", "status", "source", "sourceRef", "tags", "customFields", "notes", "createdAt", "updatedAt", "archivedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsOrganizationsById", "summary": "PATCH /v1/admin/relationships/organizations/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Organization deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "409": { "description": "Organization has linked people", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsOrganizationsById", "summary": "DELETE /v1/admin/relationships/organizations/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/organizations/{id}/merge": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mergeId": { "type": "string", "minLength": 1 } }, "required": ["mergeId"] } } } }, "responses": { "200": { "description": "The surviving organization after merge", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] }, "taxId": { "type": ["string", "null"] }, "industry": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "ownerId": { "type": ["string", "null"] }, "defaultCurrency": { "type": ["string", "null"] }, "preferredLanguage": { "type": ["string", "null"] }, "paymentTerms": { "type": ["integer", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "notes": { "type": ["string", "null"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] } }, "required": [ "id", "name", "legalName", "website", "taxId", "industry", "relation", "ownerId", "defaultCurrency", "preferredLanguage", "paymentTerms", "status", "source", "sourceRef", "tags", "customFields", "notes", "createdAt", "updatedAt", "archivedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsOrganizationsByIdMerge", "summary": "POST /v1/admin/relationships/organizations/{id}/merge", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/organizations/{id}/contact-methods": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Contact methods for the organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": ["string", "null"] }, "value": { "type": "string" }, "normalizedValue": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "kind", "label", "value", "normalizedValue", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsOrganizationsByIdContactMethods", "summary": "GET /v1/admin/relationships/organizations/{id}/contact-methods", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "email", "phone", "mobile", "whatsapp", "website", "sms", "fax", "social", "other" ] }, "label": { "type": ["string", "null"], "maxLength": 100 }, "value": { "type": "string", "minLength": 1, "maxLength": 500 }, "normalizedValue": { "type": ["string", "null"], "maxLength": 500 }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } }, "required": ["kind", "value"] } } } }, "responses": { "201": { "description": "The created contact method", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": ["string", "null"] }, "value": { "type": "string" }, "normalizedValue": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "kind", "label", "value", "normalizedValue", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsOrganizationsByIdContactMethods", "summary": "POST /v1/admin/relationships/organizations/{id}/contact-methods", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/organizations/{id}/addresses": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Addresses for the organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "label": { "type": "string" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "label", "fullText", "line1", "line2", "city", "region", "postalCode", "country", "latitude", "longitude", "timezone", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsOrganizationsByIdAddresses", "summary": "GET /v1/admin/relationships/organizations/{id}/addresses", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "enum": [ "primary", "billing", "shipping", "mailing", "meeting", "service", "legal", "other" ], "default": "other" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"], "maxLength": 100 }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "201": { "description": "The created address", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "label": { "type": "string" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "label", "fullText", "line1", "line2", "city", "region", "postalCode", "country", "latitude", "longitude", "timezone", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsOrganizationsByIdAddresses", "summary": "POST /v1/admin/relationships/organizations/{id}/addresses", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/organizations/{id}/notes": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Notes for the organization", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "authorId": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": ["id", "organizationId", "authorId", "content", "createdAt"] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsOrganizationsByIdNotes", "summary": "GET /v1/admin/relationships/organizations/{id}/notes", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": ["content"] } } } }, "responses": { "201": { "description": "The created organization note", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "authorId": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": ["id", "organizationId", "authorId", "content", "createdAt"] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Organization not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsOrganizationsByIdNotes", "summary": "POST /v1/admin/relationships/organizations/{id}/notes", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/organization-notes/{id}": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": ["content"] } } } }, "responses": { "200": { "description": "The updated organization note", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "authorId": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": ["id", "organizationId", "authorId", "content", "createdAt"] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Note not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsOrganizationNotesById", "summary": "PATCH /v1/admin/relationships/organization-notes/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Note deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Note not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsOrganizationNotesById", "summary": "DELETE /v1/admin/relationships/organization-notes/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people": { "get": { "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "organizationId", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "ownerId", "in": "query" }, { "schema": { "type": "string", "enum": ["client", "partner", "supplier", "other"] }, "required": false, "name": "relation", "in": "query" }, { "schema": { "type": "string", "enum": ["active", "inactive", "archived"] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "search", "in": "query" }, { "schema": { "type": "string", "enum": ["name", "relation", "status", "createdAt", "updatedAt"], "default": "updatedAt" }, "required": false, "name": "sortBy", "in": "query" }, { "schema": { "type": "string", "enum": ["asc", "desc"], "default": "desc" }, "required": false, "name": "sortDir", "in": "query" } ], "responses": { "200": { "description": "Paginated list of people", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": ["string", "null"] }, "firstName": { "type": "string" }, "middleName": { "type": ["string", "null"] }, "lastName": { "type": "string" }, "gender": { "type": ["string", "null"] }, "jobTitle": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "preferredLanguage": { "type": ["string", "null"] }, "preferredCurrency": { "type": ["string", "null"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "dateOfBirth": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "accessibilityEncrypted": {}, "dietaryEncrypted": {}, "loyaltyEncrypted": {}, "insuranceEncrypted": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] } }, "required": [ "id", "organizationId", "firstName", "middleName", "lastName", "gender", "jobTitle", "relation", "preferredLanguage", "preferredCurrency", "ownerId", "status", "source", "sourceRef", "tags", "customFields", "dateOfBirth", "notes", "createdAt", "updatedAt", "archivedAt", "email", "phone", "website" ] } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": ["data", "total", "limit", "offset"] } } } } }, "operationId": "getAdminRelationshipsPeople", "summary": "GET /v1/admin/relationships/people", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": ["string", "null"] }, "firstName": { "type": "string", "minLength": 1 }, "middleName": { "type": ["string", "null"] }, "lastName": { "type": "string", "minLength": 1 }, "gender": { "type": ["string", "null"], "enum": ["M", "F", "X", null] }, "jobTitle": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "preferredLanguage": { "type": ["string", "null"] }, "preferredCurrency": { "type": ["string", "null"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"], "default": "active" }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] }, "customFields": { "type": "object", "additionalProperties": {} }, "dateOfBirth": { "type": ["string", "null"], "format": "date" }, "notes": { "type": ["string", "null"] }, "accessibilityEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "dietaryEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "loyaltyEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "insuranceEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "email": { "type": ["string", "null"], "format": "email" }, "phone": { "type": ["string", "null"] }, "website": { "anyOf": [ { "type": ["string", "null"], "format": "uri" }, { "type": "string", "enum": [""] }, { "type": "null" } ] } }, "required": ["firstName", "lastName"] } } } }, "responses": { "201": { "description": "The created person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": ["string", "null"] }, "firstName": { "type": "string" }, "middleName": { "type": ["string", "null"] }, "lastName": { "type": "string" }, "gender": { "type": ["string", "null"] }, "jobTitle": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "preferredLanguage": { "type": ["string", "null"] }, "preferredCurrency": { "type": ["string", "null"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "dateOfBirth": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "accessibilityEncrypted": {}, "dietaryEncrypted": {}, "loyaltyEncrypted": {}, "insuranceEncrypted": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] } }, "required": [ "id", "organizationId", "firstName", "middleName", "lastName", "gender", "jobTitle", "relation", "preferredLanguage", "preferredCurrency", "ownerId", "status", "source", "sourceRef", "tags", "customFields", "dateOfBirth", "notes", "createdAt", "updatedAt", "archivedAt", "email", "phone", "website" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeople", "summary": "POST /v1/admin/relationships/people", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "A person by id", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": ["string", "null"] }, "firstName": { "type": "string" }, "middleName": { "type": ["string", "null"] }, "lastName": { "type": "string" }, "gender": { "type": ["string", "null"] }, "jobTitle": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "preferredLanguage": { "type": ["string", "null"] }, "preferredCurrency": { "type": ["string", "null"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "dateOfBirth": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "accessibilityEncrypted": {}, "dietaryEncrypted": {}, "loyaltyEncrypted": {}, "insuranceEncrypted": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] } }, "required": [ "id", "organizationId", "firstName", "middleName", "lastName", "gender", "jobTitle", "relation", "preferredLanguage", "preferredCurrency", "ownerId", "status", "source", "sourceRef", "tags", "customFields", "dateOfBirth", "notes", "createdAt", "updatedAt", "archivedAt", "email", "phone", "website" ] } }, "required": ["data"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsPeopleById", "summary": "GET /v1/admin/relationships/people/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": ["string", "null"] }, "firstName": { "type": "string", "minLength": 1 }, "middleName": { "type": ["string", "null"] }, "lastName": { "type": "string", "minLength": 1 }, "gender": { "type": ["string", "null"], "enum": ["M", "F", "X", null] }, "jobTitle": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "preferredLanguage": { "type": ["string", "null"] }, "preferredCurrency": { "type": ["string", "null"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "dateOfBirth": { "type": ["string", "null"], "format": "date" }, "notes": { "type": ["string", "null"] }, "accessibilityEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "dietaryEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "loyaltyEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "insuranceEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "email": { "type": ["string", "null"], "format": "email" }, "phone": { "type": ["string", "null"] }, "website": { "anyOf": [ { "type": ["string", "null"], "format": "uri" }, { "type": "string", "enum": [""] }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "The updated person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": ["string", "null"] }, "firstName": { "type": "string" }, "middleName": { "type": ["string", "null"] }, "lastName": { "type": "string" }, "gender": { "type": ["string", "null"] }, "jobTitle": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "preferredLanguage": { "type": ["string", "null"] }, "preferredCurrency": { "type": ["string", "null"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "dateOfBirth": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "accessibilityEncrypted": {}, "dietaryEncrypted": {}, "loyaltyEncrypted": {}, "insuranceEncrypted": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] } }, "required": [ "id", "organizationId", "firstName", "middleName", "lastName", "gender", "jobTitle", "relation", "preferredLanguage", "preferredCurrency", "ownerId", "status", "source", "sourceRef", "tags", "customFields", "dateOfBirth", "notes", "createdAt", "updatedAt", "archivedAt", "email", "phone", "website" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsPeopleById", "summary": "PATCH /v1/admin/relationships/people/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Person deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsPeopleById", "summary": "DELETE /v1/admin/relationships/people/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/merge": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mergeId": { "type": "string", "minLength": 1 } }, "required": ["mergeId"] } } } }, "responses": { "200": { "description": "The surviving person after merge", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": ["string", "null"] }, "firstName": { "type": "string" }, "middleName": { "type": ["string", "null"] }, "lastName": { "type": "string" }, "gender": { "type": ["string", "null"] }, "jobTitle": { "type": ["string", "null"] }, "relation": { "type": ["string", "null"], "enum": ["client", "partner", "supplier", "other", null] }, "preferredLanguage": { "type": ["string", "null"] }, "preferredCurrency": { "type": ["string", "null"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["active", "inactive", "archived"] }, "source": { "type": ["string", "null"] }, "sourceRef": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "object", "additionalProperties": {} }, "dateOfBirth": { "type": ["string", "null"] }, "notes": { "type": ["string", "null"] }, "accessibilityEncrypted": {}, "dietaryEncrypted": {}, "loyaltyEncrypted": {}, "insuranceEncrypted": {}, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "archivedAt": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "phone": { "type": ["string", "null"] }, "website": { "type": ["string", "null"] } }, "required": [ "id", "organizationId", "firstName", "middleName", "lastName", "gender", "jobTitle", "relation", "preferredLanguage", "preferredCurrency", "ownerId", "status", "source", "sourceRef", "tags", "customFields", "dateOfBirth", "notes", "createdAt", "updatedAt", "archivedAt", "email", "phone", "website" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdMerge", "summary": "POST /v1/admin/relationships/people/{id}/merge", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/contact-methods": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Contact methods for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": ["string", "null"] }, "value": { "type": "string" }, "normalizedValue": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "kind", "label", "value", "normalizedValue", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdContactMethods", "summary": "GET /v1/admin/relationships/people/{id}/contact-methods", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "email", "phone", "mobile", "whatsapp", "website", "sms", "fax", "social", "other" ] }, "label": { "type": ["string", "null"], "maxLength": 100 }, "value": { "type": "string", "minLength": 1, "maxLength": 500 }, "normalizedValue": { "type": ["string", "null"], "maxLength": 500 }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } }, "required": ["kind", "value"] } } } }, "responses": { "201": { "description": "The created contact method", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": ["string", "null"] }, "value": { "type": "string" }, "normalizedValue": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "kind", "label", "value", "normalizedValue", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdContactMethods", "summary": "POST /v1/admin/relationships/people/{id}/contact-methods", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/addresses": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Addresses for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "label": { "type": "string" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "label", "fullText", "line1", "line2", "city", "region", "postalCode", "country", "latitude", "longitude", "timezone", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdAddresses", "summary": "GET /v1/admin/relationships/people/{id}/addresses", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "enum": [ "primary", "billing", "shipping", "mailing", "meeting", "service", "legal", "other" ], "default": "other" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"], "maxLength": 100 }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "201": { "description": "The created address", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "label": { "type": "string" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "label", "fullText", "line1", "line2", "city", "region", "postalCode", "country", "latitude", "longitude", "timezone", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdAddresses", "summary": "POST /v1/admin/relationships/people/{id}/addresses", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/notes": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Notes for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "authorId": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": ["id", "personId", "authorId", "content", "createdAt"] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdNotes", "summary": "GET /v1/admin/relationships/people/{id}/notes", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": ["content"] } } } }, "responses": { "201": { "description": "The created person note", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "authorId": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": ["id", "personId", "authorId", "content", "createdAt"] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdNotes", "summary": "POST /v1/admin/relationships/people/{id}/notes", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/person-notes/{id}": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 10000 } }, "required": ["content"] } } } }, "responses": { "200": { "description": "The updated person note", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "authorId": { "type": "string" }, "content": { "type": "string" }, "createdAt": { "type": "string" } }, "required": ["id", "personId", "authorId", "content", "createdAt"] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Note not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsPersonNotesById", "summary": "PATCH /v1/admin/relationships/person-notes/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Note deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Note not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsPersonNotesById", "summary": "DELETE /v1/admin/relationships/person-notes/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/payment-methods": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Payment methods on file for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "brand": { "type": "string" }, "last4": { "type": ["string", "null"] }, "holderName": { "type": ["string", "null"] }, "expMonth": { "type": ["integer", "null"] }, "expYear": { "type": ["integer", "null"] }, "processorToken": { "type": "string" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string" } }, "required": [ "id", "personId", "brand", "last4", "holderName", "expMonth", "expYear", "processorToken", "isDefault", "createdAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdPaymentMethods", "summary": "GET /v1/admin/relationships/people/{id}/payment-methods", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "holderName": { "type": ["string", "null"] }, "processorToken": { "type": "string", "minLength": 1 }, "isDefault": { "type": "boolean", "default": false }, "brand": { "type": "string", "enum": ["visa", "mastercard", "amex", "revolut"] }, "last4": { "type": "string", "minLength": 2, "maxLength": 8 }, "expMonth": { "type": "integer", "minimum": 1, "maximum": 12 }, "expYear": { "type": "integer", "minimum": 2000, "maximum": 2100 } }, "required": ["processorToken", "brand", "last4", "expMonth", "expYear"], "additionalProperties": false }, { "type": "object", "properties": { "holderName": { "type": ["string", "null"] }, "processorToken": { "type": "string", "minLength": 1 }, "isDefault": { "type": "boolean", "default": false }, "brand": { "type": "string", "enum": ["bank_transfer"] }, "last4": { "type": "null" }, "expMonth": { "type": "null" }, "expYear": { "type": "null" } }, "required": ["processorToken", "brand"], "additionalProperties": false } ] } } } }, "responses": { "201": { "description": "The created payment method", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "brand": { "type": "string" }, "last4": { "type": ["string", "null"] }, "holderName": { "type": ["string", "null"] }, "expMonth": { "type": ["integer", "null"] }, "expYear": { "type": ["integer", "null"] }, "processorToken": { "type": "string" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string" } }, "required": [ "id", "personId", "brand", "last4", "holderName", "expMonth", "expYear", "processorToken", "isDefault", "createdAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdPaymentMethods", "summary": "POST /v1/admin/relationships/people/{id}/payment-methods", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/person-payment-methods/{id}": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "holderName": { "type": ["string", "null"] }, "processorToken": { "type": "string", "minLength": 1 }, "isDefault": { "type": "boolean", "default": false }, "brand": { "type": "string", "enum": ["visa", "mastercard", "amex", "revolut", "bank_transfer"] }, "last4": { "type": ["string", "null"], "minLength": 2, "maxLength": 8 }, "expMonth": { "type": ["integer", "null"], "minimum": 1, "maximum": 12 }, "expYear": { "type": ["integer", "null"], "minimum": 2000, "maximum": 2100 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "The updated payment method", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "brand": { "type": "string" }, "last4": { "type": ["string", "null"] }, "holderName": { "type": ["string", "null"] }, "expMonth": { "type": ["integer", "null"] }, "expYear": { "type": ["integer", "null"] }, "processorToken": { "type": "string" }, "isDefault": { "type": "boolean" }, "createdAt": { "type": "string" } }, "required": [ "id", "personId", "brand", "last4", "holderName", "expMonth", "expYear", "processorToken", "isDefault", "createdAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Payment method not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsPersonPaymentMethodsById", "summary": "PATCH /v1/admin/relationships/person-payment-methods/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Payment method deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Payment method not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsPersonPaymentMethodsById", "summary": "DELETE /v1/admin/relationships/person-payment-methods/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/communications": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string", "enum": ["email", "phone", "whatsapp", "sms", "meeting", "other"] }, "required": false, "name": "channel", "in": "query" }, { "schema": { "type": "string", "enum": ["inbound", "outbound"] }, "required": false, "name": "direction", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "dateFrom", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "dateTo", "in": "query" } ], "responses": { "200": { "description": "Communication log entries for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "organizationId": { "type": ["string", "null"] }, "channel": { "type": "string", "enum": ["email", "phone", "whatsapp", "sms", "meeting", "other"] }, "direction": { "type": "string", "enum": ["inbound", "outbound"] }, "subject": { "type": ["string", "null"] }, "content": { "type": ["string", "null"] }, "sentAt": { "type": ["string", "null"] }, "createdAt": { "type": "string" } }, "required": [ "id", "personId", "organizationId", "channel", "direction", "subject", "content", "sentAt", "createdAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdCommunications", "summary": "GET /v1/admin/relationships/people/{id}/communications", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": ["string", "null"] }, "channel": { "type": "string", "enum": ["email", "phone", "whatsapp", "sms", "meeting", "other"] }, "direction": { "type": "string", "enum": ["inbound", "outbound"] }, "subject": { "type": ["string", "null"], "maxLength": 500 }, "content": { "type": ["string", "null"] }, "sentAt": { "type": ["string", "null"], "format": "date-time" } }, "required": ["channel", "direction"] } } } }, "responses": { "201": { "description": "The created communication log entry", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "organizationId": { "type": ["string", "null"] }, "channel": { "type": "string", "enum": ["email", "phone", "whatsapp", "sms", "meeting", "other"] }, "direction": { "type": "string", "enum": ["inbound", "outbound"] }, "subject": { "type": ["string", "null"] }, "content": { "type": ["string", "null"] }, "sentAt": { "type": ["string", "null"] }, "createdAt": { "type": "string" } }, "required": [ "id", "personId", "organizationId", "channel", "direction", "subject", "content", "sentAt", "createdAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdCommunications", "summary": "POST /v1/admin/relationships/people/{id}/communications", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/segments": { "get": { "responses": { "200": { "description": "All segments", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": ["string", "null"] }, "conditions": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "conditions", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsSegments", "summary": "GET /v1/admin/relationships/segments", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": ["string", "null"] }, "conditions": { "type": ["object", "null"], "additionalProperties": {} } }, "required": ["name"] } } } }, "responses": { "201": { "description": "The created segment", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": ["string", "null"] }, "conditions": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "conditions", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsSegments", "summary": "POST /v1/admin/relationships/segments", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/segments/{segmentId}": { "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "segmentId", "in": "path" } ], "responses": { "200": { "description": "Segment deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Segment not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsSegmentsBySegmentId", "summary": "DELETE /v1/admin/relationships/segments/{segmentId}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/export": { "post": { "responses": { "200": { "description": "People exported as a CSV download", "content": { "text/csv": { "schema": { "type": "string" } } } } }, "operationId": "postAdminRelationshipsPeopleExport", "summary": "POST /v1/admin/relationships/people/export", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/import": { "post": { "requestBody": { "required": true, "content": { "text/csv": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Import summary", "content": { "application/json": { "schema": { "type": "object", "properties": { "imported": { "type": "integer" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "row": { "type": "integer" }, "error": { "type": "string" } }, "required": ["row", "error"] } } }, "required": ["imported", "errors"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleImport", "summary": "POST /v1/admin/relationships/people/import", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/contact-methods/{id}": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entityType": { "type": "string", "minLength": 1, "maxLength": 100 }, "entityId": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "type": "string", "enum": [ "email", "phone", "mobile", "whatsapp", "website", "sms", "fax", "social", "other" ] }, "label": { "type": ["string", "null"], "maxLength": 100 }, "value": { "type": "string", "minLength": 1, "maxLength": 500 }, "normalizedValue": { "type": ["string", "null"], "maxLength": 500 }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "200": { "description": "The updated contact method", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": ["string", "null"] }, "value": { "type": "string" }, "normalizedValue": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "kind", "label", "value", "normalizedValue", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Contact method not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsContactMethodsById", "summary": "PATCH /v1/admin/relationships/contact-methods/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Contact method deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Contact method not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsContactMethodsById", "summary": "DELETE /v1/admin/relationships/contact-methods/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/addresses/{id}": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entityType": { "type": "string", "minLength": 1, "maxLength": 100 }, "entityId": { "type": "string", "minLength": 1, "maxLength": 100 }, "label": { "type": "string", "enum": [ "primary", "billing", "shipping", "mailing", "meeting", "service", "legal", "other" ], "default": "other" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"], "maxLength": 100 }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "200": { "description": "The updated address", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "entityType": { "type": "string" }, "entityId": { "type": "string" }, "label": { "type": "string" }, "fullText": { "type": ["string", "null"] }, "line1": { "type": ["string", "null"] }, "line2": { "type": ["string", "null"] }, "city": { "type": ["string", "null"] }, "region": { "type": ["string", "null"] }, "postalCode": { "type": ["string", "null"] }, "country": { "type": ["string", "null"] }, "latitude": { "type": ["number", "null"] }, "longitude": { "type": ["number", "null"] }, "timezone": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "entityType", "entityId", "label", "fullText", "line1", "line2", "city", "region", "postalCode", "country", "latitude", "longitude", "timezone", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Address not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsAddressesById", "summary": "PATCH /v1/admin/relationships/addresses/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Address deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Address not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsAddressesById", "summary": "DELETE /v1/admin/relationships/addresses/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/documents": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "required": false, "name": "type", "in": "query" }, { "schema": { "type": "string", "format": "date" }, "required": false, "name": "expiringBefore", "in": "query" } ], "responses": { "200": { "description": "Identity documents for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": {}, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"] }, "expiryDate": { "type": ["string", "null"] }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "type", "issuingAuthority", "issuingCountry", "issueDate", "expiryDate", "attachmentId", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdDocuments", "summary": "GET /v1/admin/relationships/people/{id}/documents", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"], "format": "date" }, "expiryDate": { "type": ["string", "null"], "format": "date" }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } }, "required": ["type"] } } } }, "responses": { "201": { "description": "The created identity document", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": {}, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"] }, "expiryDate": { "type": ["string", "null"] }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "type", "issuingAuthority", "issuingCountry", "issueDate", "expiryDate", "attachmentId", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdDocuments", "summary": "POST /v1/admin/relationships/people/{id}/documents", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/person-documents/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "An identity document by id", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": {}, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"] }, "expiryDate": { "type": ["string", "null"] }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "type", "issuingAuthority", "issuingCountry", "issueDate", "expiryDate", "attachmentId", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsPersonDocumentsById", "summary": "GET /v1/admin/relationships/person-documents/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": { "type": ["object", "null"], "properties": { "enc": { "type": "string", "minLength": 1 } }, "required": ["enc"] }, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"], "format": "date" }, "expiryDate": { "type": ["string", "null"], "format": "date" }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "200": { "description": "The updated identity document", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": {}, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"] }, "expiryDate": { "type": ["string", "null"] }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "type", "issuingAuthority", "issuingCountry", "issueDate", "expiryDate", "attachmentId", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsPersonDocumentsById", "summary": "PATCH /v1/admin/relationships/person-documents/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Document deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsPersonDocumentsById", "summary": "DELETE /v1/admin/relationships/person-documents/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/person-documents/{id}/set-primary": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "The document promoted to primary", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": {}, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"] }, "expiryDate": { "type": ["string", "null"] }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "type", "issuingAuthority", "issuingCountry", "issueDate", "expiryDate", "attachmentId", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPersonDocumentsByIdSetPrimary", "summary": "POST /v1/admin/relationships/person-documents/{id}/set-primary", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/travel-snapshot": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Decrypted travel-snapshot pre-fill for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dateOfBirth": { "type": ["string", "null"] }, "dietaryRequirements": { "type": ["string", "null"] }, "accessibilityNeeds": { "type": ["string", "null"] }, "documentType": { "type": ["string", "null"], "enum": ["passport", "id_card", "driver_license", "visa", "other", null] }, "documentNumber": { "type": ["string", "null"] }, "documentExpiry": { "type": ["string", "null"] }, "documentIssuingCountry": { "type": ["string", "null"] }, "documentIssuingAuthority": { "type": ["string", "null"] }, "documentPersonDocumentId": { "type": ["string", "null"] } }, "required": [ "dateOfBirth", "dietaryRequirements", "accessibilityNeeds", "documentType", "documentNumber", "documentExpiry", "documentIssuingCountry", "documentIssuingAuthority", "documentPersonDocumentId" ] } }, "required": ["data"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "503": { "description": "KMS provider not configured", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdTravelSnapshot", "summary": "GET /v1/admin/relationships/people/{id}/travel-snapshot", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/profile-pii": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accessibility": { "type": ["string", "null"], "maxLength": 4000 }, "dietary": { "type": ["string", "null"], "maxLength": 4000 }, "loyalty": { "type": ["string", "null"], "maxLength": 4000 }, "insurance": { "type": ["string", "null"], "maxLength": 4000 } } } } } }, "responses": { "200": { "description": "PII slots updated", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "400": { "description": "invalid_request or nothing to update", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "503": { "description": "KMS provider not configured", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsPeopleByIdProfilePii", "summary": "PATCH /v1/admin/relationships/people/{id}/profile-pii", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/documents/from-plaintext": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "number": { "type": ["string", "null"], "maxLength": 255 }, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"], "format": "date" }, "expiryDate": { "type": ["string", "null"], "format": "date" }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } }, "required": ["type"] } } } }, "responses": { "201": { "description": "The created identity document (number encrypted server-side)", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": {}, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"] }, "expiryDate": { "type": ["string", "null"] }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "type", "issuingAuthority", "issuingCountry", "issueDate", "expiryDate", "attachmentId", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "503": { "description": "KMS provider not configured", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdDocumentsFromPlaintext", "summary": "POST /v1/admin/relationships/people/{id}/documents/from-plaintext", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/person-documents/{id}/from-plaintext": { "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "number": { "type": ["string", "null"], "maxLength": 255 }, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"], "format": "date" }, "expiryDate": { "type": ["string", "null"], "format": "date" }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "200": { "description": "The updated identity document (number encrypted server-side)", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "type": { "type": "string", "enum": ["passport", "id_card", "driver_license", "visa", "other"] }, "numberEncrypted": {}, "issuingAuthority": { "type": ["string", "null"] }, "issuingCountry": { "type": ["string", "null"] }, "issueDate": { "type": ["string", "null"] }, "expiryDate": { "type": ["string", "null"] }, "attachmentId": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "type", "issuingAuthority", "issuingCountry", "issueDate", "expiryDate", "attachmentId", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "503": { "description": "KMS provider not configured", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsPersonDocumentsByIdFromPlaintext", "summary": "PATCH /v1/admin/relationships/person-documents/{id}/from-plaintext", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/person-documents/{id}/reveal": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "The decrypted document number (disclosure recorded in the action ledger)", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "documentId": { "type": "string" }, "number": { "type": ["string", "null"] } }, "required": ["documentId", "number"] } }, "required": ["data"] } } } }, "403": { "description": "Caller lacks the reveal capability", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "required": ["error", "reason"] } } } }, "404": { "description": "Document not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "503": { "description": "KMS provider not configured", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsPersonDocumentsByIdReveal", "summary": "GET /v1/admin/relationships/person-documents/{id}/reveal", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/relationships": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" }, { "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string", "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other" ] }, "required": false, "name": "kind", "in": "query" }, { "schema": { "type": "string", "enum": ["from", "to", "both"], "default": "both" }, "required": false, "name": "direction", "in": "query" } ], "responses": { "200": { "description": "Relationships for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fromPersonId": { "type": "string" }, "toPersonId": { "type": "string" }, "kind": { "type": "string", "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other" ] }, "inverseKind": { "type": ["string", "null"], "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other", null ] }, "startDate": { "type": ["string", "null"] }, "endDate": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "fromPersonId", "toPersonId", "kind", "inverseKind", "startDate", "endDate", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdRelationships", "summary": "GET /v1/admin/relationships/people/{id}/relationships", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "toPersonId": { "type": "string", "minLength": 1 }, "kind": { "type": "string", "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other" ] }, "inverseKind": { "type": ["string", "null"], "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other", null ] }, "startDate": { "type": ["string", "null"], "format": "date" }, "endDate": { "type": ["string", "null"], "format": "date" }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "autoInverse": { "type": "boolean" } }, "required": ["toPersonId", "kind"] } } } }, "responses": { "201": { "description": "The created relationship edge", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "fromPersonId": { "type": "string" }, "toPersonId": { "type": "string" }, "kind": { "type": "string", "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other" ] }, "inverseKind": { "type": ["string", "null"], "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other", null ] }, "startDate": { "type": ["string", "null"] }, "endDate": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "fromPersonId", "toPersonId", "kind", "inverseKind", "startDate", "endDate", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request, person not found, or self-relationship rejected", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "409": { "description": "Relationship already exists", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsPeopleByIdRelationships", "summary": "POST /v1/admin/relationships/people/{id}/relationships", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/person-relationships/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "A relationship edge by id", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "fromPersonId": { "type": "string" }, "toPersonId": { "type": "string" }, "kind": { "type": "string", "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other" ] }, "inverseKind": { "type": ["string", "null"], "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other", null ] }, "startDate": { "type": ["string", "null"] }, "endDate": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "fromPersonId", "toPersonId", "kind", "inverseKind", "startDate", "endDate", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "404": { "description": "Relationship not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsPersonRelationshipsById", "summary": "GET /v1/admin/relationships/person-relationships/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other" ] }, "inverseKind": { "type": ["string", "null"], "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other", null ] }, "startDate": { "type": ["string", "null"], "format": "date" }, "endDate": { "type": ["string", "null"], "format": "date" }, "isPrimary": { "type": "boolean", "default": false }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "200": { "description": "The updated relationship edge", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "fromPersonId": { "type": "string" }, "toPersonId": { "type": "string" }, "kind": { "type": "string", "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other" ] }, "inverseKind": { "type": ["string", "null"], "enum": [ "spouse", "partner", "parent", "child", "sibling", "guardian", "ward", "emergency_contact", "friend", "travel_companion", "other", null ] }, "startDate": { "type": ["string", "null"] }, "endDate": { "type": ["string", "null"] }, "isPrimary": { "type": "boolean" }, "notes": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "fromPersonId", "toPersonId", "kind", "inverseKind", "startDate", "endDate", "isPrimary", "notes", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Relationship not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsPersonRelationshipsById", "summary": "PATCH /v1/admin/relationships/person-relationships/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Relationship deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Relationship not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsPersonRelationshipsById", "summary": "DELETE /v1/admin/relationships/person-relationships/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/customer-signals": { "get": { "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "personId", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "assignedToUserId", "in": "query" }, { "schema": { "type": "string", "enum": ["new", "contacted", "qualified", "converted", "lost", "expired"] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "required": false, "name": "kind", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "productId", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "search", "in": "query" } ], "responses": { "200": { "description": "Paginated list of customer signals", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": [ "form", "phone", "admin", "abandoned_cart", "website", "booking" ] }, "status": { "type": "string", "enum": [ "new", "contacted", "qualified", "converted", "lost", "expired" ] }, "priority": { "type": "string" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"] }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "productId", "optionUnitId", "kind", "source", "status", "priority", "notes", "tags", "assignedToUserId", "followUpAt", "resolvedBookingId", "sourceSubmissionId", "metadata", "createdAt", "updatedAt" ] } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": ["data", "total", "limit", "offset"] } } } } }, "operationId": "getAdminRelationshipsCustomerSignals", "summary": "GET /v1/admin/relationships/customer-signals", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "personId": { "type": "string", "minLength": 1 }, "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": ["form", "phone", "admin", "abandoned_cart", "website", "booking"] }, "status": { "type": "string", "enum": ["new", "contacted", "qualified", "converted", "lost", "expired"], "default": "new" }, "priority": { "type": "string", "enum": ["low", "normal", "high", "urgent"], "default": "normal" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"], "format": "date-time" }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } }, "required": ["personId", "kind", "source"] } } } }, "responses": { "201": { "description": "The created customer signal", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": ["form", "phone", "admin", "abandoned_cart", "website", "booking"] }, "status": { "type": "string", "enum": ["new", "contacted", "qualified", "converted", "lost", "expired"] }, "priority": { "type": "string" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"] }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "productId", "optionUnitId", "kind", "source", "status", "priority", "notes", "tags", "assignedToUserId", "followUpAt", "resolvedBookingId", "sourceSubmissionId", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Person not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsCustomerSignals", "summary": "POST /v1/admin/relationships/customer-signals", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/customer-signals/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "A customer signal by id", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": ["form", "phone", "admin", "abandoned_cart", "website", "booking"] }, "status": { "type": "string", "enum": ["new", "contacted", "qualified", "converted", "lost", "expired"] }, "priority": { "type": "string" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"] }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "productId", "optionUnitId", "kind", "source", "status", "priority", "notes", "tags", "assignedToUserId", "followUpAt", "resolvedBookingId", "sourceSubmissionId", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "404": { "description": "Signal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsCustomerSignalsById", "summary": "GET /v1/admin/relationships/customer-signals/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": ["form", "phone", "admin", "abandoned_cart", "website", "booking"] }, "status": { "type": "string", "enum": ["new", "contacted", "qualified", "converted", "lost", "expired"], "default": "new" }, "priority": { "type": "string", "enum": ["low", "normal", "high", "urgent"], "default": "normal" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" }, "default": [] }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"], "format": "date-time" }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} } } } } } }, "responses": { "200": { "description": "The updated customer signal", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": ["form", "phone", "admin", "abandoned_cart", "website", "booking"] }, "status": { "type": "string", "enum": ["new", "contacted", "qualified", "converted", "lost", "expired"] }, "priority": { "type": "string" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"] }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "productId", "optionUnitId", "kind", "source", "status", "priority", "notes", "tags", "assignedToUserId", "followUpAt", "resolvedBookingId", "sourceSubmissionId", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Signal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsCustomerSignalsById", "summary": "PATCH /v1/admin/relationships/customer-signals/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Signal deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Signal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsCustomerSignalsById", "summary": "DELETE /v1/admin/relationships/customer-signals/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/customer-signals/{id}/resolve": { "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bookingId": { "type": "string", "minLength": 1 } }, "required": ["bookingId"] } } } }, "responses": { "200": { "description": "The resolved (converted) customer signal", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": ["form", "phone", "admin", "abandoned_cart", "website", "booking"] }, "status": { "type": "string", "enum": ["new", "contacted", "qualified", "converted", "lost", "expired"] }, "priority": { "type": "string" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"] }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "productId", "optionUnitId", "kind", "source", "status", "priority", "notes", "tags", "assignedToUserId", "followUpAt", "resolvedBookingId", "sourceSubmissionId", "metadata", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Signal not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsCustomerSignalsByIdResolve", "summary": "POST /v1/admin/relationships/customer-signals/{id}/resolve", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/people/{id}/signals": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Customer signals for the person", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "personId": { "type": "string" }, "productId": { "type": ["string", "null"] }, "optionUnitId": { "type": ["string", "null"] }, "kind": { "type": "string", "enum": ["wishlist", "notify", "inquiry", "request_offer", "referral"] }, "source": { "type": "string", "enum": [ "form", "phone", "admin", "abandoned_cart", "website", "booking" ] }, "status": { "type": "string", "enum": [ "new", "contacted", "qualified", "converted", "lost", "expired" ] }, "priority": { "type": "string" }, "notes": { "type": ["string", "null"] }, "tags": { "type": "array", "items": { "type": "string" } }, "assignedToUserId": { "type": ["string", "null"] }, "followUpAt": { "type": ["string", "null"] }, "resolvedBookingId": { "type": ["string", "null"] }, "sourceSubmissionId": { "type": ["string", "null"] }, "metadata": { "type": ["object", "null"], "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "personId", "productId", "optionUnitId", "kind", "source", "status", "priority", "notes", "tags", "assignedToUserId", "followUpAt", "resolvedBookingId", "sourceSubmissionId", "metadata", "createdAt", "updatedAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsPeopleByIdSignals", "summary": "GET /v1/admin/relationships/people/{id}/signals", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/activities": { "get": { "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 }, "required": false, "name": "limit", "in": "query" }, { "schema": { "type": ["integer", "null"], "minimum": 0, "default": 0 }, "required": false, "name": "offset", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "ownerId", "in": "query" }, { "schema": { "type": "string", "enum": ["planned", "done", "cancelled"] }, "required": false, "name": "status", "in": "query" }, { "schema": { "type": "string", "enum": ["call", "email", "meeting", "task", "follow_up", "note"] }, "required": false, "name": "type", "in": "query" }, { "schema": { "type": "string", "enum": ["organization", "person", "proposal", "activity"] }, "required": false, "name": "entityType", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "entityId", "in": "query" }, { "schema": { "type": "string" }, "required": false, "name": "search", "in": "query" } ], "responses": { "200": { "description": "Paginated list of activities", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string", "enum": ["call", "email", "meeting", "task", "follow_up", "note"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["planned", "done", "cancelled"] }, "dueAt": { "type": ["string", "null"] }, "completedAt": { "type": ["string", "null"] }, "location": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "customFields": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "subject", "type", "ownerId", "status", "dueAt", "completedAt", "location", "description", "customFields", "createdAt", "updatedAt" ] } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" } }, "required": ["data", "total", "limit", "offset"] } } } } }, "operationId": "getAdminRelationshipsActivities", "summary": "GET /v1/admin/relationships/activities", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["call", "email", "meeting", "task", "follow_up", "note"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["planned", "done", "cancelled"], "default": "planned" }, "dueAt": { "type": ["string", "null"], "format": "date-time" }, "completedAt": { "type": ["string", "null"], "format": "date-time" }, "location": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] } }, "required": ["subject", "type"] } } } }, "responses": { "201": { "description": "The created activity", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string", "enum": ["call", "email", "meeting", "task", "follow_up", "note"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["planned", "done", "cancelled"] }, "dueAt": { "type": ["string", "null"] }, "completedAt": { "type": ["string", "null"] }, "location": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "customFields": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "subject", "type", "ownerId", "status", "dueAt", "completedAt", "location", "description", "customFields", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsActivities", "summary": "POST /v1/admin/relationships/activities", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/activities/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "An activity by id", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string", "enum": ["call", "email", "meeting", "task", "follow_up", "note"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["planned", "done", "cancelled"] }, "dueAt": { "type": ["string", "null"] }, "completedAt": { "type": ["string", "null"] }, "location": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "customFields": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "subject", "type", "ownerId", "status", "dueAt", "completedAt", "location", "description", "customFields", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "404": { "description": "Activity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "getAdminRelationshipsActivitiesById", "summary": "GET /v1/admin/relationships/activities/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "patch": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string", "minLength": 1 }, "type": { "type": "string", "enum": ["call", "email", "meeting", "task", "follow_up", "note"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["planned", "done", "cancelled"], "default": "planned" }, "dueAt": { "type": ["string", "null"], "format": "date-time" }, "completedAt": { "type": ["string", "null"], "format": "date-time" }, "location": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] } } } } } }, "responses": { "200": { "description": "The updated activity", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "subject": { "type": "string" }, "type": { "type": "string", "enum": ["call", "email", "meeting", "task", "follow_up", "note"] }, "ownerId": { "type": ["string", "null"] }, "status": { "type": "string", "enum": ["planned", "done", "cancelled"] }, "dueAt": { "type": ["string", "null"] }, "completedAt": { "type": ["string", "null"] }, "location": { "type": ["string", "null"] }, "description": { "type": ["string", "null"] }, "customFields": { "type": "object", "additionalProperties": {} }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "subject", "type", "ownerId", "status", "dueAt", "completedAt", "location", "description", "customFields", "createdAt", "updatedAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Activity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "patchAdminRelationshipsActivitiesById", "summary": "PATCH /v1/admin/relationships/activities/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Activity deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Activity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsActivitiesById", "summary": "DELETE /v1/admin/relationships/activities/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/activities/{id}/links": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Entity links for the activity", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "activityId": { "type": "string" }, "entityType": { "type": "string", "enum": ["organization", "person", "proposal", "activity"] }, "entityId": { "type": "string" }, "role": { "type": "string", "enum": ["primary", "related"] }, "createdAt": { "type": "string" } }, "required": [ "id", "activityId", "entityType", "entityId", "role", "createdAt" ] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsActivitiesByIdLinks", "summary": "GET /v1/admin/relationships/activities/{id}/links", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entityType": { "type": "string", "enum": ["organization", "person", "proposal", "activity"] }, "entityId": { "type": "string" }, "role": { "type": "string", "enum": ["primary", "related"], "default": "related" } }, "required": ["entityType", "entityId"] } } } }, "responses": { "201": { "description": "The created activity link", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "activityId": { "type": "string" }, "entityType": { "type": "string", "enum": ["organization", "person", "proposal", "activity"] }, "entityId": { "type": "string" }, "role": { "type": "string", "enum": ["primary", "related"] }, "createdAt": { "type": "string" } }, "required": [ "id", "activityId", "entityType", "entityId", "role", "createdAt" ] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } }, "404": { "description": "Linked entity not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsActivitiesByIdLinks", "summary": "POST /v1/admin/relationships/activities/{id}/links", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/activity-links/{id}": { "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Activity link deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Activity link not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsActivityLinksById", "summary": "DELETE /v1/admin/relationships/activity-links/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/activities/{id}/participants": { "get": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Participants for the activity", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "activityId": { "type": "string" }, "personId": { "type": "string" }, "isPrimary": { "type": "boolean" }, "createdAt": { "type": "string" } }, "required": ["id", "activityId", "personId", "isPrimary", "createdAt"] } } }, "required": ["data"] } } } } }, "operationId": "getAdminRelationshipsActivitiesByIdParticipants", "summary": "GET /v1/admin/relationships/activities/{id}/participants", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" }, "post": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "personId": { "type": "string" }, "isPrimary": { "type": "boolean", "default": false } }, "required": ["personId"] } } } }, "responses": { "201": { "description": "The created activity participant", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "activityId": { "type": "string" }, "personId": { "type": "string" }, "isPrimary": { "type": "boolean" }, "createdAt": { "type": "string" } }, "required": ["id", "activityId", "personId", "isPrimary", "createdAt"] } }, "required": ["data"] } } } }, "400": { "description": "invalid_request", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "postAdminRelationshipsActivitiesByIdParticipants", "summary": "POST /v1/admin/relationships/activities/{id}/participants", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } }, "/v1/admin/relationships/activity-participants/{id}": { "delete": { "parameters": [ { "schema": { "type": "string" }, "required": true, "name": "id", "in": "path" } ], "responses": { "200": { "description": "Activity participant deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean", "enum": [true] } }, "required": ["success"] } } } }, "404": { "description": "Activity participant not found", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" } }, "required": ["error"] } } } } }, "operationId": "deleteAdminRelationshipsActivityParticipantsById", "summary": "DELETE /v1/admin/relationships/activity-participants/{id}", "tags": ["relationships"], "x-voyant-module": "relationships", "x-voyant-surface": "admin", "x-voyant-api-id": "@voyant-travel/relationships#api.admin", "x-voyant-unit-id": "@voyant-travel/relationships", "x-voyant-package-name": "@voyant-travel/relationships" } } }, "webhooks": {} }