{"openapi":"3.0.1","info":{"title":"Lifecycle Manager API","version":"v1"},"servers":[{"url":"https://api.scalepad.com"}],"paths":{"/lifecycle-manager/v1/notes/{id}":{"delete":{"tags":["Notes"],"summary":"Delete Notes","description":"Deletes a note.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Notes"],"summary":"Get Notes","description":"Gets a note's full details.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the note to retrieve.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Model.Public.NoteApi"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Notes"],"summary":"Update Notes","description":"Update title and description of a note.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/notes":{"post":{"tags":["Notes"],"summary":"Create Notes","description":"Create a new note for a client.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Notes"],"summary":"List Notes","description":"Retrieve a comprehensive list of all notes with filtering options.","parameters":[{"name":"filter[client.id]","in":"query","description":"Filters records by using a query string on the field `client.id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283`\n\n`filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283`","schema":{"type":"string"}},{"name":"filter[is_archived]","in":"query","description":"Filters records by using a query string on the field `is_archived`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[is_archived]=true`\n\n`filter[is_archived]=eq:true`","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32","example":50},"example":50},{"name":"cursor","in":"query","description":"Cursor of the current page, starts at 1.\r\n            \r\n- Cursor pagination cannot guarantee atomicity.\r\n- Endpoints may skip new records inserted between paginated reads.\r\n- Endpoints may occasionally return duplicate records.","schema":{"type":"string","example":"ABC123"},"example":"ABC123"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.Response.PagedResponse_Organization.Engagement.EngagementNote.Model.Public.NoteApi_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/notes/{id}/archive-status":{"put":{"tags":["Notes"],"summary":"Update Notes Archive Status","description":"Mark the notes as archive or bring an archived notes back to active.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesArchiveStatus_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesArchiveStatus_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesArchiveStatus_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Controller.Public.NotesArchiveStatus_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v2/meetings/{id}":{"put":{"tags":["Meetings"],"summary":"Update Meeting","description":"Update core information about a meeting.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV2_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV2_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV2_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV2_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meeting-types/{meeting_type_id}":{"delete":{"tags":["Meeting Types"],"summary":"Delete Meeting type","description":"Deletes a Meeting type that is no longer relevant to business operations.","parameters":[{"name":"meeting_type_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Meeting Types"],"summary":"Update Meeting type","description":"Update a Meeting type's label.","parameters":[{"name":"meeting_type_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meeting-types":{"post":{"tags":["Meeting Types"],"summary":"Create Meeting type","description":"Create a new Meeting type with a label.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Meeting Types"],"summary":"List Meeting types","description":"List all Meeting types currently available.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.MeetingType.Controller.Public.MeetingTypeList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{meeting_id}/initiatives":{"get":{"tags":["Meetings"],"summary":"List Meeting Initiatives","description":"Retrieve all initiatives that have been attached to a meeting, showing which projects will be discussed.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to retrieve initiatives for.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingInitiativesList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{meeting_id}/initiatives/{initiative_id}":{"put":{"tags":["Meetings"],"summary":"Attach Initiative to Meeting","description":"Attach an existing initiative to a meeting to include it as a discussion topic on the meeting agenda.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to attach the initiative to.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"},{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to attach to the meeting.\r\nThis initiative must belong to the same client as the meeting.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Meetings"],"summary":"Detach Initiative from Meeting","description":"Detach an initiative and a meeting without deleting the initiative itself, removing it from the meeting agenda.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to detach the initiative from.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"},{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to remove from the meeting agenda.\r\nThe initiative will continue to exist but will no longer be associated with this meeting.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{meeting_id}/goals":{"get":{"tags":["Meetings"],"summary":"List Meeting Goals","description":"Retrieve all goals that have been attached to a meeting, showing which business objectives will be discussed or reviewed.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to retrieve goals for.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingGoalsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{meeting_id}/goals/{goal_id}":{"put":{"tags":["Meetings"],"summary":"Attach Goal to Meeting","description":"Attach an existing goal to a meeting to include it as a discussion topic on the meeting agenda.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to attach the goal to.\r\nThe goal will be added to this meeting's agenda for discussion.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"},{"name":"goal_id","in":"path","description":"The unique identifier of the goal to attach to the meeting.\r\nThis goal must belong to the same client as the meeting.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Meetings"],"summary":"Detach Goal from Meeting","description":"Detach a goal and a meeting without deleting the goal itself, removing it from the meeting agenda.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to detach the goal from.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"},{"name":"goal_id","in":"path","description":"The unique identifier of the goal to remove from the meeting agenda.\r\nThe goal will continue to exist but will no longer be associated with this meeting.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{id}":{"delete":{"tags":["Meetings"],"summary":"Delete Meeting","description":"Remove a meeting that is no longer needed.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Meetings"],"summary":"Get Meeting","description":"Access complete details of a specific meeting.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the meeting to retrieve.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Meetings"],"summary":"Update Meeting v1","description":"Update core information about a meeting.\nScheduled for removal on March 1, 2027","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV1_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV1_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV1_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingUpdateV1_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}},"deprecated":true}},"/lifecycle-manager/v2/meetings":{"post":{"tags":["Meetings"],"summary":"Create Meeting","description":"Schedule a new client meeting.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV2_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV2_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV2_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV2_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV2_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings":{"post":{"tags":["Meetings"],"summary":"Create Meeting v1","description":"Schedule a new client meeting.\nScheduled for removal on March 1, 2027","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV1_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV1_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV1_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV1_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCreateV1_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}},"deprecated":true},"get":{"tags":["Meetings"],"summary":"List Meetings","description":"Retrieve a comprehensive list of all client meetings with filtering options.","parameters":[{"name":"filter[client.id]","in":"query","description":"Filters records by using a query string on the field `client.id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283`\n\n`filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283`","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32","example":50},"example":50},{"name":"cursor","in":"query","description":"Cursor of the current page, starts at 1.\r\n            \r\n- Cursor pagination cannot guarantee atomicity.\r\n- Endpoints may skip new records inserted between paginated reads.\r\n- Endpoints may occasionally return duplicate records.","schema":{"type":"string","example":"ABC123"},"example":"ABC123"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.Response.PagedResponse_Meeting.Model.Public.MeetingOverviewPublic_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{id}/completion-status":{"put":{"tags":["Meetings"],"summary":"Update Meeting Completion Status","description":"Update the completion status of a meeting.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCompleteStatusUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCompleteStatusUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCompleteStatusUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingCompleteStatusUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{id}/attendees/users":{"post":{"tags":["Meetings"],"summary":"Add Meeting User Attendees","description":"Add users as meeting attendees.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the meeting.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserAdd_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserAdd_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserAdd_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserAdd_Request"}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserAdd_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Meetings"],"summary":"Remove Meeting User Attendees","description":"Remove user attendees from the meeting.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserRemove_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserRemove_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserRemove_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeUserRemove_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{id}/attendees/contacts":{"post":{"tags":["Meetings"],"summary":"Add Meeting Contact Attendees","description":"Add one or more client contacts as attendees.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the meeting.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactAdd_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactAdd_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactAdd_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactAdd_Request"}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactAdd_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Meetings"],"summary":"Remove Meeting Contact Attendees","description":"Remove client contact attendees from the meeting.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactRemove_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactRemove_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactRemove_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingAttendeeContactRemove_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{meeting_id}/action-items":{"get":{"tags":["Meetings"],"summary":"List Meeting Action Items","description":"Retrieve all action items created during or linked to a specific meeting, enabling MSPs to track follow-ups and tasks resulting from client discussions.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to retrieve linked action items for.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Meeting.Controller.Public.MeetingActionItemsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/meetings/{meeting_id}/action-items/{action_item_id}":{"put":{"tags":["Meetings"],"summary":"Attach Action Item to Meeting","description":"Attach an existing action item to a meeting to include it as a discussion topic or tracked deliverable from the meeting.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to attach the action item to.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"},{"name":"action_item_id","in":"path","description":"The unique identifier of the action item to attach to the meeting.\r\nThis action item must belong to the same client as the meeting.","required":true,"schema":{"type":"string","example":"xmk8hj32"},"example":"xmk8hj32"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Meetings"],"summary":"Detach Action Item from Meeting","description":"Detach an action item and a meeting without deleting the action item itself, allowing the task to exist independently.","parameters":[{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to detach the action item from.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"},{"name":"action_item_id","in":"path","description":"The unique identifier of the action item to detach from the meeting.\r\nThe action item will continue to exist but will no longer be associated with this meeting.","required":true,"schema":{"type":"string","example":"xmk8hj32"},"example":"xmk8hj32"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{id}/status":{"put":{"tags":["Initiatives"],"summary":"Update Initiative Status","description":"Change the current status of an initiative to reflect its progress in the business workflow.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateStatus_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateStatus_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateStatus_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateStatus_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{id}/schedule":{"put":{"tags":["Initiatives"],"summary":"Schedule Initiative Fiscal Quarter","description":"Update the fiscal planning timeline for when resources will be allocated to this initiative.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateSchedule_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateSchedule_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateSchedule_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateSchedule_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{id}/recurring":{"put":{"tags":["Initiatives"],"summary":"Update Initiative Recurring Investments","description":"Manage the ongoing financial commitments of an initiative by updating the complete set of monthly or yearly recurring expenses.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateRecurring_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateRecurring_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateRecurring_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateRecurring_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{id}/priority":{"put":{"tags":["Initiatives"],"summary":"Update Initiative Priority","description":"Adjust the business priority level of an initiative to reflect its strategic importance.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdatePriority_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdatePriority_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdatePriority_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdatePriority_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{id}/budget":{"put":{"tags":["Initiatives"],"summary":"Update Initiative One-Time Investments","description":"Revise the complete financial plan for an initiative by providing a comprehensive breakdown of all one-time costs and investments.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateBudget_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateBudget_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateBudget_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdateBudget_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiative-templates/{initiative_template_id}":{"delete":{"tags":["Initiative Templates"],"summary":"Delete Initiative Template","description":"Delete an account-scoped initiative template that is no longer needed.","parameters":[{"name":"initiative_template_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Initiative Templates"],"summary":"Get Initiative Template","description":"Retrieve a specific initiative template by its unique identifier.","parameters":[{"name":"initiative_template_id","in":"path","description":"Unique identifier of the initiative template to retrieve.","required":true,"schema":{"type":"string","example":"abc123de"},"example":"abc123de"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Initiative Templates"],"summary":"Update Initiative Template","description":"Update an account-scoped initiative template's name, summary, budget, recurring costs, and action items.","parameters":[{"name":"initiative_template_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiative-templates":{"post":{"tags":["Initiative Templates"],"summary":"Create Initiative Template","description":"Create a new account-scoped initiative template with budget, recurring costs, and action items.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Initiative Templates"],"summary":"List Initiative Templates","description":"Retrieve all initiative templates available to the account, grouped by platform-provided and account-created.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/template/{initiative_template_id}/apply":{"put":{"tags":["Initiatives"],"summary":"Apply Initiative Template","description":"Apply an initiative template to an existing initiative, replacing its budget, recurring costs, and action items.","parameters":[{"name":"initiative_id","in":"path","description":"Unique identifier of the initiative to apply the template to.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"},{"name":"initiative_template_id","in":"path","description":"Unique identifier of the template to apply to the initiative.","required":true,"schema":{"type":"string","example":"abc123de"},"example":"abc123de"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/meetings":{"get":{"tags":["Initiatives"],"summary":"List Initiative Meetings","description":"Retrieve the meetings that are aligned with a specific initiative, enabling MSPs to track discussions and reviews related to the initiative.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to retrieve aligned meetings for.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeMeetingsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/meetings/{meeting_id}":{"put":{"tags":["Initiatives"],"summary":"Attach Meeting to Initiative","description":"Attach an existing meeting to an initiative to establish alignment between client discussions and implementation efforts.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to attach the meeting to.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"},{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to attach to the initiative.\r\nThis meeting should belong to the same client as the initiative.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Initiatives"],"summary":"Detach Meeting from Initiative","description":"Detach a meeting and an initiative, without deleting either entity.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to detach the meeting from.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"},{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to detach from the initiative.\r\nThe meeting will remain in the system but will no longer be linked to this initiative.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/goals":{"get":{"tags":["Initiatives"],"summary":"List Initiative Goals","description":"Retrieve all goals that are aligned with a specific initiative, enabling visibility into how initiatives support broader business objectives.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to retrieve aligned goals for.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeGoalsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/goals/{goal_id}":{"put":{"tags":["Initiatives"],"summary":"Attach Goal to Initiative","description":"Attach an existing goal to an initiative to establish alignment between strategic objectives and implementation efforts.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to attach the goal to.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"},{"name":"goal_id","in":"path","description":"The unique identifier of the goal to attach to the initiative.\r\nThis goal should belong to the same client as the initiative.","required":true,"schema":{"type":"string","example":"pug5gz77"},"example":"pug5gz77"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Initiatives"],"summary":"Detach Goal from Initiative","description":"Detach a goal and an initiative, without deleting either entity.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to detach the goal from.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"},{"name":"goal_id","in":"path","description":"The unique identifier of the goal to detach from the initiative.\r\nThe goal will remain in the system but will no longer be linked to this initiative.","required":true,"schema":{"type":"string","example":"pus5gz77"},"example":"pus5gz77"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{id}":{"delete":{"tags":["Initiatives"],"summary":"Delete Initiative","description":"Permanently remove an initiative that is no longer relevant to business operations.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Initiatives"],"summary":"Get Initiative","description":"Access complete details of a specific initiative including its budget, recurring costs, status, and all associated resources.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the initiative to retrieve.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Initiatives"],"summary":"Update Initiative","description":"Update initiative details including name, description, and other essential metadata.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives":{"post":{"tags":["Initiatives"],"summary":"Create Initiative","description":"Create a new strategic initiative with all necessary details to establish a program, project, or operational effort aligned with business goals.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Initiatives"],"summary":"List Initiatives","description":"Retrieve a comprehensive list of all strategic initiatives with filtering options.","parameters":[{"name":"filter[client.id]","in":"query","description":"Filters records by using a query string on the field `client.id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283`\n\n`filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283`","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32","example":50},"example":50},{"name":"cursor","in":"query","description":"Cursor of the current page, starts at 1.\r\n            \r\n- Cursor pagination cannot guarantee atomicity.\r\n- Endpoints may skip new records inserted between paginated reads.\r\n- Endpoints may occasionally return duplicate records.","schema":{"type":"string","example":"ABC123"},"example":"ABC123"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.Response.PagedResponse_Initiative.Model.Public.InitiativePublic_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/assets":{"put":{"tags":["Initiatives"],"summary":"Attach Assets to an Initiative","description":"Attach one or more hardware assets to an initiative by providing their unique hardware key (serial number, model, and manufacturer).","parameters":[{"name":"initiative_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetAttach_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetAttach_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetAttach_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetAttach_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Initiatives"],"summary":"Detach Assets from an Initiative","description":"Detach one or more hardware assets from an initiative without deleting either entity.","parameters":[{"name":"initiative_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetDetach_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetDetach_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetDetach_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeAssetDetach_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/action-items":{"get":{"tags":["Initiatives"],"summary":"List Initiative Action Items","description":"Retrieve all action items that are aligned with a specific initiative, enabling MSPs to track the tasks required to complete the initiative.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to retrieve aligned action items for.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Initiative.Controller.Public.InitiativeActionItemsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/initiatives/{initiative_id}/action-items/{action_item_id}":{"put":{"tags":["Initiatives"],"summary":"Attach Action Item to Initiative","description":"Attach an existing action item to an initiative to establish alignment between tasks and implementation efforts.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to attach the action item to.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"},{"name":"action_item_id","in":"path","description":"The unique identifier of the action item to attach to the initiative.\r\nThis action item should belong to the same client as the initiative.","required":true,"schema":{"type":"string","example":"xmk8hj32"},"example":"xmk8hj32"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Initiatives"],"summary":"Detach Action Item from Initiative","description":"Detach an action item and an initiative, without deleting either entity.","parameters":[{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to detach the action item from.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"},{"name":"action_item_id","in":"path","description":"The unique identifier of the action item to detach from the initiative.\r\nThe action item will remain in the system but will no longer be linked to this initiative.","required":true,"schema":{"type":"string","example":"xmk8hj32"},"example":"xmk8hj32"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goal-templates/{goal_template_id}":{"delete":{"tags":["Goal Templates"],"summary":"Goal Template Delete","description":"Delete an account-owned goal template that is no longer needed.","parameters":[{"name":"goal_template_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Goal Templates"],"summary":"Goal Template Get","description":"Retrieve full details of a specific goal template.","parameters":[{"name":"goal_template_id","in":"path","description":"Unique identifier of the goal template to retrieve.","required":true,"schema":{"type":"string","example":"fhafyiyr"},"example":"fhafyiyr"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Goal Templates"],"summary":"Goal Template Update","description":"Modify an existing account-owned goal template.","parameters":[{"name":"goal_template_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goal-templates":{"post":{"tags":["Goal Templates"],"summary":"Goal Template Create","description":"Create a new account-owned goal template.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplateCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Goal Templates"],"summary":"Get Goal Templates List","description":"Retrieve all goal templates visible to the authenticated account.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.GoalTemplate.Controller.Public.GoalTemplatesList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/{id}/status":{"put":{"tags":["Goals"],"summary":"Update Goal Status","description":"Change goal status to reflect its current state in the business workflow.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalStatusUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalStatusUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalStatusUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalStatusUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/{id}/schedule":{"put":{"tags":["Goals"],"summary":"Update Goal Schedule","description":"Update goal target period to reflect its current state in the business workflow.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalScheduleUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalScheduleUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalScheduleUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalScheduleUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/{goal_id}/meetings":{"get":{"tags":["Goals"],"summary":"List Goal Meetings","description":"Retrieve all meetings that is aligned with this goal, tracking client engagement around this strategic objective.","parameters":[{"name":"goal_id","in":"path","description":"The unique identifier of the goal to retrieve meetings for.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.Controller.Public.GoalMeetingsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/{goal_id}/meetings/{meeting_id}":{"put":{"tags":["Goals"],"summary":"Attach Meeting to Goal","description":"Attach an existing meeting to a goal to establish that this strategic objective will be discussed or reviewed during the meeting.","parameters":[{"name":"goal_id","in":"path","description":"The unique identifier of the goal to attach the meeting to.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"},{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to attach to the goal.\r\nThis meeting must belong to the same client as the goal.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Goals"],"summary":"Detach Meeting from Goal","description":"Detach a meeting and a goal without deleting the meeting itself, removing the goal from the meeting agenda.","parameters":[{"name":"goal_id","in":"path","description":"The unique identifier of the goal to detach the meeting from.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"},{"name":"meeting_id","in":"path","description":"The unique identifier of the meeting to remove from the goal.\r\nThe meeting will continue to exist but will no longer be linked to this goal.","required":true,"schema":{"type":"string","example":"mtn9kp45"},"example":"mtn9kp45"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/{goal_id}/initiatives":{"get":{"tags":["Goals"],"summary":"List Goal Initiatives","description":"Retrieve all initiatives that are aligned with this goal, showing the projects that contribute to achieving this objective.","parameters":[{"name":"goal_id","in":"path","description":"The unique identifier of the goal to retrieve initiatives for.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.Controller.Public.GoalInitiativesList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/{goal_id}/initiatives/{initiative_id}":{"put":{"tags":["Goals"],"summary":"Attach Initiative to Goal","description":"Attach an existing initiative to a goal to establish a relationship between the strategic objective and the project that contributes to achieving it.","parameters":[{"name":"goal_id","in":"path","description":"The unique identifier of the goal to attach the initiative to.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"},{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to attach to the goal.\r\nThis initiative must belong to the same client as the goal.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Goals"],"summary":"Detach Initiative from Goal","description":"Detach an initiative and a goal without deleting the initiative itself, so it no longer contributes to this objective.","parameters":[{"name":"goal_id","in":"path","description":"The unique identifier of the goal to detach the initiative from.","required":true,"schema":{"type":"string","example":"gk7mn2p4"},"example":"gk7mn2p4"},{"name":"initiative_id","in":"path","description":"The unique identifier of the initiative to remove from the goal.\r\nThe initiative will continue to exist but will no longer be linked to this goal.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/{id}":{"delete":{"tags":["Goals"],"summary":"Delete Goal","description":"Deletes a goal that is no longer relevant to business operations.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Goals"],"summary":"Get Goal","description":"Gets a goal record in Lifecycle Manager by the goal's id.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the goal to retrieve.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.Model.Public.GoalOverviewPublic"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Goals"],"summary":"Update Goal","description":"Update goal details including title, description, status, and target period.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals/create-from/template/{goal_template_id}":{"post":{"tags":["Goals"],"summary":"Goal Create from Template","description":"Create a new goal from an existing goal template.","parameters":[{"name":"goal_template_id","in":"path","description":"The ID of the goal template from which to create the goal.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreateFromTemplate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreateFromTemplate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreateFromTemplate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreateFromTemplate_Request"}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreateFromTemplate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/goals":{"post":{"tags":["Goals"],"summary":"Create Goal","description":"Create a new goal with all necessary details to establish a measurable objective.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Goal.Controller.Public.GoalCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Goals"],"summary":"List Goals","description":"List all goals to help you quickly find relevant objectives with filtering options.","parameters":[{"name":"filter[client.id]","in":"query","description":"Filters records by using a query string on the field `client.id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283`\n\n`filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283`","schema":{"type":"string"}},{"name":"filter[title]","in":"query","description":"Filters records by using a query string on the field `title`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[title]=example_string`\n\n`filter[title]=eq:example_string`","schema":{"type":"string"}},{"name":"filter[status]","in":"query","description":"Filters records by using a query string on the field `status`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[status]=example_string`\n\n`filter[status]=eq:example_string`\n\nAvailable values: `AtRisk`, `Complete`, `OffTrack`, `OnHold`, `OnTrack`.","schema":{"type":"string"}},{"name":"filter[period.year]","in":"query","description":"Filters records by using a query string on the field `period.year`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[period.year]=123`\n\n`filter[period.year]=eq:123`","schema":{"type":"string"}},{"name":"filter[period.half]","in":"query","description":"Filters records by using a query string on the field `period.half`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[period.half]=1,2,3,4`\n\n`filter[period.half]=eq:1,2,3,4`","schema":{"type":"string"}},{"name":"filter[period.quarter]","in":"query","description":"Filters records by using a query string on the field `period.quarter`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[period.quarter]=1,2,3,4`\n\n`filter[period.quarter]=eq:1,2,3,4`","schema":{"type":"string"}},{"name":"sort","in":"query","description":"One or more sortable fields, separated by commas. Prefix with '+' to sort ascending or '-' to sort descending.\n\n Available values: period.half, period.quarter, period.year, title","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32","example":50},"example":50},{"name":"cursor","in":"query","description":"Cursor of the current page, starts at 1.\r\n            \r\n- Cursor pagination cannot guarantee atomicity.\r\n- Endpoints may skip new records inserted between paginated reads.\r\n- Endpoints may occasionally return duplicate records.","schema":{"type":"string","example":"ABC123"},"example":"ABC123"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.Response.PagedResponse_Goal.Model.Public.GoalOverviewPublic_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/action-items/{id}/completion-status":{"put":{"tags":["Action Items"],"summary":"Update Action Item Completion Status","description":"Mark an action item as incomplete or completed to reflect the status of an action item.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionMarkCompleted_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionMarkCompleted_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionMarkCompleted_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionMarkCompleted_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/action-items/{id}":{"delete":{"tags":["Action Items"],"summary":"Delete Action Item","description":"Deletes an action item that is no longer relevant to business operations.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Action Items"],"summary":"Get Action Item","description":"Get an action item by the item's id. The returned data includes Action item details and linked entities.","parameters":[{"name":"id","in":"path","description":"Unique identifier of the action item to retrieve.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Model.Public.EngagementActionPublic"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Action Items"],"summary":"Update Action Item","description":"Update an existing action item with all necessary details for an action.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/action-items":{"post":{"tags":["Action Items"],"summary":"Create Action Item","description":"Create a new action item with all necessary details to establish a measurable objective.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Controller.Public.EngagementActionCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Action Items"],"summary":"List Action Items","description":"Get a list of action items. The returned data includes Action item details and linked entities.","parameters":[{"name":"filter[client.id]","in":"query","description":"Filters records by using a query string on the field `client.id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283`\n\n`filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283`","schema":{"type":"string"}},{"name":"filter[is_completed]","in":"query","description":"Filters records by using a query string on the field `is_completed`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[is_completed]=true`\n\n`filter[is_completed]=eq:true`","schema":{"type":"string"}},{"name":"filter[is_overdue]","in":"query","description":"Filters records by using a query string on the field `is_overdue`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[is_overdue]=true`\n\n`filter[is_overdue]=eq:true`","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32","example":50},"example":50},{"name":"cursor","in":"query","description":"Cursor of the current page, starts at 1.\r\n            \r\n- Cursor pagination cannot guarantee atomicity.\r\n- Endpoints may skip new records inserted between paginated reads.\r\n- Endpoints may occasionally return duplicate records.","schema":{"type":"string","example":"ABC123"},"example":"ABC123"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.Response.PagedResponse_Organization.Engagement.EngagementAction.Model.Public.EngagementActionPublic_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/pdf":{"get":{"tags":["Deliverables"],"summary":"Download a deliverable PDF","description":"Download a PDF for the specified deliverable. The server returns an attachment and supplies a filename.","operationId":"download-deliverable","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable to download as PDF","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}":{"delete":{"tags":["Deliverables"],"summary":"Delete a deliverable","description":"Deletes a deliverable by its ID, including all associated sections and components.","operationId":"delete-deliverable","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Deliverables"],"summary":"Get a single deliverable by its ID.","description":"This endpoint retrieves a deliverable by its ID, including all sections and components.","operationId":"get-deliverable","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"patch":{"tags":["Deliverables"],"summary":"Patch updates an existing deliverable.","description":"This endpoint updates an existing deliverable with the provided fields.\r\nOnly the fields provided in the request body will be updated.\r\nAll fields are optional to support partial updates.\r\n            \r\nWhen updating sections:\r\n- Sections with an 'id' are updated\r\n- Sections without an 'id' are created as new sections\r\n- Existing sections not included in the request remain unchanged","operationId":"update-deliverable","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The update deliverable request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverablePatch_Request"}],"description":"Request payload for updating a deliverable.\r\nAll fields are optional but at least one must be provided for a valid update."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverablePatch_Request"}],"description":"Request payload for updating a deliverable.\r\nAll fields are optional but at least one must be provided for a valid update."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverablePatch_Request"}],"description":"Request payload for updating a deliverable.\r\nAll fields are optional but at least one must be provided for a valid update."}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverablePatch_Request"}],"description":"Request payload for updating a deliverable.\r\nAll fields are optional but at least one must be provided for a valid update."}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.Controller.DeliverablePatch_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/clients/{client-id}/deliverables/create-from/template/{template-id}":{"post":{"tags":["Deliverables"],"summary":"Creates a new deliverable from an existing template for a specified client.","description":"This endpoint creates a new deliverable by copying an existing template.\r\nThe source template can be either a ScalePad template (available to all accounts) or a custom template owned by the account.","operationId":"create-deliverable-from-template","parameters":[{"name":"client-id","in":"path","description":"The ID of the client for which the deliverable will be created","required":true,"schema":{"type":"string"}},{"name":"template-id","in":"path","description":"The ID of the template from which to create the deliverable","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreateFromTemplate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreateFromTemplate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreateFromTemplate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreateFromTemplate_Request"}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreateFromTemplate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/clients/{client-id}/deliverables":{"post":{"tags":["Deliverables"],"summary":"Creates a new deliverable for a specified client.","description":"This endpoint creates a new deliverable for the specified client.","operationId":"create-deliverable","parameters":[{"name":"client-id","in":"path","description":"The ID of the client for which the deliverable is being created","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The create deliverable request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreate_Request"}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Deliverables"],"summary":"List all deliverables for a client","description":"Lists all deliverable available for the specified client.","operationId":"list-deliverables","parameters":[{"name":"client-id","in":"path","description":"The ID of the client to list deliverables for","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.Controller.DeliverableList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/clients/{client-id}/deliverables/catalog/components":{"get":{"tags":["Deliverables"],"summary":"List all deliverable catalog components for a client","description":"Lists all deliverable catalog components available for the specified client. These components are available to be included in a new or existing deliverable for the client.\r\nThese components include Lifecycle Manager components as well as any vendor integration components that have been set up for the client.","operationId":"list-deliverable-catalog-components","parameters":[{"name":"client-id","in":"path","description":"The ID of the client","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.Controller.DeliverableCatalogList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/catalog/integrations":{"get":{"tags":["Deliverables"],"summary":"List all available deliverable integrations","description":"Lists all available deliverable integrations in the catalog. These are vendor integrations that can be configured for clients.","operationId":"list-deliverable-catalog-integrations","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogIntegration.Controller.DeliverableCatalogIntegrationList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/clients/{client-id}/deliverables/integrations/integrated":{"get":{"tags":["Deliverables"],"summary":"List deliverable integrations that are integrated for a client","description":"List deliverable integrations that are integrated for a client, including their configuration, status and vendor details.","operationId":"list-deliverable-integrations-integrated","parameters":[{"name":"client-id","in":"path","description":"The ID of the client","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableIntegration.Controller.DeliverableIntegrationList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/presentation":{"get":{"tags":["Deliverables"],"summary":"Get a deliverable for presentation by its ID.","description":"This endpoint retrieves a deliverable for presentation purposes.\r\nReturns only the data required for rendering (name, client name, sections with components output).\r\nIncludes MSP branding information for the presentation header.","operationId":"get-deliverable-presentation","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable to retrieve for presentation","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverablePresentation.Controller.DeliverablePresentationGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/sections/{section-id}/refresh":{"post":{"tags":["Deliverables"],"summary":"Refreshes a deliverable section","description":"This endpoint refreshes the data of all the components under a deliverable section.","operationId":"refresh-deliverable-section","parameters":[{"name":"deliverable-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"section-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/sections/{section-id}":{"delete":{"tags":["Deliverables"],"summary":"Delete a deliverable section","description":"Deletes a deliverable section by its ID, including all associated components.","operationId":"delete-deliverable-section","parameters":[{"name":"deliverable-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"section-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/sections/{section-id}/components/{component-id}/refresh":{"post":{"tags":["Deliverables"],"summary":"Refreshes a deliverable section component","description":"This endpoint refreshes the data of a deliverable section component.","operationId":"refresh-deliverable-section-component","parameters":[{"name":"deliverable-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"section-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"component-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/sections/{section-id}/components/{component-id}":{"delete":{"tags":["Deliverables"],"summary":"Delete a deliverable section component","description":"Deletes a deliverable section component by its ID","operationId":"delete-deliverable-section-component","parameters":[{"name":"deliverable-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"section-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"component-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/templates/{template-id}":{"delete":{"tags":["Deliverables"],"summary":"Delete a deliverable template","description":"Deletes a deliverable template by its ID, including all associated sections and components.","operationId":"delete-deliverable-template","parameters":[{"name":"template-id","in":"path","description":"The ID of the deliverable template to delete","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Deliverables"],"summary":"Retrieves a single deliverable template by its ID.","description":"This endpoint retrieves a deliverable template by its ID, including all sections and components.\r\nTemplates can be either ScalePad templates (available to all accounts) or custom templates owned by the account.","operationId":"get-deliverable-template","parameters":[{"name":"template-id","in":"path","description":"The ID of the deliverable template to retrieve","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"patch":{"tags":["Deliverables"],"summary":"Patch updates an existing deliverable template.","description":"This endpoint updates an existing deliverable template with the provided fields.\r\nOnly the fields provided in the request body will be updated.\r\nAll fields are optional to support partial updates.\r\n            \r\nWhen updating sections:\r\n- Sections with an 'id' are updated\r\n- Sections without an 'id' are created as new sections\r\n- Existing sections not included in the request remain unchanged","operationId":"update-deliverable-template","parameters":[{"name":"template-id","in":"path","description":"The ID of the deliverable template to update","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The update deliverable template request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplatePatch_Request"}],"description":"Request payload for updating a deliverable template.\r\nAll fields are optional but at least one must be provided for a valid update."}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplatePatch_Request"}],"description":"Request payload for updating a deliverable template.\r\nAll fields are optional but at least one must be provided for a valid update."}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplatePatch_Request"}],"description":"Request payload for updating a deliverable template.\r\nAll fields are optional but at least one must be provided for a valid update."}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplatePatch_Request"}],"description":"Request payload for updating a deliverable template.\r\nAll fields are optional but at least one must be provided for a valid update."}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplatePatch_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/templates/create-from/template/{template-id}":{"post":{"tags":["Deliverables"],"summary":"Creates a new deliverable template from an existing template.","description":"This endpoint creates a new deliverable template by copying an existing template.\r\nThe source template can be either a ScalePad template (available to all accounts) or a custom template owned by the account.","operationId":"create-deliverable-template-from-template","parameters":[{"name":"template-id","in":"path","description":"The ID of the source deliverable template to create from","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreateFromTemplate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/templates/create-from/deliverable/{deliverable-id}":{"post":{"tags":["Deliverables"],"summary":"Creates a new deliverable template from an existing deliverable.","description":"This endpoint creates a new deliverable template by extracting the structure from an existing deliverable.","operationId":"create-deliverable-template-from-deliverable","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the source deliverable to create a template from","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreateFromDeliverable_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/templates":{"post":{"tags":["Deliverables"],"summary":"Creates a new deliverable template.","description":"This endpoint creates a new deliverable template for the account.\r\nTemplates can be used to create new deliverables with pre-configured sections and components.","operationId":"create-deliverable-template","requestBody":{"description":"The create deliverable template request","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Response"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Deliverables"],"summary":"List all deliverable templates","description":"Lists all deliverable templates available, including both ScalePad and custom templates.","operationId":"list-deliverable-templates","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Controller.DeliverableTemplateList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/templates/catalog/components":{"get":{"tags":["Deliverables"],"summary":"List all deliverable catalog components available for templates","description":"This endpoint lists all deliverable catalog components available for use in templates.","operationId":"list-deliverable-template-catalog-components","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.DeliverableTemplateCatalog.Controller.DeliverableTemplateCatalogList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/templates/{template-id}/sections/{section-id}":{"delete":{"tags":["Deliverables"],"summary":"Delete a deliverable template section","description":"Deletes a deliverable template section by its ID, including all associated components.","operationId":"delete-deliverable-template-section","parameters":[{"name":"template-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"section-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/templates/{template-id}/sections/{section-id}/components/{component-id}":{"delete":{"tags":["Deliverables"],"summary":"Delete a deliverable template section component","description":"Deletes a deliverable template section component by its ID","operationId":"delete-deliverable-template-section-component","parameters":[{"name":"template-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"section-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"component-id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/shares/general-link/revoke":{"post":{"tags":["Deliverables"],"summary":"Revokes deliverable general share link","description":"This endpoint revokes the general share link for the specified deliverable.\r\nOnce revoked, the share link can no longer be used to access the deliverable.\r\nIf no share link exists, a 404 Not Found error is returned.","operationId":"revoke-deliverable-share-general-link","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable for which to revoke the general share link","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareAccess.DeliverableShareGeneralLink.Controller.DeliverableShareGeneralLinkRevoke_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/shares/general-link/regenerate":{"post":{"tags":["Deliverables"],"summary":"Regenerates deliverable general share link","description":"This endpoint generates a new general share link for the specified deliverable.\r\nThe existing link is revoked and a new link with a new password is created.\r\nIf no share link already exists, a 404 Not Found error is returned.","operationId":"regenerate-deliverable-share-general-link","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable for which to regenerate the share link","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareAccess.DeliverableShareGeneralLink.Controller.DeliverableShareGeneralLinkRegenerate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ConflictApiError_"}}}}}}},"/lifecycle-manager/v1/deliverables/{deliverable-id}/shares/general-link":{"post":{"tags":["Deliverables"],"summary":"Creates a general share link for a deliverable.","description":"This endpoint creates a new general share link for the specified deliverable.\r\nIf any share link has ever existed (active, expired, or revoked), a 409 Conflict error is returned.\r\nUse the regenerate method to create a new link when one already exists.","operationId":"create-deliverable-share-general-link","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable for which to create a general share link","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShareAccess.DeliverableShareGeneralLink.Controller.DeliverableShareGeneralLinkCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ConflictApiError_"}}}}}},"get":{"tags":["Deliverables"],"summary":"Get deliverable general share link","description":"This endpoint retrieves the general share link for a specific deliverable.\r\nReturns 404 if no share link exists for the deliverable.","operationId":"get-deliverable-share-general-link","parameters":[{"name":"deliverable-id","in":"path","description":"The ID of the deliverable","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deliverable.DeliverableShare.Controller.DeliverableShareGeneralLinkGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/contracts/{id}":{"delete":{"tags":["Contracts"],"summary":"Delete Contract","description":"Permanently remove an contract that is no longer relevant to business operations.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Contracts"],"summary":"Get Contract","description":"Access complete details of a specific contract.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the contract to retrieve.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Contracts"],"summary":"Update Contract","description":"Update a contract with full details.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/contracts":{"post":{"tags":["Contracts"],"summary":"Create Contract","description":"Create a new contract.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contract.Controller.Public.ContractsCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Contracts"],"summary":"List Contracts","description":"Retrieve a comprehensive list of all contracts overview with filtering options.","parameters":[{"name":"filter[client.id]","in":"query","description":"Filters records by using a query string on the field `client.id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283`\n\n`filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283`","schema":{"type":"string"}},{"name":"filter[expiry_status]","in":"query","description":"Filters records by using a query string on the field `expiry_status`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[expiry_status]=example_string`\n\n`filter[expiry_status]=eq:example_string`\n\nAvailable values: `Expires90Days`, `Expired`.","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32","example":50},"example":50},{"name":"cursor","in":"query","description":"Cursor of the current page, starts at 1.\r\n            \r\n- Cursor pagination cannot guarantee atomicity.\r\n- Endpoints may skip new records inserted between paginated reads.\r\n- Endpoints may occasionally return duplicate records.","schema":{"type":"string","example":"ABC123"},"example":"ABC123"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.Response.PagedResponse_Contract.Model.Public.ContractOverviewApi_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/clients/client-groups/lookup":{"post":{"tags":["Clients"],"summary":"Clients Group List","description":"List the client groups assigned to a specific client.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Controller.Public.ClientsClientGroupsList_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Controller.Public.ClientsClientGroupsList_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Controller.Public.ClientsClientGroupsList_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.Controller.Public.ClientsClientGroupsList_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization.Controller.Public.ClientsClientGroupsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/client-groups":{"get":{"tags":["Client Groups"],"summary":"Client Group List","description":"List all client groups for the authenticated partner account.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupsList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/client-groups/{client_group_id}":{"get":{"tags":["Client Groups"],"summary":"Client Group Get","description":"Get the details of a single client group, including its assigned users and clients.","parameters":[{"name":"client_group_id","in":"path","description":"The unique identifier of the client group to retrieve.","required":true,"schema":{"type":"string","example":"abc123de"},"example":"abc123de"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupsGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/client-groups/{client_group_id}/assignments":{"post":{"tags":["Client Groups"],"summary":"Client Group Assign","description":"Assign clients and users to a client group.","parameters":[{"name":"client_group_id","in":"path","description":"The unique identifier of the client group that will receive the client.","required":true,"schema":{"type":"string","example":"abc123de"},"example":"abc123de"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMembersAssign_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMembersAssign_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMembersAssign_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMembersAssign_Request"}]}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Controller.Controller.EmptyResponse"}}}},"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"delete":{"tags":["Client Groups"],"summary":"Client Group Unassign","description":"Remove clients and users from a client group.","parameters":[{"name":"client_group_id","in":"path","description":"The unique identifier of the client group that currently contains the client.","required":true,"schema":{"type":"string","example":"abc123de"},"example":"abc123de"}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMemberUnassign_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMemberUnassign_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMemberUnassign_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Controller.Public.ClientGroupMemberUnassign_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assets/hardware/lifecycles":{"get":{"tags":["Assets"],"summary":"List active hardware lifecycle records","description":"Retrieves a list of active hardware lifecycle records from Lifecycle Manager.\r\nThe returned data includes basic device information, such as model and serial number, as well as purchase date and warranty expiry metadata.\r\nSupports optional filtering by client ID and serial number to narrow down results.","parameters":[{"name":"filter[client_id]","in":"query","description":"Filters records by using a query string on the field `client_id`\r\nQuery examples:\r\n- `filter[client_id]=a9b3f47d-7b39-4d1e-b320-fdd9b72b8ab5` - returns records for the organization with ID a9b3f47d-7b39-4d1e-b320-fdd9b72b8ab5","schema":{"type":"string"}},{"name":"filter[serial_number]","in":"query","description":"Filters records by using a query string on the field `serial_number`\r\nQuery examples:\r\n- `filter[serial_number]=ABCDEF123456` - returns records for the serial number ABCDEF123456","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32"}},{"name":"cursor","in":"query","description":"The pointer used to fetch a certain page of records","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetManagement.Asset.Hardware.Controller.AssetsHardwareLifecycle_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}}}}},"/lifecycle-manager/v1/assets/hardware/attached-initiatives/lookup":{"post":{"tags":["Assets"],"summary":"List Attached Initiatives","description":"Retrieve the initiatives attached to a hardware asset identified by its unique key.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AssetManagement.Asset.Hardware.Controller.Public.AssetsHardwareAttachedInitiatives_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AssetManagement.Asset.Hardware.Controller.Public.AssetsHardwareAttachedInitiatives_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AssetManagement.Asset.Hardware.Controller.Public.AssetsHardwareAttachedInitiatives_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/AssetManagement.Asset.Hardware.Controller.Public.AssetsHardwareAttachedInitiatives_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssetManagement.Asset.Hardware.Controller.Public.AssetsHardwareAttachedInitiatives_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessment-templates/{assessment_template_id}":{"delete":{"tags":["Assessment Templates"],"summary":"Delete Assessment Template","description":"Permanently remove an assessment template that is no longer needed.","parameters":[{"name":"assessment_template_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Assessment Templates"],"summary":"Get Assessment Template","description":"Retrieve comprehensive details of a specific assessment template including all categories, questions, and criteria.","parameters":[{"name":"assessment_template_id","in":"path","description":"The unique identifier of the assessment template to retrieve.","required":true,"schema":{"type":"string","example":"yd7ja7gd"},"example":"yd7ja7gd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Assessment Templates"],"summary":"Update Assessment Template","description":"Modify an existing assessment template including its structure, categories, questions, and criteria.","parameters":[{"name":"assessment_template_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessment-templates":{"post":{"tags":["Assessment Templates"],"summary":"Create Assessment Template","description":"Create a new assessment template with custom categories, questions, and criteria.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Assessment Templates"],"summary":"List Assessment Templates","description":"Retrieve a comprehensive list of all assessment template overviews for the account.","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplatesList_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessments/{assessment_id}/questions/{question_id}/comment/public":{"put":{"tags":["Assessments"],"description":"Write or replace the public comment for a specific assessment question so the note can be shared in assessment output.","operationId":"ApiPublicV1AssessmentsQuestionCommentPublicUpsert","parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"question_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessments/{assessment_id}/questions/{question_id}/comment/internal":{"put":{"tags":["Assessments"],"description":"Write or replace the private internal comment for a specific assessment question. This note is visible only to the MSP.","operationId":"ApiPublicV1AssessmentsQuestionCommentInternalUpsert","parameters":[{"name":"assessment_id","in":"path","required":true,"schema":{"type":"string"}},{"name":"question_id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessments/{id}/internal-comment":{"put":{"tags":["Assessments"],"summary":"Update Assessment Internal Comment","description":"Leave an internal comment for an existing assessment. This note is private and is only visible to the MSP.","operationId":"ApiPublicV1AssessmentsInternalCommentUpsert","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsInternalCommentUpsert_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsInternalCommentUpsert_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsInternalCommentUpsert_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsInternalCommentUpsert_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessments/{id}/evaluate":{"put":{"tags":["Assessments"],"summary":"Evaluate Assessment","description":"Evaluate an assessment by selecting criteria for multiple questions.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsEvaluate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsEvaluate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsEvaluate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsEvaluate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessments/{id}":{"delete":{"tags":["Assessments"],"summary":"Delete Assessment","description":"Permanently remove an assessment that is no longer relevant to business operations.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Assessments"],"summary":"Get Assessment","description":"Access complete details of a specific assessment including its evaluation.","parameters":[{"name":"id","in":"path","description":"The unique identifier of the assessment to retrieve.","required":true,"schema":{"type":"string","example":"dhka7gwd"},"example":"dhka7gwd"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsGet_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"put":{"tags":["Assessments"],"summary":"Update Assessment","description":"Update assessment details including title, evaluate user and datetime.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessments":{"post":{"tags":["Assessments"],"summary":"Create Assessment","description":"Create a new assessment based on a assessment template.","requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCreate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCreate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCreate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCreate_Request"}]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCreate_Response"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}},"get":{"tags":["Assessments"],"summary":"List Assessments","description":"Retrieve a comprehensive list of all assessments overview with filtering options.","parameters":[{"name":"filter[client.id]","in":"query","description":"Filters records by using a query string on the field `client.id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[client.id]=0d3e7d0k-241a-461r-av15-758a90d70283`\n\n`filter[client.id]=eq:0d3e7d0k-241a-461r-av15-758a90d70283`","schema":{"type":"string"}},{"name":"filter[status]","in":"query","description":"Filters records by using a query string on the field `status`.\n\nSupports comparison operators `eq`, `in`.\n\nQuery examples:\n\n`filter[status]=example_string`\n\n`filter[status]=eq:example_string`\n\n`filter[status]=in:example_string`\n\nAvailable values: `Completed`, `InProgress`.","schema":{"type":"string"}},{"name":"filter[assessment_template_id]","in":"query","description":"Filters records by using a query string on the field `assessment_template_id`.\n\nSupports comparison operators `eq`.\n\nQuery examples:\n\n`filter[assessment_template_id]=example_string`\n\n`filter[assessment_template_id]=eq:example_string`","schema":{"type":"string"}},{"name":"page_size","in":"query","description":"The number of records to be returned in a single page","schema":{"type":"integer","format":"int32","example":50},"example":50},{"name":"cursor","in":"query","description":"Cursor of the current page, starts at 1.\r\n            \r\n- Cursor pagination cannot guarantee atomicity.\r\n- Endpoints may skip new records inserted between paginated reads.\r\n- Endpoints may occasionally return duplicate records.","schema":{"type":"string","example":"ABC123"},"example":"ABC123"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.Response.PagedResponse_Assessment.AssessmentEvaluation.Model.Public.AssessmentOverviewApi_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}},"/lifecycle-manager/v1/assessments/{id}/completion-status":{"put":{"tags":["Assessments"],"summary":"Update Assessment Completion Status","description":"Toggle an assessment's complete status.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCompletionStatusUpdate_Request"}]}},"text/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCompletionStatusUpdate_Request"}]}},"application/*+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCompletionStatusUpdate_Request"}]}},"application/json-patch+json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCompletionStatusUpdate_Request"}]}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_"}}}}}}}},"components":{"schemas":{"Assessment.AssessmentEvaluation.AssessmentEvaluationQuestion.AssessmentEvaluationQuestionComment.Controller.Public.AssessmentsQuestionCommentUpsertRequest":{"type":"object","properties":{"comment_plain_text":{"type":"string","description":"Plain-text representation of the comment. When `comment_json` is also provided, this value must match its extracted text. Send an empty string to clear the existing comment.","nullable":true,"example":"This control is partially implemented and needs follow-up next quarter."},"comment_json":{"type":"string","description":"Rich-text comment content in the ProseMirror JSON format used across ScalePad products. Provide this for formatting-preserving writes. Requests using unsupported node or mark types are rejected so the saved content remains compatible with ScalePad rich-text editors.","nullable":true,"example":"{ \"type\": \"doc\", \"content\": [ { \"type\": \"paragraph\", \"content\": [ { \"type\": \"text\", \"text\": \"This control is partially implemented and needs follow-up next quarter.\" } ] } ] }"}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCompletionStatusUpdate_Request":{"required":["is_completed"],"type":"object","properties":{"is_completed":{"type":"boolean","description":"Indicates the desired completion state of the assessment. Set to `true` to mark the assessment as completed, or `false` to mark it as incomplete.","example":true}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCreate_Request":{"required":["assessment_template_id","client_key","evaluate_at","evaluate_user_id","title"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the assessment for."},"title":{"type":"string","description":"The title of the assessment evaluation to be created","example":"Cybersecurity Assessment Q3 2025"},"assessment_template_id":{"type":"string","description":"The unique Id of the assessment template the evaluation is created from","example":"yd7ja7gd"},"evaluate_user_id":{"type":"string","description":"The unique Id of the user who performed the assessment evaluation","example":"216bbe15-aabc-4ab2-a187-520d57c999cf"},"evaluate_at":{"type":"string","description":"The date and time the assessment evaluation was performed","format":"date-time","example":"2025-09-30T00:00:00Z"}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Controller.Public.AssessmentsCreate_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Id of the created assessment","example":"dhka7gwd"}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Controller.Public.AssessmentsEvaluate_Request":{"required":["question_evaluations"],"type":"object","properties":{"question_evaluations":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.QuestionEvaluationPayload"},"description":"A collection of question evaluation payloads. Each payload specifies a question and the criterion selected as the answer for that question during the assessment evaluation."}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Controller.Public.AssessmentsGet_Response":{"required":["assessment"],"type":"object","properties":{"assessment":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.AssessmentApi"}],"description":"The complete assessment object containing all evaluation details, categories, questions, criteria, and scoring information."}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Controller.Public.AssessmentsInternalCommentUpsert_Request":{"required":["internal_comment"],"type":"object","properties":{"internal_comment":{"type":"string","description":"Private notes visible only to the MSP.","example":"This should be mark as incomplete"}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Controller.Public.AssessmentsUpdate_Request":{"required":["evaluate_at","evaluate_user_id","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the assessment evaluation to be created","example":"Cybersecurity Assessment Q3 2025"},"evaluate_user_id":{"type":"string","description":"The unique Id of the user who performed the assessment evaluation","example":"216bbe15-aabc-4ab2-a187-520d57c999cf"},"evaluate_at":{"type":"string","description":"The date and time the assessment evaluation was performed","format":"date-time","example":"2025-09-30T00:00:00Z"}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Model.Public.AssessmentApi":{"required":["assessment_template_id","category_list","client","description","evaluate_user_id","evaluated_at","id","record_created_at","status","title","updated_at"],"type":"object","properties":{"id":{"type":"string","description":"Unique Id of the assessment","example":"dhka7gwd"},"assessment_template_id":{"type":"string","description":"The unique Id of the assessment template the assessment is created from","example":"vfka7gwd"},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"Information about the client for which the assessment is created"},"title":{"type":"string","description":"Title of the assessment","example":"Security Assessment for Project X"},"description":{"type":"string","description":"Description of the assessment","example":"This assessment covers the security posture of Project X"},"internal_comment":{"type":"string","description":"Internal comment on the evaluation","nullable":true,"example":"Overall good security posture, but needs improvement in access controls."},"evaluate_user_id":{"type":"string","description":"User id who performed the evaluation","example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"record_created_at":{"type":"string","description":"Date time the assessment was created","format":"date-time","example":"2025-09-29T16:21:34Z"},"evaluated_at":{"type":"string","description":"Date time the evaluation is scheduled or performed","format":"date-time","example":"2025-09-30T00:00:00Z"},"updated_at":{"type":"string","description":"Date time the evaluation is updated","format":"date-time","example":"2025-10-05T12:34:56Z"},"status":{"type":"string","description":"Status of the evaluation\r\nAvailable statuses: InProgress, Completed","example":"InProgress"},"category_list":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.AssessmentCategoryApi"},"description":"List of categories in the evaluation"},"overall_score":{"type":"number","description":"Overall Score of the Assessment","format":"double","nullable":true,"example":85.5}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Model.Public.AssessmentCategoryApi":{"required":["assessment_category_id","assessment_template_category_id","question_list","title"],"type":"object","properties":{"assessment_category_id":{"type":"string","description":"Unique Id of the assessment category","example":"vfka7gwd"},"assessment_template_category_id":{"type":"string","description":"The unique Id of the assessment template category the assessment category is originated from","example":"yd7ja7gd"},"title":{"type":"string","description":"Title of the category","example":"Network Security"},"description":{"type":"string","description":"Description of the category","nullable":true,"example":"This category assesses the security of network configurations and practices."},"question_list":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.AssessmentQuestionApi"},"description":"List of questions under the category"},"category_score":{"type":"number","description":"Score of the Category","format":"double","nullable":true,"example":90}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Model.Public.AssessmentCriterionApi":{"required":["assessment_criterion_id","description","display_label","is_previously_selected","is_selected","label_key"],"type":"object","properties":{"assessment_criterion_id":{"type":"string","description":"Unique Id of the criterion","example":"vfka7gwd"},"assessment_template_criterion_id":{"type":"string","description":"Unique Id of the assessment template criterion the assessment criterion is originated from (if any)","nullable":true,"example":"yd7ja7gd"},"label_key":{"type":"string","description":"Key of the display label of the criterion","example":"Yes"},"display_label":{"type":"string","description":"Display label of the criterion","example":"Yes"},"description":{"type":"string","description":"Display description of the criterion","example":"Select this option if firewalls are properly configured according to best practices."},"is_selected":{"type":"boolean","description":"If the criterion is selected for the related assessment evaluation question","example":true},"is_previously_selected":{"type":"boolean","description":"Indicates if the evaluation criteria was selected for this question in a previous evaluation using the same template","example":false}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Model.Public.AssessmentOverviewApi":{"required":["assessment_template_id","client","description","evaluate_user_id","evaluated_at","id","question_answered_count","question_count","record_created_at","status","title","updated_at"],"type":"object","properties":{"id":{"type":"string","description":"Unique Id of the assessment","example":"dhka7gwd"},"assessment_template_id":{"type":"string","description":"The unique Id of the assessment template the assessment is created from","example":"vfka7gwd"},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"Information about the client for which the assessment is created"},"title":{"type":"string","description":"Title of the assessment","example":"Security Assessment for Project X"},"description":{"type":"string","description":"Description of the assessment","example":"This assessment covers the security posture of Project X"},"evaluate_user_id":{"type":"string","description":"User who performed the evaluation","example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"record_created_at":{"type":"string","description":"Date time the assessment was created","format":"date-time","example":"2025-09-29T16:21:34Z"},"evaluated_at":{"type":"string","description":"Date time the evaluation is scheduled or performed","format":"date-time","example":"2025-09-30T00:00:00Z"},"updated_at":{"type":"string","description":"Date time the evaluation is updated","format":"date-time","example":"2025-10-05T12:34:56Z"},"status":{"type":"string","description":"Status of the evaluation\r\nAvailable statuses: InProgress, Completed","example":"InProgress"},"overall_score":{"type":"number","description":"Overall Score of the Assessment","format":"double","nullable":true,"example":85.5},"question_count":{"type":"integer","description":"Number of questions in the assessment evaluation","format":"int32","example":50},"question_answered_count":{"type":"integer","description":"Number of questions answered in the assessment evaluation","format":"int32","example":45}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Model.Public.AssessmentQuestionApi":{"required":["assessment_question_id","assessment_template_question_id","criteria_list","description","title"],"type":"object","properties":{"assessment_question_id":{"type":"string","description":"Unique Id of the assessment question","example":"lfja7gwd"},"assessment_template_question_id":{"type":"string","description":"The unique Id of the assessment template question the assessment question is originated from","example":"mkja7gwd"},"title":{"type":"string","description":"Display title of the question","example":"Are firewalls properly configured?"},"description":{"type":"string","description":"Display description of the question","example":"This question evaluates whether firewalls are set up according to best practices to protect the network."},"remediation_tips":{"type":"string","description":"Tips on the steps to remediate any identified issues for the question","nullable":true,"example":"Review firewall rules and ensure they follow the principle of least privilege."},"scoring_instructions":{"type":"string","description":"Instructions on how the score the question","nullable":true,"example":"Select Yes if no firewalls are in place and No if advanced configurations are implemented."},"criteria_list":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.AssessmentCriterionApi"},"description":"List of criteria for the question"},"public_comment":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.AssessmentQuestionCommentApi"}],"description":"Public comment on the question","nullable":true},"internal_comments":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.AssessmentQuestionCommentApi"}],"description":"Internal comment on the question, only visible to internal users","nullable":true}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Model.Public.AssessmentQuestionCommentApi":{"required":["assessment_question_comment_id","assessment_question_id","comment_json","comment_plain_text","record_created_at","updated_at","updated_user_id"],"type":"object","properties":{"assessment_question_comment_id":{"type":"string","description":"Unique Id of the assessment question comment","example":"mf3aejwd"},"assessment_question_id":{"type":"string","description":"Unique Id of the assessment question the comment is associated with","example":"lfja7gwd"},"comment_plain_text":{"type":"string","description":"Comment content in plain text format for reads and text comparisons","example":"This question highlights the importance of firewall configurations in network security."},"comment_json":{"description":"Rich-text comment content in the ProseMirror JSON format used across ScalePad products for formatting-preserving round trips. Preserve existing nodes and marks when editing, or the consuming ScalePad UI may lose formatting or embedded content.","example":{"type":"doc","content":[{"type":"paragraph","content":[{"type":"text","text":"This question highlights the importance of firewall configurations in network security."}]}]}},"record_created_at":{"type":"string","description":"Date time the comment was originally created","format":"date-time","example":"2025-10-01T08:15:00Z"},"updated_user_id":{"type":"string","description":"User id who updated the comment","example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"updated_at":{"type":"string","description":"Date time the comment is updated","format":"date-time","example":"2025-10-05T12:34:56Z"}},"additionalProperties":false},"Assessment.AssessmentEvaluation.Model.Public.QuestionEvaluationPayload":{"required":["question_id","selected_criteria_id"],"type":"object","properties":{"question_id":{"type":"string","description":"The unique identifier of the assessment question being evaluated.","example":"asq4hff3"},"selected_criteria_id":{"type":"string","description":"The unique identifier of the criterion selected as the answer for this question.","example":"asdahfhj"}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateCategory.Model.AssessmentTemplateCategoryCreatePayload":{"required":["is_question_weight_evenly_distributed","questions","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the assessment template category.","example":"Network Security"},"description":{"type":"string","description":"The description of the assessment template category.","nullable":true,"example":"Evaluation of network infrastructure security controls and configurations"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateQuestion.Model.AssessmentTemplateQuestionCreatePayload"},"description":"The question list of the assessment template category."},"is_question_weight_evenly_distributed":{"type":"boolean","description":"Indicate if the wights for all questions are evenly distributed","example":false},"weight_in_percentage":{"type":"number","description":"Weight of the category if not evenly distributed","format":"double","nullable":true,"example":35}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateCategory.Model.AssessmentTemplateCategoryUpdatePayload":{"required":["is_question_weight_evenly_distributed","questions","title"],"type":"object","properties":{"assessment_template_category_id":{"type":"string","description":"Id of the assessment template category to update. Null if creating a new assessment template category.","nullable":true,"example":"def456gh"},"title":{"type":"string","description":"The title of the assessment template category.","example":"Network Security"},"description":{"type":"string","description":"The description of the assessment template category.","nullable":true,"example":"Evaluation of network infrastructure security controls and configurations"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateQuestion.Model.AssessmentTemplateQuestionUpdatePayload"},"description":"The question list of the assessment template category."},"is_question_weight_evenly_distributed":{"type":"boolean","description":"Indicate if the wights for all questions are evenly distributed","example":false},"weight_in_percentage":{"type":"number","description":"Weight of the category if not evenly distributed","format":"double","nullable":true,"example":35}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateCategory.Model.Public.AssessmentTemplateCategoryPublic":{"required":["assessment_template_category_id","is_question_weight_evenly_distributed","questions","title"],"type":"object","properties":{"assessment_template_category_id":{"type":"string","description":"Identifier of the assessment template category","example":"def456gh"},"title":{"type":"string","description":"Title of the assessment template category","example":"Network Security"},"description":{"type":"string","description":"Description of the assessment template category","nullable":true,"example":"Evaluation of network infrastructure security controls and configurations"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateQuestion.Model.Public.AssessmentTemplateQuestionPublic"},"description":"List of questions in the assessment template category."},"is_question_weight_evenly_distributed":{"type":"boolean","description":"Indicates whether the question weights are evenly distributed.","example":false},"weight_in_percentage":{"type":"number","description":"The weight of the category in percentage.","format":"double","nullable":true,"example":35}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateCriterion.Model.AssessmentTemplateCriterionCreatePayload":{"required":["description","label_enum"],"type":"object","properties":{"label_enum":{"type":"string","description":"The label enum of the criterion.","example":"Satisfactory"},"description":{"type":"string","description":"The description of the criterion.","example":"All security controls are properly implemented and functioning"}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateCriterion.Model.AssessmentTemplateCriterionUpdatePayload":{"required":["description","label_enum"],"type":"object","properties":{"assessment_template_criterion_id":{"type":"string","description":"The id of the criterion. Null if creating a new criterion.","nullable":true,"example":"abc123de"},"label_enum":{"type":"string","description":"The label enum of the criterion.","example":"Satisfactory"},"description":{"type":"string","description":"The description of the criterion.","example":"All security controls are properly implemented and functioning"}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateCriterion.Model.Public.AssessmentTemplateCriterionPublic":{"required":["assessment_template_criterion_id","description","label_enum"],"type":"object","properties":{"assessment_template_criterion_id":{"type":"string","description":"Id of the assessment template criterion","example":"abc123de"},"label_enum":{"type":"string","description":"The label of the assessment template criterion\r\neg. Satisfactory, AcceptableRisk etc.","example":"Satisfactory"},"description":{"type":"string","description":"The description of the assessment template criterion","example":"All security controls are properly implemented and functioning"}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateQuestion.Model.AssessmentTemplateQuestionCreatePayload":{"required":["criteria","description","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the assessment template question.","example":"Firewall Configuration"},"description":{"type":"string","description":"The description of the assessment template question.","example":"Assess the configuration and effectiveness of network firewall rules"},"remediation_tips":{"type":"string","description":"Tips on the steps to remediate any identified issues for the assessment template question","nullable":true,"example":"Review and update firewall rules to follow principle of least privilege"},"criterion_label_type_enum":{"type":"string","description":"Determines the type of criterion label to use for this question. Can Be Null if the question contains no criteria.","nullable":true,"example":"RiskBased"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateCriterion.Model.AssessmentTemplateCriterionCreatePayload"},"description":"The criteria list of the assessment template question."},"scoring_instructions":{"type":"string","description":"Instructions on how to the score the question","nullable":true,"example":"Award full points if all firewall rules follow security best practices"},"weight_in_percentage":{"type":"number","description":"Weight of the question if not evenly distributed","format":"double","nullable":true,"example":25.5}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateQuestion.Model.AssessmentTemplateQuestionUpdatePayload":{"required":["criteria","description","title"],"type":"object","properties":{"assessment_template_question_id":{"type":"string","description":"The id of the assessment template question to update. Null if creating a new assessment template question.","nullable":true,"example":"xyz789ab"},"title":{"type":"string","description":"The title of the assessment template question.","example":"Firewall Configuration"},"description":{"type":"string","description":"The description of the assessment template question.","example":"Assess the configuration and effectiveness of network firewall rules"},"remediation_tips":{"type":"string","description":"Tips on the steps to remediate any identified issues for the assessment template question","nullable":true,"example":"Review and update firewall rules to follow principle of least privilege"},"criterion_label_type_enum":{"type":"string","description":"Determines the type of criterion label to use for this question. Can Be Null if the question contains no criteria.","nullable":true,"example":"RiskBased"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateCriterion.Model.AssessmentTemplateCriterionUpdatePayload"},"description":"The criteria list of the assessment template question."},"scoring_instructions":{"type":"string","description":"Instructions on how to the score the question","nullable":true,"example":"Award full points if all firewall rules follow security best practices"},"weight_in_percentage":{"type":"number","description":"Weight of the question if not evenly distributed","format":"double","nullable":true,"example":25.5}},"additionalProperties":false},"Assessment.AssessmentTemplate.AssessmentTemplateQuestion.Model.Public.AssessmentTemplateQuestionPublic":{"required":["assessment_template_question_id","criteria","description","title"],"type":"object","properties":{"assessment_template_question_id":{"type":"string","description":"Identifier of the assessment template question","example":"xyz789ab"},"title":{"type":"string","description":"Title of the assessment template question","example":"Firewall Configuration"},"description":{"type":"string","description":"Description of the assessment template question","example":"Assess the configuration and effectiveness of network firewall rules"},"remediation_tips":{"type":"string","description":"Tips on the steps to remediate any identified issues for the assessment template question","nullable":true,"example":"Review and update firewall rules to follow principle of least privilege"},"criterion_label_type_enum":{"type":"string","description":"The type of label used for the criteria in the question, represented as an enum.","nullable":true,"example":"RiskBased"},"criteria":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateCriterion.Model.Public.AssessmentTemplateCriterionPublic"},"description":"The list of criteria for the question."},"scoring_instructions":{"type":"string","description":"Instructions on how the score the question","nullable":true,"example":"Award full points if all firewall rules follow security best practices"},"weight_in_percentage":{"type":"number","description":"The weight of the question in percentage.","format":"double","nullable":true,"example":25.5}},"additionalProperties":false},"Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateCreate_Request":{"required":["assessment_template"],"type":"object","properties":{"assessment_template":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Model.AssessmentTemplateCreatePayload"}]}},"additionalProperties":false},"Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateCreate_Response":{"required":["assessment_template_id"],"type":"object","properties":{"assessment_template_id":{"type":"string","description":"Id of the created assessment template","example":"yd7ja7gd"}},"additionalProperties":false},"Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateGet_Response":{"required":["assessment_template","should_promote_control_map"],"type":"object","properties":{"assessment_template":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Model.Public.AssessmentTemplatePublic"}],"description":"The complete assessment template object containing all categories, questions, criteria, and configuration details."},"should_promote_control_map":{"type":"boolean","description":"Indicates if the user should be promoted to another product after accessing this template.\r\nThis is true when the user is on a free plan for that product."}},"additionalProperties":false},"Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplateUpdate_Request":{"required":["assessment_template"],"type":"object","properties":{"assessment_template":{"allOf":[{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Model.Public.AssessmentTemplateUpdatePayloadPublic"}],"description":"The payload to update the assessment template"}},"additionalProperties":false},"Assessment.AssessmentTemplate.Controller.Public.AssessmentTemplatesList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.Model.Public.AssessmentTemplateOverviewApi"},"description":"The assessment templates available to the account"}},"additionalProperties":false},"Assessment.AssessmentTemplate.Model.AssessmentTemplateCreatePayload":{"required":["categories","description","is_category_weight_evenly_distributed","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the assessment template.","example":"IT Security Assessment"},"description":{"type":"string","description":"The description of the assessment template.","example":"Comprehensive security assessment covering network, application, and data security"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateCategory.Model.AssessmentTemplateCategoryCreatePayload"},"description":"The category list of the assessment template."},"is_category_weight_evenly_distributed":{"type":"boolean","description":"Indicate if the wights for all categories are evenly distributed","example":false}},"additionalProperties":false},"Assessment.AssessmentTemplate.Model.Public.AssessmentTemplateOverviewApi":{"required":["assessment_template_id","created_at","description","scope","title","updated_at"],"type":"object","properties":{"assessment_template_id":{"type":"string","description":"Unique Id of the assessment template","example":"dhka7gwd"},"scope":{"type":"string","description":"Scope of the assessment template being \"Application\" or \"Account\"","example":"Application"},"title":{"type":"string","description":"Title of the assessment template","example":"Security Assessment for Project X"},"description":{"type":"string","description":"Description of the assessment template","example":"This assessment covers the security posture of Project X"},"created_at":{"type":"string","description":"Date time the assessment template is created","format":"date-time","example":"2025-10-05T12:34:56Z"},"updated_at":{"type":"string","description":"Date time the assessment template is updated","format":"date-time","example":"2025-10-05T12:34:56Z"}},"additionalProperties":false},"Assessment.AssessmentTemplate.Model.Public.AssessmentTemplatePublic":{"required":["assessment_template_id","categories","created_at","description","is_category_weight_evenly_distributed","is_in_use","scope","title","updated_at"],"type":"object","properties":{"assessment_template_id":{"type":"string","description":"Identifier of the assessment template","example":"yd7ja7gd"},"scope":{"type":"string","description":"The scope of the assessment template, \"Application\" or \"Account\".","example":"Account"},"title":{"type":"string","description":"Title of the assessment template","example":"IT Security Assessment"},"description":{"type":"string","description":"Description of the assessment template","example":"Comprehensive security assessment covering network, application, and data security"},"created_at":{"type":"string","description":"Date and time when the assessment template was created","format":"date-time","example":"2024-01-15T10:30:00Z"},"updated_at":{"type":"string","description":"Date and time when the assessment template was updated","format":"date-time","example":"2024-01-15T10:30:00Z"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateCategory.Model.Public.AssessmentTemplateCategoryPublic"},"description":"All categories in the assessment template"},"is_in_use":{"type":"boolean","description":"Determines if the assessment template is in use","example":true},"is_category_weight_evenly_distributed":{"type":"boolean","description":"Determines if the category weight is evenly distributed","example":false}},"additionalProperties":false},"Assessment.AssessmentTemplate.Model.Public.AssessmentTemplateUpdatePayloadPublic":{"required":["categories","description","is_category_weight_evenly_distributed","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the assessment template.","example":"IT Security Assessment"},"description":{"type":"string","description":"The description of the assessment template.","example":"Comprehensive security assessment covering network, application, and data security"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentTemplate.AssessmentTemplateCategory.Model.AssessmentTemplateCategoryUpdatePayload"},"description":"The category list of the assessment template."},"is_category_weight_evenly_distributed":{"type":"boolean","description":"Indicate if the wights for all categories are evenly distributed","example":false}},"additionalProperties":false},"Asset.Model.Public.HardwareKeyPublic":{"type":"object","properties":{"unique_key":{"allOf":[{"$ref":"#/components/schemas/Asset.Model.Public.HardwareUniqueKeyPublic"}],"description":"The combination of fields that uniquely identifies a hardware asset.","nullable":true}},"additionalProperties":false},"Asset.Model.Public.HardwareUniqueKeyPublic":{"required":["manufacturer","model","serial_number"],"type":"object","properties":{"serial_number":{"type":"string","description":"The serial number of the hardware device.","example":"ABC123XYZ"},"model":{"type":"string","description":"The model name or display name of the hardware device.","example":"OptiPlex 7090"},"manufacturer":{"type":"string","description":"The manufacturer of the hardware device.","example":"Dell"}},"additionalProperties":false},"AssetManagement.Asset.Hardware.Controller.AssetsHardwareLifecycle_Response":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AssetManagement.Asset.Hardware.HardwareLifecycleInfo"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":50},"next_cursor":{"type":"string","description":"The cursor used to fetch the next page of records, if more records are available","nullable":true,"example":"WyJ0aWNrZXQiXQ"}},"additionalProperties":false},"AssetManagement.Asset.Hardware.Controller.Public.AssetsHardwareAttachedInitiatives_Request":{"required":["hardware_key"],"type":"object","properties":{"hardware_key":{"allOf":[{"$ref":"#/components/schemas/Asset.Model.Public.HardwareKeyPublic"}],"description":"The hardware asset to look up, identified by its unique key."}},"additionalProperties":false},"AssetManagement.Asset.Hardware.Controller.Public.AssetsHardwareAttachedInitiatives_Response":{"required":["initiative_ids"],"type":"object","properties":{"initiative_ids":{"type":"array","items":{"type":"string"},"description":"The identifiers of initiatives that include this hardware asset."}},"additionalProperties":false},"AssetManagement.Asset.Hardware.HardwareLifecycleInfo":{"required":["client_id"],"type":"object","properties":{"client_id":{"type":"string","description":"The unique identifier of the client that owns the hardware","example":"a9b3f47d-7b39-4d1e-b320-fdd9b72b8ab5"},"serial_number":{"type":"string","description":"The serial number of the hardware","nullable":true,"example":"ABCDEF123456"},"manufacturer":{"type":"string","description":"The manufacturer of the hardware","nullable":true,"example":"HP Inc"},"model":{"type":"string","description":"The model number of the hardware","nullable":true,"example":"Latitude 5530"},"name":{"type":"string","description":"The name of the device unit","nullable":true,"example":"John's Laptop"},"purchase_date":{"type":"string","description":"The date when the hardware was purchased","format":"date-time","nullable":true,"example":"2019-09-30T00:00:00Z"},"warranty_expiry_date":{"type":"string","description":"The date when the hardware warranty expires","format":"date-time","nullable":true,"example":"2019-09-30T00:00:00Z"},"warranty_expiry_date_source":{"type":"string","description":"The source of the effective warranty expiry date","nullable":true,"example":"WmRenewal"},"manufacturer_expiry_date":{"type":"string","description":"The warranty expiry date reported directly by the manufacturer","format":"date-time","nullable":true,"example":"2019-09-30T00:00:00Z"}},"additionalProperties":false},"AssetManagement.Strategy.Branding.Model.BrandingMspV2":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Wm.Beast.AssetManagement.Packages.Strategy.Packages.Branding.Model.BrandingMsp.Name"},"website":{"allOf":[{"$ref":"#/components/schemas/AssetManagement.Strategy.Branding.Model.BrandingWebsiteInfo"}],"description":"Wm.Beast.AssetManagement.Packages.Strategy.Packages.Branding.Model.BrandingMsp.Website","nullable":true},"base_64_image":{"type":"string","description":"Wm.Beast.AssetManagement.Packages.Strategy.Packages.Branding.Model.BrandingMsp.Base64Image","nullable":true}},"additionalProperties":false},"AssetManagement.Strategy.Branding.Model.BrandingWebsiteInfo":{"required":["label","url"],"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string"}},"additionalProperties":false},"Contact.Model.Public.ContactKeyPublic":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the contact, must be provided when client and email are both missing","nullable":true,"example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"email":{"type":"string","description":"Unique email address of the contact, must be provided when id is missing","nullable":true,"example":"john.doe@company.com"},"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The client associated with the contact, must be provided with email when id is missing","nullable":true}},"additionalProperties":false},"Contact.Model.Public.ContactPublic":{"required":["email","id","is_deleted","label"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the contact","example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"label":{"type":"string","description":"Label of the contact","example":"John Doe"},"email":{"type":"string","description":"Email address of the contact","example":"john.doe@company.com"},"is_deleted":{"type":"boolean","description":"Indicates whether the contact is deleted from the system","example":true}},"additionalProperties":false},"Contract.Controller.Public.ContractsCreate_Request":{"required":["client_key","create_payload"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the contract for."},"create_payload":{"allOf":[{"$ref":"#/components/schemas/Contract.Model.Public.ContractUpsertPayloadApi"}],"description":"The contract details payload containing all required information to create a new contract including title, billing cycle, cost, and other settings."}},"additionalProperties":false},"Contract.Controller.Public.ContractsCreate_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the newly created contract.","example":"dhka7gwd"}},"additionalProperties":false},"Contract.Controller.Public.ContractsGet_Response":{"required":["contract"],"type":"object","properties":{"contract":{"allOf":[{"$ref":"#/components/schemas/Contract.Model.Public.ContractPublic"}],"description":"The complete contract object containing all details including basic info, billing info, and associated assets."}},"additionalProperties":false},"Contract.Controller.Public.ContractsUpdate_Request":{"required":["client_id","update_payload"],"type":"object","properties":{"client_id":{"type":"string","description":"The unique identifier of the client that owns this contract.","example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"update_payload":{"allOf":[{"$ref":"#/components/schemas/Contract.Model.Public.ContractUpsertPayloadApi"}],"description":"The contract details payload containing updated information for the contract including title, billing cycle, cost, and other settings."}},"additionalProperties":false},"Contract.Model.Public.ContractAssetPublic":{"required":["is_deleted","label"],"type":"object","properties":{"label":{"type":"string","description":"The label of the asset","example":"\"Laptop-1234\""},"serial_number":{"type":"string","description":"Serial number","nullable":true,"example":"\"SN123456789\""},"model_number":{"type":"string","description":"Model number","nullable":true,"example":"\"MDL-5678\""},"manufacturer_name":{"type":"string","description":"Manufacturer name","nullable":true,"example":"\"Lenovo\""},"is_deleted":{"type":"boolean","description":"Indicates if the asset has been deleted from LM system","example":false}},"additionalProperties":false},"Contract.Model.Public.ContractBasicPublic":{"required":["impact","is_external_synced","status","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the contract","example":"\"Microsoft 365 E5 Subscription\""},"category":{"type":"string","description":"The category or department the contract belongs to","nullable":true,"example":"Software licensing"},"status":{"type":"string","description":"The status of the contract\r\n            \r\nAvailable values: Active, Inactive","example":"Active"},"impact":{"type":"string","description":"The overall impact of the contract\r\n            \r\nAvailable values: Unspecified, Low, Medium, High","example":"High"},"location":{"type":"string","description":"Optional location the contract belongs to","nullable":true,"example":"New York Office"},"description":{"type":"string","description":"Optional description of the contract","nullable":true,"example":"This contract is for software licensing with Contoso Ltd from Jan 2024 to Dec 2024."},"is_third_party":{"type":"boolean","description":"Determine if the contract is from third party vendor","nullable":true,"example":true},"is_external_synced":{"type":"boolean","description":"Indicates if the contract is synced from an external system","example":true},"last_synced_at":{"type":"string","description":"Last time the contract synced from the external system","format":"date-time","nullable":true,"example":"2024-01-15T10:30:00Z"}},"additionalProperties":false},"Contract.Model.Public.ContractBillingPublic":{"required":["billing_cost_currency_code","billing_cost_subunits","billing_cost_type","billing_cycle","billing_next_due_at","should_budget_past_end_date"],"type":"object","properties":{"billing_cycle":{"type":"string","description":"The billing cycle of the contract\r\n            \r\nAvailable values: Monthly, Quarterly, Annually, SemiAnnual, EveryTwoYears, EveryThreeYears, EveryFourYears, EveryFiveYears, EveryTenYears, OneTime, BiMonthly, Unknown, BiWeekly","example":"Annually"},"billing_cost_subunits":{"type":"integer","description":"The cost of the contract for each billing cycle in currency subunits\r\n(eg. $100 usd will be 10000)","format":"int64","example":10000},"billing_cost_currency_code":{"type":"string","description":"The iso 3 letter cost currency code of the contract for each billing cycle in local currency subunits","example":"USD"},"billing_cost_type":{"type":"string","description":"The billing cost type of the contract\r\nAvailable values: Actual, Estimate","example":"Actual"},"billing_per_seat_cost_subunits":{"type":"integer","description":"The per seat cost of the contract for each billing cycle in local currency subunits\r\n(eg. $100 usd will be 10000)","format":"int64","nullable":true,"example":1000},"billing_number_of_seats":{"type":"number","description":"Number of individuals who is included in the contract","format":"double","nullable":true,"example":10},"billing_next_due_at":{"type":"string","description":"Next Due date of the contract","format":"date-time","example":"2024-12-31T00:00:00Z"},"billing_is_auto_renew":{"type":"boolean","description":"Determine if the contract is auto renew","nullable":true,"example":true},"end_at":{"type":"string","description":"Optional, the end date of the contract","format":"date-time","nullable":true,"example":"2024-12-31T00:00:00Z"},"should_budget_past_end_date":{"type":"boolean","description":"Indicates if budgeting should continue past the end date of the contract","example":false}},"additionalProperties":false},"Contract.Model.Public.ContractOverviewApi":{"required":["assets_count","billing_cost_currency_code","billing_cost_subunits","billing_cost_type","billing_cycle","billing_next_due_at","client","id","status","title"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the contract","example":"\"dha6dhak\""},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"Information about the client for which the contract belongs to"},"title":{"type":"string","description":"The title of the contract","example":"\"Microsoft 365 E5 Subscription\""},"description":{"type":"string","description":"Optional description of the contract","nullable":true,"example":"This contract is for software licensing with Contoso Ltd from Jan 2024 to Dec 2024."},"status":{"type":"string","description":"The status of the contract\r\n            \r\nAvailable values: Active, Inactive","example":"Active"},"location":{"type":"string","description":"Optional location the contract belongs to","nullable":true,"example":"New York Office"},"is_third_party":{"type":"boolean","description":"Determine if the contract is from third party vendor","nullable":true,"example":true},"billing_cycle":{"type":"string","description":"The billing cycle of the contract\r\n            \r\nAvailable values: Monthly, Quarterly, Annually, SemiAnnual, EveryTwoYears, EveryThreeYears, EveryFourYears, EveryFiveYears, EveryTenYears, OneTime, BiMonthly, Unknown, BiWeekly","example":"Annually"},"billing_cost_subunits":{"type":"integer","description":"The cost of the contract for each billing cycle in currency subunits\r\n(eg. $100 usd will be 10000)","format":"int64","example":10000},"billing_cost_currency_code":{"type":"string","description":"The iso 3 letter cost currency code of the contract for each billing cycle in local currency subunits","example":"USD"},"billing_cost_type":{"type":"string","description":"The billing cost type of the contract\r\nAvailable values: Actual, Estimate","example":"Actual"},"billing_number_of_seats":{"type":"number","description":"Number of individuals who is included in the contract","format":"double","nullable":true,"example":10},"billing_next_due_at":{"type":"string","description":"Next Due date of the contract","format":"date-time","example":"2024-12-31T00:00:00Z"},"billing_is_auto_renew":{"type":"boolean","description":"Determine if the contract is auto renew","nullable":true,"example":true},"end_at":{"type":"string","description":"Optional, the end date of the contract","format":"date-time","nullable":true,"example":"2024-12-31T00:00:00Z"},"notify_end_at_date":{"type":"string","description":"The date when to notify before the contract ends.","format":"date-time","nullable":true,"example":"2024-12-01T00:00:00Z"},"assets_count":{"type":"integer","description":"The total number of assets associated with the contract.","format":"int32","example":5}},"additionalProperties":false},"Contract.Model.Public.ContractPublic":{"required":["assets","billing","client","contract","id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the contract","example":"\"dha6dhak\""},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"Information about the client for which the contract belongs to"},"contract":{"allOf":[{"$ref":"#/components/schemas/Contract.Model.Public.ContractBasicPublic"}],"description":"Basic information about the contract"},"billing":{"allOf":[{"$ref":"#/components/schemas/Contract.Model.Public.ContractBillingPublic"}],"description":"Billing information about the contract"},"notify_days_before_end_date":{"type":"integer","description":"Number of days before the end date partner want to be notified","format":"int32","nullable":true,"example":30},"notify_end_at_date":{"type":"string","description":"The date when to notify before the contract ends.","format":"date-time","nullable":true,"example":"2024-12-01T00:00:00Z"},"assets":{"type":"array","items":{"$ref":"#/components/schemas/Contract.Model.Public.ContractAssetPublic"},"description":"The list of assets associated with the contract"}},"additionalProperties":false},"Contract.Model.Public.ContractUpsertPayloadApi":{"required":["billing_cost_subunits","billing_cost_type","billing_cycle","billing_start_at","impact","should_budget_past_end_date","status","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the contract to be created","example":"New Contract for Contoso Ltd"},"category":{"type":"string","description":"The category or department the contract belongs to","nullable":true,"example":"software licensing"},"impact":{"type":"string","description":"The overall impact of the contract\r\n            \r\nAvailable values: Unspecified, Low, Medium, High","example":"High"},"status":{"type":"string","description":"The status of the contract\r\n            \r\nAvailable values: Active, Inactive","example":"Active"},"location":{"type":"string","description":"Optional location the contract belongs to","nullable":true,"example":"New York Office"},"description":{"type":"string","description":"Optional description of the contract","nullable":true,"example":"This contract is for software licensing with Contoso Ltd from Jan 2024 to Dec 2024."},"is_third_party":{"type":"boolean","description":"Determine if the contract is from third party vendor","nullable":true,"example":true},"billing_cycle":{"type":"string","description":"The billing cycle of the contract\r\n            \r\nAvailable values: Monthly, Quarterly, Annually, SemiAnnual, EveryTwoYears, EveryThreeYears, EveryFourYears, EveryFiveYears, EveryTenYears, OneTime, BiMonthly, Unknown, BiWeekly","example":"Annually"},"billing_cost_subunits":{"type":"integer","description":"The cost of the contract for each billing cycle in currency subunits\r\n(eg. $100 usd will be 10000)","format":"int64","example":10000},"billing_cost_type":{"type":"string","description":"The billing cost type of the contract\r\nAvailable values: Actual, Estimate","example":"Actual"},"billing_per_seat_cost_subunits":{"type":"integer","description":"The per seat cost of the contract for each billing cycle in local currency subunits\r\n(eg. $100 usd will be 10000)","format":"int64","nullable":true,"example":1000},"billing_number_of_seats":{"type":"integer","description":"Number of individuals who is included in the contract","format":"int32","nullable":true,"example":10},"billing_start_at":{"type":"string","description":"Billing cycle start date of the contract\r\nThe first billing date after the contract is created","format":"date-time","example":"2024-01-01T00:00:00Z"},"billing_is_auto_renew":{"type":"boolean","description":"Determine if the contract is auto renew","nullable":true,"example":true},"end_at":{"type":"string","description":"Optional, the end date of the contract","format":"date-time","nullable":true,"example":"2024-12-31T00:00:00Z"},"should_budget_past_end_date":{"type":"boolean","description":"Should include this in the budget forecast past the EndAt date, if EndAt date is provided","example":false},"notify_days_before_end_date":{"type":"integer","description":"Optional, Number of days before the end date partner want to be notified, if not set default to 30","format":"int32","nullable":true,"example":30},"is_billable":{"type":"boolean","description":"Indicate if the contract is billable or not.","nullable":true,"example":true}},"additionalProperties":false},"Controller.Controller.EmptyResponse":{"type":"object","additionalProperties":false},"Core.Ticket.TicketLink.Model.TicketLinkStateV2":{"required":["type"],"type":"object","oneOf":[{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Created"},{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Pending"},{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Error"}],"additionalProperties":false,"discriminator":{"propertyName":"type","mapping":{"Created":"#/components/schemas/Wm.Beast.Core.Ticket.Packages.TicketLink.Dto.Model.TicketLinkStateDtoV2.Created","Pending":"#/components/schemas/Wm.Beast.Core.Ticket.Packages.TicketLink.Dto.Model.TicketLinkStateDtoV2.Pending","Error":"#/components/schemas/Wm.Beast.Core.Ticket.Packages.TicketLink.Dto.Model.TicketLinkStateDtoV2.Error"}}},"Core.Ticket.TicketLink.Model.TicketLinkStateV2_Created":{"required":["type"],"type":"object","properties":{"ticket_link_id":{"type":"string","description":"Unique identifier for the ticket link","nullable":true,"example":"ABC123"},"ticket_link":{"allOf":[{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkV2"}],"description":"Represents details associated with a specific ticket link.","nullable":true},"type":{"enum":["Created","Pending","Error"],"type":"string","allOf":[{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Enum"}],"description":"Represents the type of ticket link state, indicating its current status.","readOnly":true,"example":"Created"}},"additionalProperties":false,"description":"The state when a ticket link is successfully created"},"Core.Ticket.TicketLink.Model.TicketLinkStateV2_Enum":{"enum":["Created","Pending","Error"],"type":"string"},"Core.Ticket.TicketLink.Model.TicketLinkStateV2_Error":{"required":["type"],"type":"object","properties":{"ticket_link_id":{"type":"string","description":"unique identifier for the ticket link\r\nUnique identifier for the ticket link","nullable":true,"example":"ABC123"},"type":{"enum":["Created","Pending","Error"],"type":"string","allOf":[{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Enum"}],"description":"Represents the type of ticket link state, indicating its current status.","readOnly":true,"example":"Error"}},"additionalProperties":false,"description":"The state when there is an error creating a ticket link"},"Core.Ticket.TicketLink.Model.TicketLinkStateV2_Pending":{"required":["type"],"type":"object","properties":{"ticket_link_id":{"type":"string","description":"Unique identifier for the ticket link","nullable":true,"example":"ABC123"},"type":{"enum":["Created","Pending","Error"],"type":"string","allOf":[{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Enum"}],"description":"Represents the type of ticket link state, indicating its current status.","readOnly":true,"example":"Pending"}},"additionalProperties":false,"description":"The state when a ticket link is pending creation"},"Core.Ticket.TicketLink.Model.TicketLinkV2":{"required":["external_url","ticket_number"],"type":"object","properties":{"ticket_number":{"type":"string","description":"External ticket number"},"external_url":{"type":"string","description":"Used to navigate to the ticket in the external systems"}},"additionalProperties":false},"Date.Range.FiscalQuarter":{"required":["quarter","year"],"type":"object","properties":{"year":{"type":"integer","format":"int32"},"quarter":{"type":"integer","format":"int32"}},"additionalProperties":false},"Deliverable.Controller.DeliverableCreateFromTemplate_Request":{"type":"object","properties":{"name":{"type":"string","description":"The name of the deliverable","nullable":true,"example":"QBR 2026 Space Inc."}},"additionalProperties":false},"Deliverable.Controller.DeliverableCreateFromTemplate_Response":{"required":["deliverable"],"type":"object","properties":{"deliverable":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Model.Deliverable"}],"description":"Complete deliverable information including all sections and components"}},"additionalProperties":false},"Deliverable.Controller.DeliverableCreate_Request":{"required":["sections"],"type":"object","properties":{"name":{"type":"string","description":"The name of the deliverable","nullable":true,"example":"QBR 2026 Space Inc."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionInput"}}},"additionalProperties":false},"Deliverable.Controller.DeliverableCreate_Response":{"required":["deliverable"],"type":"object","properties":{"deliverable":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Model.Deliverable"}],"description":"Complete deliverable information including all sections and components"}},"additionalProperties":false},"Deliverable.Controller.DeliverableGet_Response":{"required":["deliverable"],"type":"object","properties":{"deliverable":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Model.Deliverable"}],"description":"Complete deliverable information including all sections and components"}},"additionalProperties":false},"Deliverable.Controller.DeliverableList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.Model.DeliverableBasicInfo"}}},"additionalProperties":false},"Deliverable.Controller.DeliverablePatch_Request":{"type":"object","properties":{"name":{"type":"string","description":"Business-facing name of the deliverable, used for identification and communication with the client.\r\n\n<b>Optional.</b> When provided, must be non-empty and at most 255 characters.","nullable":true,"example":"Q1 2025 Strategic Review - Updated"},"status":{"type":"string","description":"Lifecycle status of the deliverable. Must be either 'Draft' or 'Published'.\r\n\n<b>Optional.</b> Note: when a deliverable has been published and a component requires\r\na new snapshot, status will automatically be moved back to 'Draft'.","nullable":true,"example":"Published"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionPatchPayload"},"description":"Array of section configurations with upsert semantics.\r\n\n<b>Optional.</b> Sections with 'id' are updated; sections without 'id' are created.\r\nExisting sections not included in this array remain unchanged.","nullable":true}},"additionalProperties":false,"description":"Request payload for updating a deliverable.\r\nAll fields are optional but at least one must be provided for a valid update."},"Deliverable.Controller.DeliverablePatch_Response":{"required":["deliverable"],"type":"object","properties":{"deliverable":{"allOf":[{"$ref":"#/components/schemas/Deliverable.Model.Deliverable"}],"description":"Complete deliverable information including all sections and components"}},"additionalProperties":false},"Deliverable.DeliverableCatalog.Controller.DeliverableCatalogList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponent"}}},"additionalProperties":false},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponent":{"required":["component_description","component_key","component_name","component_type","output","section_key","section_name"],"type":"object","properties":{"component_key":{"type":"string","description":"The unique key identifying this component","example":"ItGlue"},"component_name":{"type":"string","description":"Display name of the component","example":"IT Glue"},"component_description":{"type":"string","description":"Description of the component's purpose and functionality","example":"Comprehensive asset tracking and inventory management"},"section_key":{"type":"string","description":"The identifier of the section this component belongs to","example":"Risk"},"section_name":{"type":"string","description":"The name of the section this component belongs to","example":"Risk Management"},"component_type":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType"}],"oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_Custom"},{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_Vendor"}],"description":"The type of the component","discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableCatalog.Packages.DeliverableCatalogComponent.Dto.Model.DeliverableCatalogComponentTypeDto.LifecycleManager","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableCatalog.Packages.DeliverableCatalogComponent.Dto.Model.DeliverableCatalogComponentTypeDto.Custom","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableCatalog.Packages.DeliverableCatalogComponent.Dto.Model.DeliverableCatalogComponentTypeDto.Vendor"}}},"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentConfiguration"}],"description":"Component configuration including schema and data","nullable":true},"output":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentOutput"}],"description":"Component output schema definition"}},"additionalProperties":false,"description":"Represents a component definition with client-specific integration status and configuration"},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentConfiguration":{"type":"object","properties":{"options":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentConfigurationData"}],"description":"Available configuration options with schema and data","nullable":true},"default_values":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentConfigurationData"}],"description":"Default configuration values with schema and data","nullable":true}},"additionalProperties":false,"description":"Component configuration including options and default values, each with their own schema and data"},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentConfigurationData":{"required":["schema"],"type":"object","properties":{"schema":{"description":"JSON Schema defining the structure of the configuration data","example":"{\"type\":\"object\"}"},"data":{"description":"JSON object containing the actual configuration data","nullable":true,"example":"{\"HardwareType\":[\"Server\",\"Workstation\"]}"}},"additionalProperties":false,"description":"Configuration data structure containing JSON Schema and data object"},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentOutput":{"required":["schema","schema_version"],"type":"object","properties":{"schema_version":{"type":"string","description":"Output schema version (major.minor format, e.g., \"1.0\")","example":"1.0"},"schema":{"description":"JSON Schema defining the output structure for this component","example":"{\"type\":\"object\",\"properties\":{\"summary\":{\"type\":\"object\"}}}"}},"additionalProperties":false,"description":"Component output schema definition"},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType":{"required":["type"],"type":"object","oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_Custom"},{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_Vendor"}],"additionalProperties":false,"description":"The type of the component","discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableCatalog.Packages.DeliverableCatalogComponent.Dto.Model.DeliverableCatalogComponentTypeDto.LifecycleManager","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableCatalog.Packages.DeliverableCatalogComponent.Dto.Model.DeliverableCatalogComponentTypeDto.Custom","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableCatalog.Packages.DeliverableCatalogComponent.Dto.Model.DeliverableCatalogComponentTypeDto.Vendor"}}},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_Custom":{"required":["type"],"type":"object","properties":{"type":{"enum":["LifecycleManager","Vendor","Custom"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_TypeEnum"}],"readOnly":true}},"additionalProperties":false,"description":"Represents a user-supplied custom content component"},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_LifecycleManager":{"required":["type"],"type":"object","properties":{"type":{"enum":["LifecycleManager","Vendor","Custom"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_TypeEnum"}],"readOnly":true}},"additionalProperties":false,"description":"Represents a Lifecycle Manager internal component"},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_ResolutionInfo":{"required":["reason_code"],"type":"object","properties":{"reason_code":{"enum":["MissingIntegration","MissingClient"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_ResolutionInfo_ReasonCodeEnum"}],"description":"Code representing the reason the component cannot be enabled.","example":"MissingIntegration"},"message":{"type":"string","description":"Message describing the action required to resolve the issue.","nullable":true,"example":"Vendor integration is not set up. Please add the integration to enable this component."}},"additionalProperties":false,"description":"If the component cannot be enabled, contains details describing why a component cannot be enabled and what must be done to resolve the issue."},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_ResolutionInfo_ReasonCodeEnum":{"enum":["MissingIntegration","MissingClient"],"type":"string","description":"Code representing the reason the component cannot be enabled."},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_TypeEnum":{"enum":["LifecycleManager","Vendor","Custom"],"type":"string"},"Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_Vendor":{"required":["can_enable","type"],"type":"object","properties":{"type":{"enum":["LifecycleManager","Vendor","Custom"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_TypeEnum"}],"readOnly":true},"integration_id":{"type":"string","description":"Reference to the vendor integration","nullable":true,"example":"12"},"integration_configuration_id":{"type":"string","description":"Reference to the vendor integration configuration","nullable":true,"example":"dhv2ms10"},"can_enable":{"type":"boolean","description":"Whether the component can be enabled for the client","example":"true"},"resolution_info":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_ResolutionInfo"}],"description":"If the component cannot be enabled, contains details describing why a component cannot be enabled and what must be done to resolve the issue.","nullable":true}},"additionalProperties":false,"description":"Represents a vendor integration component"},"Deliverable.DeliverableCatalog.DeliverableCatalogIntegration.Controller.DeliverableCatalogIntegrationList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogIntegration.Model.DeliverableCatalogIntegration"}}},"additionalProperties":false},"Deliverable.DeliverableCatalog.DeliverableCatalogIntegration.Model.DeliverableCatalogIntegration":{"required":["section_key","vendor"],"type":"object","properties":{"vendor":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogIntegration.Model.DeliverableCatalogIntegrationVendor"}],"description":"Vendor information for the integration"},"section_key":{"type":"string","description":"Section identifier this integration belongs to","example":"Risk"}},"additionalProperties":false,"description":"Represents an available deliverable integration in the catalog"},"Deliverable.DeliverableCatalog.DeliverableCatalogIntegration.Model.DeliverableCatalogIntegrationVendor":{"required":["brand_name","description","id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the vendor","example":"9"},"brand_name":{"type":"string","description":"Brand name of the vendor","example":"IT Glue"},"description":{"type":"string","description":"Description of the vendor's service or product","example":"Third-party risk assessment and monitoring"}},"additionalProperties":false,"description":"Represents vendor information for a deliverable integration"},"Deliverable.DeliverableIntegration.Controller.DeliverableIntegrationList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegratedIntegration"}}},"additionalProperties":false},"Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegratedIntegration":{"required":["configuration","section_key","vendor"],"type":"object","properties":{"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationConfiguration"}],"description":"Configuration details of the integration"},"vendor":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationVendor"}],"description":"Vendor information for the integration"},"section_key":{"type":"string","description":"Section identifier this integration belongs to","example":"Risk"}},"additionalProperties":false,"description":"Represents an integrated deliverable item with configuration, vendor, and section information"},"Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationConfiguration":{"required":["client_data_available","id","status"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the integration configuration","example":"2914dqak9"},"nickname":{"type":"string","description":"User-friendly nickname for the integration","nullable":true,"example":"IT Glue Pasadena"},"status":{"enum":["Connected","Syncing","Error","Unknown"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationConfiguration_DeliverableIntegrationStatus"}],"description":"Current connection status of the integration","example":"Connected"},"client_data_available":{"enum":["Available","Unavailable","Unknown"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationConfiguration_DeliverableIntegrationClientDataAvailability"}],"description":"Indicates whether client data is available from this integration","example":"true"}},"additionalProperties":false,"description":"Represents the configuration details of an integrated deliverable"},"Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationConfiguration_DeliverableIntegrationClientDataAvailability":{"enum":["Available","Unavailable","Unknown"],"type":"string"},"Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationConfiguration_DeliverableIntegrationStatus":{"enum":["Connected","Syncing","Error","Unknown"],"type":"string"},"Deliverable.DeliverableIntegration.DeliverableIntegratedIntegration.Model.DeliverableIntegrationVendor":{"required":["brand_name","description","id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the vendor","example":"9"},"brand_name":{"type":"string","description":"Brand name of the vendor","example":"IT Glue"},"description":{"type":"string","description":"Description of the vendor's service or product","example":"Third-party risk assessment and monitoring"}},"additionalProperties":false,"description":"Represents vendor information for an integrated deliverable"},"Deliverable.DeliverablePresentation.Controller.DeliverablePresentationGet_Response":{"required":["branding","deliverable"],"type":"object","properties":{"deliverable":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverablePresentation.Model.DeliverablePresentation"}],"description":"Minimal deliverable information for presentation.\r\nContains only the data required for rendering (name, client name, sections with components output)."},"branding":{"allOf":[{"$ref":"#/components/schemas/AssetManagement.Strategy.Branding.Model.BrandingMspV2"}],"description":"MSP branding information for the presentation header"}},"additionalProperties":false},"Deliverable.DeliverablePresentation.Model.DeliverablePresentation":{"required":["client","name","sections"],"type":"object","properties":{"name":{"type":"string","description":"Business-facing name of the deliverable","example":"Q4 2024 Strategic Review"},"client":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverablePresentation.Model.DeliverablePresentationClientInfo"}],"description":"Minimal client information (name only)"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverablePresentation.Model.DeliverablePresentationSection"},"description":"Array of sections included in this deliverable"}},"additionalProperties":false,"description":"Minimal deliverable information for presentation.\r\nContains only the data required for rendering the deliverable presentation.\r\nExcludes sensitive fields like IDs, timestamps, creator information, and status."},"Deliverable.DeliverablePresentation.Model.DeliverablePresentationClientInfo":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the client organization","example":"Acme Corporation"}},"additionalProperties":false,"description":"Minimal client information for deliverable presentation.\r\nContains only the name needed for display purposes."},"Deliverable.DeliverablePresentation.Model.DeliverablePresentationSection":{"required":["components","name","section_key"],"type":"object","properties":{"section_key":{"type":"string","description":"Business key identifier for the section type (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"name":{"type":"string","description":"Display name of the section","example":"Budget"},"summary_json":{"type":"string","description":"Executive summary of this section in ProseMirror JSON format","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"This is the executive summary of the budget section.\"}]}]}"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverablePresentation.Model.DeliverablePresentationSectionComponent"},"description":"Array of components included in this section"}},"additionalProperties":false,"description":"Minimal section information for deliverable presentation.\r\nContains only the properties needed for tab rendering and component display."},"Deliverable.DeliverablePresentation.Model.DeliverablePresentationSectionComponent":{"required":["component_key","component_name","id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the component (used as React key for rendering)","example":"f2a3b4c5-7d8e-4f9a-b0c1-d2e3f4a5b6c7"},"component_key":{"type":"string","description":"Component key identifier (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"component_name":{"type":"string","description":"Display name of the component (e.g., 'Budget', 'IT Glue', 'Roadmap')","example":"Budget"},"output":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverablePresentation.Model.DeliverablePresentationSectionComponentOutput"}],"description":"The rendered output of the component for presentation","nullable":true}},"additionalProperties":false,"description":"Minimal component information for deliverable presentation.\r\nContains only the properties needed for rendering in the presentation view.\r\nExcludes sensitive data like configuration, integration IDs, and audit information."},"Deliverable.DeliverablePresentation.Model.DeliverablePresentationSectionComponentOutput":{"required":["data","is_empty"],"type":"object","properties":{"schema_version":{"type":"string","description":"Version of the output schema used","nullable":true,"example":"2"},"data":{"description":"The output data of the component","example":"{\"summary\":{\"total_assets\":141,\"supported_users\":17}}"},"is_empty":{"type":"boolean","description":"Indicates whether the component has no meaningful data to display","example":"false"}},"additionalProperties":false,"description":"Minimal output information for deliverable component presentation.\r\nContains only the data needed for rendering component output."},"Deliverable.DeliverableSection.DeliverableSection":{"required":["components","display_order","id","name","section_key"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the section","example":"e1f2a3b4-6c7d-4e8f-a9b0-c1d2e3f4a5b6"},"section_key":{"type":"string","description":"Business key identifier for the section type (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"name":{"type":"string","description":"Display name of the section","example":"Budget"},"summary_json":{"type":"string","description":"Executive summary of this section in ProseMirror JSON format","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"This is the executive summary of the budget section.\"}]}]}"},"display_order":{"type":"integer","description":"The order in which this section should be displayed","format":"int32","example":"1"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponent"},"description":"Array of components included in this section"}},"additionalProperties":false,"description":"Section information within a deliverable"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration":{"required":["type"],"type":"object","oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom"}],"additionalProperties":false,"description":"Component type configuration for lifecycle manager or vendor components","discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.LifecycleManager","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Vendor","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Custom"}}},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom":{"required":["type"],"type":"object","properties":{"type":{"enum":["LifecycleManager","Vendor","Custom"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_TypeEnum"}],"readOnly":true}},"additionalProperties":false,"description":"Custom component type (user-supplied content, no external integration)"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager":{"required":["type"],"type":"object","properties":{"type":{"enum":["LifecycleManager","Vendor","Custom"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_TypeEnum"}],"readOnly":true}},"additionalProperties":false,"description":"Lifecycle Manager component type (no external integration)"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor":{"required":["integration_configuration_id","type"],"type":"object","properties":{"type":{"enum":["LifecycleManager","Vendor","Custom"],"type":"string","allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponentType_TypeEnum"}],"readOnly":true},"integration_configuration_id":{"type":"string","description":"Integration configuration ID for the vendor","example":"int_cork_acme_prod"}},"additionalProperties":false,"description":"Vendor component type (requires integration configuration)"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponent":{"required":["component_key","component_name","component_type_configuration","configuration","id","snapshot_status"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the component","example":"f2a3b4c5-7d8e-4f9a-b0c1-d2e3f4a5b6c7"},"component_key":{"type":"string","description":"Component key identifier (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"component_name":{"type":"string","description":"Display name of the component (e.g., 'Budget', 'IT Glue', 'Roadmap')","example":"Budget"},"component_type_configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration"}],"oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom"}],"description":"Component type configuration (LM or vendor)","discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.LifecycleManager","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Vendor","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Custom"}}},"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentConfiguration"}],"description":"Component-specific configuration"},"snapshot_status":{"type":"string","description":"Current snapshot status (InProgress, Succeeded, Failed)","example":"Succeeded"},"last_snapshot_at":{"type":"string","description":"Timestamp of last snapshot generation","format":"date-time","nullable":true,"example":"2024-10-15T14:30:00Z"},"last_snapshot_by":{"type":"string","description":"User who generated the last snapshot","nullable":true,"example":"a1b2c3d4e5f6"},"output":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentOutput"}],"description":"Details about the output of a deliverable section component","nullable":true},"last_error_message":{"type":"string","description":"Last error message if snapshot failed","nullable":true,"example":"Connection timeout"}},"additionalProperties":false,"description":"Component information within a deliverable section"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentConfiguration":{"required":["data"],"type":"object","properties":{"data":{"description":"The configuration data of the component","example":"{\"selection_mode\":\"AllAvailableGoals\",\"status\":{\"ongoing\":true,\"overdue\":true,\"completed\":true}}"}},"additionalProperties":false,"description":"Details about the configuration of a deliverable section component"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentInput":{"required":["component_key","component_type_configuration"],"type":"object","properties":{"component_key":{"type":"string","description":"Component key identifier (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"component_type_configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration"}],"oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom"}],"description":"Component type configuration (LM or vendor)","discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.LifecycleManager","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Vendor","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Custom"}}},"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentConfiguration"}],"description":"Component-specific configuration","nullable":true}},"additionalProperties":false,"description":"A component within a deliverable section provides specific information or functionality (e.g., budget details, asset lists, vendor data)"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentOutput":{"required":["data","is_empty"],"type":"object","properties":{"schema_version":{"type":"string","description":"Version of the output schema used","nullable":true,"example":"2"},"data":{"description":"The output data of the component.\r\nThe structure of this data can vary depending on the component type and schema version. May contain PII.","example":"{\"summary\":{\"total_assets\":141,\"supported_users\":17}}"},"is_empty":{"type":"boolean","description":"Indicates whether the component has no meaningful data to display","example":"false"}},"additionalProperties":false,"description":"Details about the output of a deliverable section component"},"Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentPatchPayload":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of an existing component.\r\n\n<b>Optional.</b> When provided, updates the existing component with this ID.\r\nWhen omitted, creates a new component.","nullable":true,"example":"f2a3b4c5-7d8e-4f9a-b0c1-d2e3f4a5b6c7"},"component_key":{"type":"string","description":"Component key identifier (e.g., 'Budget', 'Cork', 'Roadmap').\r\n\n<b>Required when creating a new component</b> (no id provided). Must be non-empty\r\nand at most 255 characters. Optional when updating an existing component.","nullable":true,"example":"Budget"},"component_type_configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration"}],"oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom"}],"description":"Component type configuration (internal or vendor).\r\n\n<b>Required when creating a new component</b> (no id provided).\r\nOptional when updating an existing component.","nullable":true,"discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.LifecycleManager","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Vendor","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Custom"}}},"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentConfiguration"}],"description":"Component-specific configuration with fields array.\r\n\n<b>Optional.</b>","nullable":true}},"additionalProperties":false,"description":"A component within a deliverable section for PATCH operations with upsert semantics.\r\n\n<b>Update mode (id provided):</b> All other fields are optional.\n<b>Create mode (id omitted):</b>`component_key` and `component_type_configuration` are required.\r\n"},"Deliverable.DeliverableSection.DeliverableSectionInput":{"required":["components","display_order","section_key"],"type":"object","properties":{"section_key":{"type":"string","description":"Business key identifier for the section type (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"name":{"type":"string","description":"Custom display name for the section. When omitted, the default name for the section type is used.","nullable":true,"example":"Executive Summary"},"summary_json":{"type":"string","description":"Executive summary of this section in ProseMirror JSON format","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"This is the executive summary of the budget section.\"}]}]}"},"display_order":{"type":"integer","description":"The order in which this section should be displayed","format":"int32","example":"1"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentInput"},"description":"The components to include in this section that provide detailed information about specific aspects of the deliverable"}},"additionalProperties":false,"description":"The section of a deliverable, corresponding to a specific area such as 'Risk', 'Budget', or 'Roadmap' and contains various components that provide detailed information within that section."},"Deliverable.DeliverableSection.DeliverableSectionPatchPayload":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of an existing section.\r\n\n<b>Optional.</b> When provided, updates the existing section with this ID.\r\nWhen omitted, creates a new section.","nullable":true,"example":"e1f2a3b4-6c7d-4e8f-a9b0-c1d2e3f4a5b6"},"section_key":{"type":"string","description":"Business key identifier for the section type (e.g., 'Budget', 'Risk', 'Roadmap').\r\n\n<b>Required when creating a new section</b> (no id provided). Must be non-empty\r\nand at most 255 characters. Optional when updating an existing section.","nullable":true,"example":"Budget"},"name":{"type":"string","description":"Custom display name for the section.\r\n\n<b>Optional.</b> Send empty string to revert to the default name for the section type.","nullable":true,"example":"Executive Summary"},"summary_json":{"type":"string","description":"Executive summary of this section in ProseMirror JSON format.\r\n\n<b>Optional.</b>","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"This is the executive summary of the budget section.\"}]}]}"},"display_order":{"type":"integer","description":"Display order for the section. Lower numbers appear first.\r\n\n<b>Optional.</b>","format":"int32","nullable":true,"example":"1"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentPatchPayload"},"description":"Array of components with upsert semantics.\r\n\n<b>Optional.</b> Components with 'id' are updated; components without 'id' are created.\r\nExisting components not in this array remain unchanged.","nullable":true}},"additionalProperties":false,"description":"Section configuration for PATCH operations with upsert semantics.\r\n\n<b>Update mode (id provided):</b> All other fields are optional.\n<b>Create mode (id omitted):</b>`section_key` is required.\r\n\nSections not included in the request remain unchanged."},"Deliverable.DeliverableShare.Controller.DeliverableShareGeneralLinkGet_Response":{"required":["general_link"],"type":"object","properties":{"general_link":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableShare.Model.DeliverableShareGeneralLink"}],"description":"Represents a share link for a deliverable"}},"additionalProperties":false},"Deliverable.DeliverableShare.Model.DeliverableShareGeneralLink":{"required":["share_url"],"type":"object","properties":{"share_url":{"type":"string","description":"The public URL for the share link","example":"https://app.scalepad.com/shares/lm/abc123xyz"},"expires_at":{"type":"string","description":"When the link expires, if set","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"revoked_at":{"type":"string","description":"When the link was revoked, if set","format":"date-time","nullable":true,"example":"2025-12-31T23:59:59Z"},"password":{"type":"string","description":"The password for the share link (only returned for active links)","nullable":true,"example":"*UAYqZae)z1s"}},"additionalProperties":false,"description":"Represents a share link for a deliverable"},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreateFromDeliverable_Response":{"required":["deliverable_template"],"type":"object","properties":{"deliverable_template":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Model.DeliverableTemplate"}],"description":"Complete deliverable template information including all sections and components"}},"additionalProperties":false},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreateFromTemplate_Response":{"required":["deliverable_template"],"type":"object","properties":{"deliverable_template":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Model.DeliverableTemplate"}],"description":"Complete deliverable template information including all sections and components"}},"additionalProperties":false},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Request":{"required":["sections"],"type":"object","properties":{"name":{"type":"string","description":"The name of the deliverable template","nullable":true,"example":"QBR Template 2026"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionInput"}}},"additionalProperties":false},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplateCreate_Response":{"required":["deliverable_template"],"type":"object","properties":{"deliverable_template":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Model.DeliverableTemplate"}],"description":"Complete deliverable template information including all sections and components"}},"additionalProperties":false},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplateGet_Response":{"required":["deliverable_template"],"type":"object","properties":{"deliverable_template":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Model.DeliverableTemplate"}],"description":"Complete deliverable template information including all sections and components"}},"additionalProperties":false},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplateList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Model.DeliverableTemplateBasicInfo"}}},"additionalProperties":false},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplatePatch_Request":{"type":"object","properties":{"name":{"type":"string","description":"Business-facing name of the deliverable template, used for identification.\r\n\n<b>Optional.</b> When provided, must be non-empty and at most 255 characters.","nullable":true,"example":"Q1 2025 Strategic Review Template - Updated"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionPatchPayload"},"description":"Array of section configurations with upsert semantics.\r\n\n<b>Optional.</b> Sections with 'id' are updated; sections without 'id' are created.\r\nExisting sections not included in this array remain unchanged.","nullable":true}},"additionalProperties":false,"description":"Request payload for updating a deliverable template.\r\nAll fields are optional but at least one must be provided for a valid update."},"Deliverable.DeliverableTemplate.Controller.DeliverableTemplatePatch_Response":{"required":["deliverable_template"],"type":"object","properties":{"deliverable_template":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Model.DeliverableTemplate"}],"description":"Complete deliverable template information including all sections and components"}},"additionalProperties":false},"Deliverable.DeliverableTemplate.DeliverableTemplateCatalog.Controller.DeliverableTemplateCatalogList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableCatalog.DeliverableCatalogComponent.Model.DeliverableCatalogComponent"}}},"additionalProperties":false},"Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSection":{"required":["components","display_order","id","name","section_key"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the template section","example":"e1f2a3b4-6c7d-4e8f-a9b0-c1d2e3f4a5b6"},"section_key":{"type":"string","description":"Business key identifier for the section type (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"name":{"type":"string","description":"Display name of the section","example":"Budget"},"summary":{"type":"string","description":"Optional executive summary or description of this section","nullable":true,"example":"High-level overview of Q4 strategic initiatives and outcomes"},"display_order":{"type":"integer","description":"The order in which this section should be displayed","format":"int32","example":"1"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionComponent.DeliverableTemplateSectionComponent"},"description":"Array of components included in this template section"}},"additionalProperties":false,"description":"Section information within a deliverable template"},"Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionComponent.DeliverableTemplateSectionComponent":{"required":["component_key","component_type_configuration","configuration","id"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the template component","example":"f2a3b4c5-7d8e-4f9a-b0c1-d2e3f4a5b6c7"},"component_key":{"type":"string","description":"Component key identifier (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"component_type_configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration"}],"oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom"}],"description":"Component type configuration (LM or vendor)","discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.LifecycleManager","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Vendor","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Custom"}}},"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentConfiguration"}],"description":"Component-specific configuration"}},"additionalProperties":false,"description":"Component information within a deliverable template section"},"Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionComponent.DeliverableTemplateSectionComponentInput":{"required":["component_key","component_type_configuration"],"type":"object","properties":{"component_key":{"type":"string","description":"Component key identifier (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"component_type_configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration"}],"oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom"}],"description":"Component type configuration (LM or vendor)","discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.LifecycleManager","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Vendor","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Custom"}}},"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentConfiguration"}],"description":"Component-specific configuration","nullable":true}},"additionalProperties":false,"description":"Input DTO for creating a component within a deliverable template section"},"Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionComponent.DeliverableTemplateSectionComponentPatchPayload":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of an existing component.\r\n\n<b>Optional.</b> When provided, updates the existing component with this ID.\r\nWhen omitted, creates a new component.","nullable":true,"example":"f2a3b4c5-7d8e-4f9a-b0c1-d2e3f4a5b6c7"},"component_key":{"type":"string","description":"Component key identifier (e.g., 'Budget', 'Cork', 'Roadmap').\r\n\n<b>Required when creating a new component</b> (no id provided). Must be non-empty\r\nand at most 255 characters. Optional when updating an existing component.","nullable":true,"example":"Budget"},"component_type_configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration"}],"oneOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_LifecycleManager"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Vendor"},{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableComponentTypeConfiguration_Custom"}],"description":"Component type configuration (internal or vendor).\r\n\n<b>Required when creating a new component</b> (no id provided).\r\nOptional when updating an existing component.","nullable":true,"discriminator":{"propertyName":"type","mapping":{"LifecycleManager":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.LifecycleManager","Vendor":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Vendor","Custom":"#/components/schemas/Wm.Beast.Deliverable.Packages.DeliverableSection.Packages.DeliverableSectionComponent.Dto.DeliverableComponentTypeConfigurationDto.Custom"}}},"configuration":{"allOf":[{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSectionComponent.DeliverableSectionComponentConfiguration"}],"description":"Component-specific configuration with fields array.\r\n\n<b>Optional.</b>","nullable":true}},"additionalProperties":false,"description":"A component within a deliverable template section for PATCH operations with upsert semantics.\r\n\n<b>Update mode (id provided):</b> All other fields are optional.\n<b>Create mode (id omitted):</b>`component_key` and `component_type_configuration` are required.\r\n"},"Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionInput":{"required":["components","display_order","section_key"],"type":"object","properties":{"section_key":{"type":"string","description":"Business key identifier for the section type (e.g., 'Risk', 'Budget', 'Roadmap')","example":"Budget"},"name":{"type":"string","description":"Custom display name for the section. When omitted, the default name for the section type is used.","nullable":true,"example":"Executive Summary"},"summary":{"type":"string","description":"Optional executive summary or description of this section","nullable":true,"example":"High-level overview of Q4 strategic initiatives and outcomes"},"display_order":{"type":"integer","description":"The order in which this section should be displayed","format":"int32","example":"1"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionComponent.DeliverableTemplateSectionComponentInput"},"description":"The components to include in this template section"}},"additionalProperties":false,"description":"Input DTO for creating a section within a deliverable template"},"Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionPatchPayload":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of an existing section.\r\n\n<b>Optional.</b> When provided, updates the existing section with this ID.\r\nWhen omitted, creates a new section.","nullable":true,"example":"e1f2a3b4-6c7d-4e8f-a9b0-c1d2e3f4a5b6"},"section_key":{"type":"string","description":"Business key identifier for the section type (e.g., 'Budget', 'Risk', 'Roadmap').\r\n\n<b>Required when creating a new section</b> (no id provided). Must be non-empty\r\nand at most 255 characters. Optional when updating an existing section.","nullable":true,"example":"Budget"},"name":{"type":"string","description":"Custom display name for the section.\r\n\n<b>Optional.</b> Send empty string to revert to the default name for the section type.","nullable":true,"example":"Executive Summary"},"summary":{"type":"string","description":"Executive summary or description of this section.\r\n\n<b>Optional.</b>","nullable":true,"example":"High-level overview of Q4 strategic initiatives and outcomes"},"display_order":{"type":"integer","description":"Display order for the section. Lower numbers appear first.\r\n\n<b>Optional.</b>","format":"int32","nullable":true,"example":"1"},"components":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSectionComponent.DeliverableTemplateSectionComponentPatchPayload"},"description":"Array of components with upsert semantics.\r\n\n<b>Optional.</b> Components with 'id' are updated; components without 'id' are created.\r\nExisting components not in this array remain unchanged.","nullable":true}},"additionalProperties":false,"description":"Section configuration for PATCH operations with upsert semantics.\r\n\n<b>Update mode (id provided):</b> All other fields are optional.\n<b>Create mode (id omitted):</b>`section_key` is required.\r\n\nSections not included in the request remain unchanged."},"Deliverable.DeliverableTemplate.Model.DeliverableTemplate":{"required":["created_at","created_by","id","is_custom","name","sections","updated_at","updated_by"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deliverable template","example":"a1b2c3d4"},"name":{"type":"string","description":"Business-facing name of the deliverable template","example":"Q4 2024 Strategic Review Template"},"created_at":{"type":"string","description":"Timestamp when the deliverable template was created","format":"date-time","example":"2024-10-01T09:00:00Z"},"updated_at":{"type":"string","description":"Timestamp when the deliverable template was last updated","format":"date-time","example":"2024-10-15T14:30:00Z"},"created_by":{"type":"string","description":"User who created the deliverable template","example":"a1b2c3d4e5f6"},"updated_by":{"type":"string","description":"User who last updated the deliverable template","example":"a1b2c3d4e5f6"},"is_custom":{"type":"boolean","description":"Indicates whether this is a custom template created by the MSP","example":"false"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.DeliverableTemplateSection.DeliverableTemplateSection"},"description":"Array of sections included in this deliverable template"}},"additionalProperties":false,"description":"Complete deliverable template information including all sections and components"},"Deliverable.DeliverableTemplate.Model.DeliverableTemplateBasicInfo":{"required":["id","is_custom","name","sections","updated_at"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the template","example":"a1b2c3d4"},"name":{"type":"string","description":"Name of the template","example":"Quarterly Business Review Template"},"description":{"type":"string","description":"Description of the template","nullable":true,"example":"A comprehensive template for quarterly business reviews with clients"},"is_custom":{"type":"boolean","description":"Indicates whether this is a custom template created by the MSP","example":"false"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableTemplate.Model.DeliverableTemplateBasicInfoSection"},"description":"Sections included in this template"},"updated_at":{"type":"string","description":"Date and time when the template was last updated","format":"date-time"}},"additionalProperties":false},"Deliverable.DeliverableTemplate.Model.DeliverableTemplateBasicInfoSection":{"required":["component_keys","name","section_key"],"type":"object","properties":{"section_key":{"type":"string","description":"Unique key identifying the section","example":"Risk"},"name":{"type":"string","description":"Display name for the section","example":"Risk Management"},"component_keys":{"type":"array","items":{"type":"string"},"description":"List of Component key identifiers contain within the section(e.g., 'Risk', 'Budget', 'Roadmap')","example":"[Budget, Roadmap]"}},"additionalProperties":false},"Deliverable.Model.Deliverable":{"required":["client","created_at","created_by","id","meeting_link_info_list","name","sections","status","updated_at","updated_by"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deliverable","example":"a1b2c3d4"},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.ClientInfo"}],"description":"Client information"},"template_id":{"type":"string","description":"Template identifier if created from a template","nullable":true,"example":"d8e9f0a1"},"name":{"type":"string","description":"Business-facing name of the deliverable","example":"Q4 2024 Strategic Review"},"status":{"type":"string","description":"Current status of the deliverable (draft, published)","example":"Published"},"created_at":{"type":"string","description":"Timestamp when the deliverable was created","format":"date-time","example":"2024-10-01T09:00:00Z"},"updated_at":{"type":"string","description":"Timestamp when the deliverable was last updated","format":"date-time","example":"2024-10-15T14:30:00Z"},"created_by":{"type":"string","description":"User who created the deliverable","example":"a1b2c3d4e5f6"},"updated_by":{"type":"string","description":"User who last updated the deliverable","example":"a1b2c3d4e5f6"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/Deliverable.DeliverableSection.DeliverableSection"},"description":"Array of sections included in this deliverable"},"meeting_link_info_list":{"type":"array","items":{"$ref":"#/components/schemas/Meeting.Model.MeetingLinkInfoV2"},"description":"The meetings that this deliverable is linked to"}},"additionalProperties":false,"description":"Complete deliverable information including all sections and components"},"Deliverable.Model.DeliverableBasicInfo":{"required":["created_at","id","meeting_link_info_list","name","status","updated_at"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the deliverable","example":"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"},"name":{"type":"string","description":"Business-facing name of the deliverable","example":"Q4 2024 Strategic Review"},"status":{"type":"string","description":"Current status of the deliverable (draft, published)","example":"Published"},"created_at":{"type":"string","description":"Timestamp when the deliverable was created","format":"date-time","example":"2024-10-01T09:00:00Z"},"updated_at":{"type":"string","description":"Timestamp when the deliverable was last updated","format":"date-time","example":"2024-10-15T14:30:00Z"},"meeting_link_info_list":{"type":"array","items":{"$ref":"#/components/schemas/Meeting.Model.MeetingLinkInfoV2"},"description":"The meetings that this deliverable is linked to"}},"additionalProperties":false},"Goal.Controller.Public.GoalCreateFromTemplate_Request":{"required":["client_key"],"type":"object","properties":{"title":{"type":"string","description":"Optional title to use for the new goal. When omitted, the implementation may fall back to the template title or the default goal title.","nullable":true,"example":"Improve Network Security"},"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to create the goal for."}},"additionalProperties":false},"Goal.Controller.Public.GoalCreateFromTemplate_Response":{"required":["goal_id"],"type":"object","properties":{"goal_id":{"type":"string","description":"The unique identifier of the newly created goal.","example":"dhka7gwd"}},"additionalProperties":false},"Goal.Controller.Public.GoalCreate_Request":{"required":["client_key"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the goal for."},"title":{"type":"string","description":"The title of the goal.","nullable":true,"example":"Improve Network Security"},"description":{"type":"string","description":"The description of the goal.","nullable":true,"example":"Implement enhanced security measures across all client network infrastructure."},"status":{"type":"string","description":"The status of the goal.\r\n            \r\n- Available values: `OnTrack`, `AtRisk`, `OffTrack`, `OnHold`, `Complete`\r\n- Defaults to `OnTrack` if not provided.","nullable":true,"example":"OnTrack"},"target_period":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest"}],"oneOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodYear"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodHalf"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodQuarter"}],"description":"The target period for achieving the goal.","nullable":true,"discriminator":{"propertyName":"type","mapping":{"PeriodYear":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodYear","PeriodHalf":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodHalf","PeriodQuarter":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodQuarter"}}}},"additionalProperties":false},"Goal.Controller.Public.GoalCreate_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the newly created goal.","example":"dhka7gwd"}},"additionalProperties":false},"Goal.Controller.Public.GoalInitiativesList_Response":{"required":["initiative_ids"],"type":"object","properties":{"initiative_ids":{"type":"array","items":{"type":"string"},"description":"An array of unique identifiers for all initiatives aligned with this goal.\r\nUse these IDs to retrieve detailed initiative information via the Initiatives API.","example":["dhka7gwd","init5mn9"]}},"additionalProperties":false},"Goal.Controller.Public.GoalMeetingsList_Response":{"required":["meeting_ids"],"type":"object","properties":{"meeting_ids":{"type":"array","items":{"type":"string"},"description":"An array of unique identifiers for all meetings where this goal is discussed.\r\nUse these IDs to retrieve detailed meeting information via the Meetings API.","example":["mtn9kp45","mtnxq8r2"]}},"additionalProperties":false},"Goal.Controller.Public.GoalScheduleUpdate_Request":{"type":"object","properties":{"target_period":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2"}],"oneOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodYear"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodHalf"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodQuarter"}],"description":"The target period for achieving the goal.","nullable":true,"discriminator":{"propertyName":"type","mapping":{"PeriodYear":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodYear","PeriodHalf":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodHalf","PeriodQuarter":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodQuarter"}}}},"additionalProperties":false},"Goal.Controller.Public.GoalStatusUpdate_Request":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":"The status of the goal.\r\n            \r\n- Available values: `OnTrack`, `OffTrack`, `AtRisk`, `OnHold`, `Complete`.","example":"OnTrack"}},"additionalProperties":false},"Goal.Controller.Public.GoalUpdate_Request":{"required":["description","status","target_period","title"],"type":"object","properties":{"title":{"type":"string","description":"The title of the goal.","example":"Improve Network Security"},"description":{"type":"string","description":"The description of the goal.","example":"Implement enhanced security measures across all client network infrastructure."},"status":{"type":"string","description":"The status of the goal.\r\n            \r\n- Available values: `OnTrack`, `AtRisk`, `OffTrack`, `OnHold`, `Complete`.","example":"OnTrack"},"target_period":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest"}],"oneOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodYear"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodHalf"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodQuarter"}],"description":"The target period for achieving the goal.","discriminator":{"propertyName":"type","mapping":{"PeriodYear":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodYear","PeriodHalf":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodHalf","PeriodQuarter":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodQuarter"}}}},"additionalProperties":false},"Goal.GoalLink.GoalLinkInfoV2":{"required":["goal_id","link_id","period","status","title"],"type":"object","properties":{"link_id":{"type":"string","description":"The identifier that represents what this goal is linked to","example":"yvyvg9gg"},"goal_id":{"type":"string","description":"The identifier of the goal","example":"pus5gz77"},"title":{"type":"string","description":"The title of the goal","example":"Goal Title"},"period":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2"}],"oneOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodYear"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodHalf"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodQuarter"}],"description":"The period of the goal","discriminator":{"propertyName":"type","mapping":{"PeriodYear":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodYear","PeriodHalf":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodHalf","PeriodQuarter":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodQuarter"}}},"status":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalStatus.GoalStatusV2"}],"description":"The status enum key of the goal"}},"additionalProperties":false},"Goal.GoalPeriod.Model.GoalPeriodRequest":{"required":["type","year"],"type":"object","oneOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodYear"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodHalf"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodQuarter"}],"additionalProperties":false,"description":"The target period of the goal. May be targeted for a year, half, or quarter.","discriminator":{"propertyName":"type","mapping":{"PeriodYear":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodYear","PeriodHalf":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodHalf","PeriodQuarter":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodRequestDto.PeriodQuarter"}}},"Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodHalf":{"required":["half","year"],"type":"object","properties":{"type":{"type":"string","description":"The type of period. Always \"PeriodHalf\" for this type.","nullable":true,"example":"PeriodHalf"},"year":{"type":"integer","description":"The year of the period.","format":"int32","example":2025},"half":{"type":"integer","description":"The half-year period.\r\n            \r\n- Available values: `1` (first half), `2` (second half).","format":"int32","example":1}},"additionalProperties":false,"description":"Period representing a half-year (H1 or H2)."},"Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodQuarter":{"required":["quarter","year"],"type":"object","properties":{"type":{"type":"string","description":"The type of period. Always \"PeriodQuarter\" for this type.","nullable":true,"example":"PeriodQuarter"},"year":{"type":"integer","description":"The year of the period.","format":"int32","example":2025},"quarter":{"type":"integer","description":"The quarter of the year.\r\n            \r\n- Available values: `1` (Q1), `2` (Q2), `3` (Q3), `4` (Q4).","format":"int32","example":3}},"additionalProperties":false,"description":"Period representing a quarter (Q1, Q2, Q3, Q4)."},"Goal.GoalPeriod.Model.GoalPeriodRequest_PeriodYear":{"required":["year"],"type":"object","properties":{"type":{"type":"string","description":"The type of period. Always \"PeriodYear\" for this type.","nullable":true,"example":"PeriodYear"},"year":{"type":"integer","description":"The year of the period.","format":"int32","example":2025}},"additionalProperties":false,"description":"Period representing a full year."},"Goal.GoalPeriod.Model.GoalPeriodV2":{"required":["type","year"],"type":"object","oneOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodYear"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodHalf"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodQuarter"}],"additionalProperties":false,"discriminator":{"propertyName":"type","mapping":{"PeriodYear":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodYear","PeriodHalf":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodHalf","PeriodQuarter":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodQuarter"}}},"Goal.GoalPeriod.Model.GoalPeriodV2_PeriodEnum":{"enum":["PeriodYear","PeriodHalf","PeriodQuarter"],"type":"string"},"Goal.GoalPeriod.Model.GoalPeriodV2_PeriodHalf":{"required":["half","type","year"],"type":"object","properties":{"type":{"enum":["PeriodYear","PeriodHalf","PeriodQuarter"],"type":"string","allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodEnum"}],"description":"The type of period.\r\n            \r\n- Available values: `PeriodYear`, `PeriodHalf`, `PeriodQuarter`.","readOnly":true,"example":"PeriodQuarter"},"year":{"type":"integer","description":"The year of the period.","format":"int32","example":2025},"half":{"type":"integer","description":"The half-year period.\r\n            \r\n- Available values: `1` (first half), `2` (second half).","format":"int32","example":1}},"additionalProperties":false},"Goal.GoalPeriod.Model.GoalPeriodV2_PeriodQuarter":{"required":["quarter","type","year"],"type":"object","properties":{"type":{"enum":["PeriodYear","PeriodHalf","PeriodQuarter"],"type":"string","allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodEnum"}],"description":"The type of period.\r\n            \r\n- Available values: `PeriodYear`, `PeriodHalf`, `PeriodQuarter`.","readOnly":true,"example":"PeriodQuarter"},"year":{"type":"integer","description":"The year of the period.","format":"int32","example":2025},"quarter":{"type":"integer","description":"The quarter of the year. Available values: `1` (Q1), `2` (Q2), `3` (Q3), `4` (Q4).","format":"int32","example":3}},"additionalProperties":false},"Goal.GoalPeriod.Model.GoalPeriodV2_PeriodYear":{"required":["type","year"],"type":"object","properties":{"type":{"enum":["PeriodYear","PeriodHalf","PeriodQuarter"],"type":"string","allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodEnum"}],"description":"The type of period.\r\n            \r\n- Available values: `PeriodYear`, `PeriodHalf`, `PeriodQuarter`.","readOnly":true,"example":"PeriodQuarter"},"year":{"type":"integer","description":"The year of the period.","format":"int32","example":2025}},"additionalProperties":false},"Goal.GoalStatus.GoalStatusV2":{"required":["color","display_icon","display_label","id"],"type":"object","properties":{"id":{"type":"string","description":"Unique Id for the Goal status"},"display_label":{"type":"string","description":"Label for the Goal status to be displayed in the frontend"},"display_icon":{"type":"string","description":"Icon for the Goal status to be displayed in the frontend"},"color":{"type":"string","description":"The color for the Goal status to be displayed in the frontend"}},"additionalProperties":false},"Goal.GoalTemplate.Controller.Public.GoalTemplateCreate_Request":{"required":["goal_template"],"type":"object","properties":{"goal_template":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Model.GoalTemplateCreatePayload"}],"description":"Goal template fields to create."}},"additionalProperties":false},"Goal.GoalTemplate.Controller.Public.GoalTemplateCreate_Response":{"required":["goal_template_id"],"type":"object","properties":{"goal_template_id":{"type":"string","description":"Unique identifier of the newly created goal template.","example":"fhafyiyr"}},"additionalProperties":false},"Goal.GoalTemplate.Controller.Public.GoalTemplateGet_Response":{"required":["goal_template"],"type":"object","properties":{"goal_template":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Model.Public.GoalTemplatePublic"}],"description":"Full detail for the requested goal template."}},"additionalProperties":false},"Goal.GoalTemplate.Controller.Public.GoalTemplateUpdate_Request":{"required":["goal_template"],"type":"object","properties":{"goal_template":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalTemplate.Model.Public.GoalTemplateUpdatePayloadPublic"}],"description":"Goal template fields to update."}},"additionalProperties":false},"Goal.GoalTemplate.Controller.Public.GoalTemplatesList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Goal.GoalTemplate.Model.Public.GoalTemplatePublic"},"description":"Goal templates available to the authenticated account."}},"additionalProperties":false},"Goal.GoalTemplate.Model.GoalTemplateCreatePayload":{"required":["initiative_template_ids","title"],"type":"object","properties":{"title":{"type":"string","description":"Display name for the new account-scoped goal template.","example":"Quarterly Security Review"},"description":{"type":"string","description":"Reusable description applied to goals created from this template.","nullable":true},"initiative_template_ids":{"type":"array","items":{"type":"string"},"description":"Initiative template identifiers to attach to the goal template. Must contain at least one value."}},"additionalProperties":false},"Goal.GoalTemplate.Model.Public.GoalTemplateInitiativeTemplateSummaryPublic":{"required":["action_item_count","initiative_template_id","name","one_time_fee_count","recurring_fee_count"],"type":"object","properties":{"initiative_template_id":{"type":"string","description":"Unique identifier of the linked initiative template.","example":"hfsfh7ty3"},"name":{"type":"string","description":"Display name of the linked initiative template.","example":"Deploy MFA"},"one_time_fee_count":{"type":"integer","description":"Number of one-time fee line items configured on the linked initiative template.","format":"int32"},"recurring_fee_count":{"type":"integer","description":"Number of recurring fee line items configured on the linked initiative template.","format":"int32"},"action_item_count":{"type":"integer","description":"Number of action items configured on the linked initiative template.","format":"int32"}},"additionalProperties":false},"Goal.GoalTemplate.Model.Public.GoalTemplatePublic":{"required":["goal_template_id","initiative_templates","record_created_at","record_updated_at","scope","title"],"type":"object","properties":{"goal_template_id":{"type":"string","description":"Unique identifier of the goal template.","example":"fhafyiyr"},"scope":{"type":"string","description":"Visibility scope of the goal template.\r\n            \r\nAvailable values: Application, Account.","example":"Application"},"title":{"type":"string","description":"Display name of the goal template shown in management and goal creation flows.","example":"Quarterly Security Review"},"description":{"type":"string","description":"Reusable description applied to goals created from this template.","nullable":true},"initiative_templates":{"type":"array","items":{"$ref":"#/components/schemas/Goal.GoalTemplate.Model.Public.GoalTemplateInitiativeTemplateSummaryPublic"},"description":"Initiative templates linked to this goal template."},"record_created_at":{"type":"string","description":"Date and time when the goal template was created.","format":"date-time","example":"2026-04-01T14:30:00Z"},"record_updated_at":{"type":"string","description":"Date and time when the goal template was last updated.","format":"date-time","example":"2026-04-01T15:45:00Z"}},"additionalProperties":false},"Goal.GoalTemplate.Model.Public.GoalTemplateUpdatePayloadPublic":{"required":["initiative_template_ids","title"],"type":"object","properties":{"title":{"type":"string","description":"Updated display name for the goal template.","example":"Quarterly Security Review"},"description":{"type":"string","description":"Updated reusable description applied to goals created from this template.","nullable":true},"initiative_template_ids":{"type":"array","items":{"type":"string"},"description":"Initiative template identifiers to attach to the goal template. Can be empty."}},"additionalProperties":false},"Goal.Model.Public.GoalOverviewPublic":{"required":["client","id","period","record_created_at","record_updated_at","status","title"],"type":"object","properties":{"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"The basic information of the client owns the goal"},"id":{"type":"string","description":"Identifier of the goal","example":"dgjsdgt3"},"title":{"type":"string","description":"Title of the goal","example":"Goal for 2025"},"description":{"type":"string","description":"Description of the goal","nullable":true,"example":"Manage asset lifecycle for client"},"status":{"type":"string","description":"Status of the goal, e.g. OnTrack, AtRisk, OffTrack, OnHold, Complete","example":"Complete"},"period":{"allOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2"}],"oneOf":[{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodYear"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodHalf"},{"$ref":"#/components/schemas/Goal.GoalPeriod.Model.GoalPeriodV2_PeriodQuarter"}],"description":"Information about the goal's period, Year, Quarter, etc.","discriminator":{"propertyName":"type","mapping":{"PeriodYear":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodYear","PeriodHalf":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodHalf","PeriodQuarter":"#/components/schemas/Wm.Beast.Goal.Packages.GoalPeriod.Dto.Model.GoalPeriodDtoV2.PeriodQuarter"}},"example":2025},"record_created_at":{"type":"string","description":"The date and time when the goal was created.","format":"date-time","example":"2025-01-15T10:30:00Z"},"record_updated_at":{"type":"string","description":"The date and time when the goal was last updated.","format":"date-time","example":"2025-03-20T14:45:00Z"}},"additionalProperties":false},"Identity.User.Model.Public.UserKeyPublic":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the user, must be provided when email is missing","nullable":true,"example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"email":{"type":"string","description":"Unique email address of the user, must be provided when id is missing","nullable":true,"example":"john.doe@company.com"}},"additionalProperties":false},"Initiative.Budget.Model.Budget":{"required":["currency","line_items","recurring_line_items"],"type":"object","properties":{"line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetLineItem"},"description":"The line items existing on this budget"},"recurring_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Recurring.Model.RecurringLineItem"},"description":"Recurring line items existing on this budget"},"currency":{"allOf":[{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetCurrency"}],"description":"The currency used in this budget"}},"additionalProperties":false},"Initiative.Budget.Model.BudgetCurrency":{"required":["code_alpha","subunit_ratio"],"type":"object","properties":{"code_alpha":{"type":"string","description":"The ISO 4217 three letter currency code.","example":"USD"},"subunit_ratio":{"type":"number","description":"The subunit-to-unit ratio for this currency.\r\n            \r\ne.g., 1 bitcoin is 100,000,000 satoshis (the smallest unit).\r\nTherefore the subunit ratio of bitcoin is 100,000,000.","format":"double","example":100}},"additionalProperties":false,"description":"This is a subset of currency information relevant to budgets in a proposal"},"Initiative.Budget.Model.BudgetLineItem":{"required":["cost_subunits","cost_type","label"],"type":"object","properties":{"label":{"type":"string","description":"States what the budget line is for\r\n            \r\n- Maximum character length: 400","example":"Asset Warranty"},"cost_subunits":{"type":"integer","description":"Cost of this item in subunits of the currency\r\ne.g., if USD this would be cents, if Bitcoin this would be Satoshis","format":"int64","example":1500},"unit_count":{"type":"integer","description":"The number of units the per unit cost applies to.\r\nOnly applied if cost_type is PerUnit","format":"int32","nullable":true,"example":100},"cost_type":{"enum":["Fixed","PerAsset","PerUnit"],"type":"string","allOf":[{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetLineItem_CostTypeEnum"}],"description":"Scale factor for the cost (fixed cost, or scales per asset)\r\n            \r\n- Available values: \"Fixed\", \"PerAsset\", \"PerUnit\".","example":"PerAsset"}},"additionalProperties":false},"Initiative.Budget.Model.BudgetLineItem_CostTypeEnum":{"enum":["Fixed","PerAsset","PerUnit"],"type":"string"},"Initiative.Controller.Public.InitiativeActionItemsList_Response":{"required":["action_item_ids"],"type":"object","properties":{"action_item_ids":{"type":"array","items":{"type":"string"},"description":"The list of action item IDs that are aligned with the initiative.","example":["xmk8hj32","pug5gz77","abc12def"]}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeAssetAttach_Request":{"required":["hardware_keys"],"type":"object","properties":{"hardware_keys":{"type":"array","items":{"$ref":"#/components/schemas/Asset.Model.Public.HardwareKeyPublic"},"description":"The hardware assets to attach to the initiative, identified by their unique key."}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeAssetDetach_Request":{"required":["hardware_keys"],"type":"object","properties":{"hardware_keys":{"type":"array","items":{"$ref":"#/components/schemas/Asset.Model.Public.HardwareKeyPublic"},"description":"The hardware assets to detach from the initiative, identified by their unique key."}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeCreate_Request":{"required":["client_key","name"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the initiative for."},"name":{"type":"string","description":"The name of the initiative.","example":"Network Security Upgrade"},"executive_summary":{"type":"string","description":"Deprecated by 'executive_summary_json', using this field will overwrite rich text\r\n            \r\nA brief summary of the initiative (optional).","nullable":true,"example":"Implement enhanced security measures across all client network infrastructure.","deprecated":true},"executive_summary_json":{"type":"string","description":"A brief summary of the initiative (optional) in ProseMirror JSON format.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeCreate_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the newly created initiative.","example":"dhka7gwd"}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeGet_Response":{"required":["initiative"],"type":"object","properties":{"initiative":{"allOf":[{"$ref":"#/components/schemas/Initiative.Model.Public.InitiativePublic"}],"description":"The complete initiative object containing all details including budget, status, and schedule."}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeGoalsList_Response":{"required":["goal_ids"],"type":"object","properties":{"goal_ids":{"type":"array","items":{"type":"string"},"description":"The list of goal IDs that are aligned with the initiative.","example":["pug5gz77","xmk8hj32","abc12def"]}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeMeetingsList_Response":{"required":["meeting_ids"],"type":"object","properties":{"meeting_ids":{"type":"array","items":{"type":"string"},"description":"The list of meeting IDs that are aligned with the initiative.","example":["mtn9kp45","pug5gz77","abc12def"]}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeUpdateBudget_Request":{"type":"object","properties":{"budget_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetLineItem"},"description":"The complete array of budget line items for one-time investments. Pass an empty array to clear all items.","nullable":true}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeUpdatePriority_Request":{"required":["priority"],"type":"object","properties":{"priority":{"type":"string","description":"The new priority value for the initiative.\r\n            \r\n- Available values: `None`, `Low`, `Medium`, `High`.","example":"High"}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeUpdateRecurring_Request":{"type":"object","properties":{"recurring_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Recurring.Model.RecurringLineItem"},"description":"The complete array of recurring line items for ongoing investments. Pass an empty array to clear all items.","nullable":true}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeUpdateSchedule_Request":{"type":"object","properties":{"fiscal_quarter":{"allOf":[{"$ref":"#/components/schemas/Date.Range.FiscalQuarter"}],"description":"The fiscal quarter schedule for the initiative. Set to `null` to mark the initiative as unscheduled.","nullable":true}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeUpdateStatus_Request":{"required":["status"],"type":"object","properties":{"status":{"type":"string","description":"The new status value for the initiative.\r\n            \r\n- Available values: `New`, `Proposed`, `Approved`, `InProgress`, `OnHold`, `Declined`, `Completed`.","example":"InProgress"}},"additionalProperties":false},"Initiative.Controller.Public.InitiativeUpdate_Request":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the initiative.","example":"Network Security Upgrade"},"executive_summary":{"type":"string","description":"Deprecated by 'executive_summary_json', using this field will overwrite rich text\r\n            \r\nA brief summary of the initiative (optional).","nullable":true,"example":"Implement enhanced security measures across all client network infrastructure.","deprecated":true},"executive_summary_json":{"type":"string","description":"A brief summary of the initiative (optional).","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"}},"additionalProperties":false},"Initiative.InitiativeLink.InitiativeLinkInfoV2":{"required":["initiative_id","initiative_link_id","initiative_name"],"type":"object","properties":{"initiative_link_id":{"type":"string","description":"Id of the initiative link","example":"123"},"initiative_id":{"type":"string","description":"Id of the initiative the link is associated with","example":"12345"},"initiative_name":{"type":"string","description":"Name of the Initiative that is linked","example":"Initiative name"}},"additionalProperties":false},"Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateCreate_Request":{"required":["initiative_template"],"type":"object","properties":{"initiative_template":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Model.InitiativeTemplateCreatePayload"}],"description":"The initiative template details to create."}},"additionalProperties":false},"Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateCreate_Response":{"required":["initiative_template_id"],"type":"object","properties":{"initiative_template_id":{"type":"string","description":"Unique identifier of the newly created initiative template.","example":"abc123de"}},"additionalProperties":false},"Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateGet_Response":{"required":["initiative_template"],"type":"object","properties":{"initiative_template":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Model.InitiativeTemplate"}],"description":"Full detail of the requested initiative template including budget, recurring costs, and action items."}},"additionalProperties":false},"Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateList_Response":{"required":["templates_account","templates_application"],"type":"object","properties":{"templates_application":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Model.InitiativeTemplate"},"description":"Globally available initiative templates provided by the platform, ordered alphabetically by name."},"templates_account":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Model.InitiativeTemplate"},"description":"Account-specific initiative templates created by users in this account, ordered by most recently created first."}},"additionalProperties":false},"Initiative.InitiativeTemplate.Controller.Public.InitiativeTemplateUpdate_Request":{"required":["initiative_template"],"type":"object","properties":{"initiative_template":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeTemplate.Model.InitiativeTemplateUpdatePayloadPublic"}],"description":"The initiative template fields to update. Only account-scoped templates can be updated."}},"additionalProperties":false},"Initiative.InitiativeTemplate.Model.InitiativeTemplate":{"required":["action_items","budget_line_items","has_budget_calculator","initiative_template_id","is_recommended","name","record_created_at","record_updated_at","recurring_line_items","scope"],"type":"object","properties":{"initiative_template_id":{"type":"string","description":"Unique identifier for this initiative template.","example":"42"},"name":{"type":"string","description":"Display name of the initiative template shown to users when creating or reviewing initiatives.","example":"Workstation Replacement"},"scope":{"type":"string","description":"Visibility scope of the template.\r\n            \r\nAvailable values: Application, Account.\r\nApplication templates are globally available; Account templates are specific to the owning account.","example":"Application"},"executive_summary_json":{"type":"string","description":"Pre-filled executive summary in ProseMirror JSON format, included when an initiative is created from this template. May be null if no summary is configured.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"},"budget_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetLineItem"},"description":"One-time budget line items included in the template. Returns an empty array when no budget items are configured."},"recurring_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Recurring.Model.RecurringLineItem"},"description":"Recurring cost line items included in the template. Returns an empty array when no recurring items are configured."},"action_items":{"type":"array","items":{"type":"string"},"description":"Checklist of action items pre-populated when an initiative is created from this template. Returns an empty array when none are configured."},"is_recommended":{"type":"boolean","description":"Whether or not this template is recommended for use in the given insight context.","example":false},"has_budget_calculator":{"type":"boolean","description":"Whether this template uses a dynamic budget calculator to compute costs automatically based on linked assets.","example":false},"record_created_at":{"type":"string","description":"UTC timestamp when this template was created.","format":"date-time","example":"2025-09-15T14:30:00Z"},"record_updated_at":{"type":"string","description":"UTC timestamp when this template was last modified.","format":"date-time","example":"2025-11-02T09:15:00Z"}},"additionalProperties":false},"Initiative.InitiativeTemplate.Model.InitiativeTemplateCreatePayload":{"required":["action_items","budget_line_items","name","recurring_line_items"],"type":"object","properties":{"name":{"type":"string","description":"Display name for the new initiative template. Must not be empty.","example":"Server Replacement"},"executive_summary_json":{"type":"string","description":"Executive summary in ProseMirror JSON format","nullable":true},"budget_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetLineItem"},"description":"One-time budget line items to include in the template. Pass an empty array if no budget items are needed."},"recurring_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Recurring.Model.RecurringLineItem"},"description":"Recurring cost line items to include in the template. Pass an empty array if no recurring items are needed."},"action_items":{"type":"array","items":{"type":"string"},"description":"Checklist of action items to pre-populate when an initiative is created from this template. Pass an empty array if none are needed."}},"additionalProperties":false},"Initiative.InitiativeTemplate.Model.InitiativeTemplateUpdatePayloadPublic":{"required":["action_items","budget_line_items","name","recurring_line_items"],"type":"object","properties":{"name":{"type":"string","description":"Updated display name for the initiative template. Must not be empty.","example":"Server Replacement"},"executive_summary_json":{"type":"string","description":"Executive summary in ProseMirror JSON format. Pass null to clear the existing summary.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"},"budget_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetLineItem"},"description":"Replacement set of one-time budget line items for the template. Pass an empty array to clear all budget items."},"recurring_line_items":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Recurring.Model.RecurringLineItem"},"description":"Replacement set of recurring cost line items for the template. Pass an empty array to clear all recurring items."},"action_items":{"type":"array","items":{"type":"string"},"description":"Replacement checklist of action items for the template. Pass an empty array to clear all action items."}},"additionalProperties":false},"Initiative.Model.Public.InitiativePublic":{"required":["asset_count","assigned_user_id","budget","client","created_at","id","name","priority","status","updated_at"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the initiative.","example":"fdastyd3"},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"Information about the client for which the initiative is created."},"name":{"type":"string","description":"The name of the initiative.","example":"Network Security Upgrade"},"executive_summary":{"type":"string","description":"A brief summary of the initiative.","nullable":true,"example":"Implement enhanced security measures across all client network infrastructure."},"executive_summary_json":{"type":"string","description":"A brief summary of the initiative in ProseMirror JSON format.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"},"fiscal_quarter":{"allOf":[{"$ref":"#/components/schemas/Date.Range.FiscalQuarter"}],"description":"The fiscal quarter for when the client has resources for the initiative.","nullable":true},"assigned_user_id":{"type":"string","description":"User id who is responsible for the initiative","example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"budget":{"allOf":[{"$ref":"#/components/schemas/Initiative.Budget.Model.Budget"}],"description":"The detailed budget information of the initiative."},"priority":{"type":"string","description":"The priority level of the initiative.\r\n            \r\n- Available values: `None`, `Low`, `Medium`, `High`.","example":"Medium"},"status":{"type":"string","description":"The current status of the initiative.\r\n            \r\n- Available values: `New`, `Proposed`, `Approved`, `InProgress`, `OnHold`, `Declined`, `Completed`.","example":"New"},"asset_count":{"type":"integer","description":"The number of assets associated with the initiative.","format":"int32","example":20},"created_at":{"type":"string","description":"The date and time when this initiative was created.","format":"date-time","example":"2025-11-10T15:30:00Z"},"updated_at":{"type":"string","description":"The date and time when this initiative was last updated.","format":"date-time","example":"2025-11-13T15:30:00Z"}},"additionalProperties":false},"Initiative.Recurring.Model.RecurringLineItem":{"required":["cost_subunits","cost_type","frequency","label"],"type":"object","properties":{"label":{"type":"string","description":"States what the recurring line is for\r\n            \r\n- Maximum character length: 400","example":"Anti-virus software license"},"cost_subunits":{"type":"integer","description":"Cost of this item in subunits of the currency\r\ne.g., if USD this would be cents, if Bitcoin this would be Satoshis","format":"int64","example":300},"cost_type":{"enum":["Fixed","PerAsset","PerUnit"],"type":"string","allOf":[{"$ref":"#/components/schemas/Initiative.Budget.Model.BudgetLineItem_CostTypeEnum"}],"description":"Scale factor for the cost\r\n            \r\n- Available values: \"Fixed\", \"PerAsset\", \"PerUnit\".","example":"PerAsset"},"unit_count":{"type":"integer","description":"The number of units the per unit cost applies to.\r\nOnly applied if cost_type is PerUnit","format":"int32","nullable":true,"example":100},"frequency":{"enum":["Monthly","Yearly"],"type":"string","allOf":[{"$ref":"#/components/schemas/Initiative.Recurring.Model.RecurringLineItem_FrequencyEnum"}],"description":"Frequency at which this recurs\r\n            \r\n- Available values: \"Monthly\", \"Yearly\".","example":"Monthly"}},"additionalProperties":false},"Initiative.Recurring.Model.RecurringLineItem_FrequencyEnum":{"enum":["Monthly","Yearly"],"type":"string"},"LinkType.Public.LinkedItemPublic":{"required":["id","link_id","type"],"type":"object","properties":{"type":{"type":"string","description":"The type of the linked item.","example":"Goal"},"id":{"type":"string","description":"The unique identifier of the linked item.","example":"dhka7gwd"},"link_id":{"type":"string","description":"The unique identifier of the link between the note and the item.","example":"lnk8a7gw"},"title":{"type":"string","description":"The title of the linked item.","nullable":true,"example":"Improve Network Security"},"description":{"type":"string","description":"The description of the linked item.","nullable":true,"example":"Implement enhanced security measures across all client network infrastructure."}},"additionalProperties":false},"Meeting.Controller.Public.MeetingActionItemsList_Response":{"required":["action_item_ids"],"type":"object","properties":{"action_item_ids":{"type":"array","items":{"type":"string"},"description":"The list of action item IDs that are linked to the meeting.","example":["xmk8hj32","pus5gz77","abc12def"]}},"additionalProperties":false},"Meeting.Controller.Public.MeetingAttendeeContactAdd_Request":{"required":["contact_keys"],"type":"object","properties":{"contact_keys":{"type":"array","items":{"$ref":"#/components/schemas/Contact.Model.Public.ContactKeyPublic"},"description":"The list of contact keys to add as client attendees."}},"additionalProperties":false},"Meeting.Controller.Public.MeetingAttendeeContactAdd_Response":{"required":["contact_ids"],"type":"object","properties":{"contact_ids":{"type":"array","items":{"type":"string"},"description":"List of Contacts added to the meeting.","example":["1796457b-7576-42bb-b51b-ffcbd26c8d67","9c7d6003-a770-4df5-9f5e-3de77d8a330f"]}},"additionalProperties":false},"Meeting.Controller.Public.MeetingAttendeeContactRemove_Request":{"required":["contact_keys"],"type":"object","properties":{"contact_keys":{"type":"array","items":{"$ref":"#/components/schemas/Contact.Model.Public.ContactKeyPublic"},"description":"The list of contact keys to remove as client attendees."}},"additionalProperties":false},"Meeting.Controller.Public.MeetingAttendeeUserAdd_Request":{"required":["user_keys"],"type":"object","properties":{"user_keys":{"type":"array","items":{"$ref":"#/components/schemas/Identity.User.Model.Public.UserKeyPublic"},"description":"The list of user keys to add as attendees."}},"additionalProperties":false},"Meeting.Controller.Public.MeetingAttendeeUserAdd_Response":{"required":["user_ids"],"type":"object","properties":{"user_ids":{"type":"array","items":{"type":"string"},"description":"List of account users added to the meeting.","example":["1796457b-7576-42bb-b51b-ffcbd26c8d67","9c7d6003-a770-4df5-9f5e-3de77d8a330f"]}},"additionalProperties":false},"Meeting.Controller.Public.MeetingAttendeeUserRemove_Request":{"required":["user_keys"],"type":"object","properties":{"user_keys":{"type":"array","items":{"$ref":"#/components/schemas/Identity.User.Model.Public.UserKeyPublic"},"description":"The list of user keys to remove as attendees."}},"additionalProperties":false},"Meeting.Controller.Public.MeetingCompleteStatusUpdate_Request":{"required":["is_completed"],"type":"object","properties":{"is_completed":{"type":"boolean","description":"Set to `true` to mark the meeting as completed, or `false` to mark it as incomplete.","example":true}},"additionalProperties":false},"Meeting.Controller.Public.MeetingCreateV1_Request":{"required":["client_key"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the meeting for."},"title":{"type":"string","description":"The title of the meeting. Defaults to \"Untitled Meeting\" if not provided.","nullable":true,"example":"Onboard New Client"},"type":{"type":"string","description":"The type of meeting to be conducted. Defaults to `BusinessReview` if not provided.\r\n            \r\n- Available values: `BusinessReview`, `AnnualBusinessReview`, `Discovery`, `Onboarding`, `CheckIn`, `PhoneCall`, `ProjectMeeting`.","nullable":true,"example":"BusinessReview"},"starts_at":{"type":"string","description":"The scheduled start date and time.","format":"date-time","nullable":true,"example":"2025-09-30T09:00:00Z"},"ends_at":{"type":"string","description":"The scheduled end date and time.","format":"date-time","nullable":true,"example":"2025-09-30T10:00:00Z"},"agenda_json":{"type":"string","description":"The agenda of the meeting in ProseMirror JSON format.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"}},"additionalProperties":false},"Meeting.Controller.Public.MeetingCreateV1_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the newly created meeting.","example":"dhka7gwd"}},"additionalProperties":false},"Meeting.Controller.Public.MeetingCreateV2_Request":{"required":["client_key"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the meeting for."},"title":{"type":"string","description":"The title of the meeting. Defaults to \"Untitled Meeting\" if not provided.","nullable":true,"example":"Onboard New Client"},"type":{"type":"string","description":"The id for the type of meeting to be conducted.","nullable":true,"example":"abc123de"},"starts_at":{"type":"string","description":"The scheduled start date and time.","format":"date-time","nullable":true,"example":"2025-09-30T09:00:00Z"},"ends_at":{"type":"string","description":"The scheduled end date and time.","format":"date-time","nullable":true,"example":"2025-09-30T10:00:00Z"},"agenda_json":{"type":"string","description":"The agenda of the meeting in ProseMirror JSON format.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"}},"additionalProperties":false},"Meeting.Controller.Public.MeetingCreateV2_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the newly created meeting.","example":"dhka7gwd"}},"additionalProperties":false},"Meeting.Controller.Public.MeetingGet_Response":{"required":["meeting"],"type":"object","properties":{"meeting":{"allOf":[{"$ref":"#/components/schemas/Meeting.Model.Public.MeetingPublic"}],"description":"The complete meeting object containing all details including attendees."}},"additionalProperties":false},"Meeting.Controller.Public.MeetingGoalsList_Response":{"required":["goal_ids"],"type":"object","properties":{"goal_ids":{"type":"array","items":{"type":"string"},"description":"An array of unique identifiers for all goals attached to this meeting.","example":["gk7mn2p4","gk8xq5r9"]}},"additionalProperties":false},"Meeting.Controller.Public.MeetingInitiativesList_Response":{"required":["initiative_ids"],"type":"object","properties":{"initiative_ids":{"type":"array","items":{"type":"string"},"description":"An array of unique identifiers for all initiatives attached to this meeting.","example":["dhka7gwd","init5mn9"]}},"additionalProperties":false},"Meeting.Controller.Public.MeetingUpdateV1_Request":{"required":["title","type"],"type":"object","properties":{"title":{"type":"string","description":"The title of the meeting.","example":"Onboard New Client"},"type":{"type":"string","description":"The type of meeting to be conducted.\r\n            \r\nIf this meeting type was renamed, we will default to the first meeting type for the account.\r\n            \r\n- Available values: `BusinessReview`, `AnnualBusinessReview`, `Discovery`, `Onboarding`, `CheckIn`, `PhoneCall`, `ProjectMeeting`.","example":"BusinessReview"},"starts_at":{"type":"string","description":"The scheduled start date and time.","format":"date-time","nullable":true,"example":"2025-09-30T09:00:00Z"},"ends_at":{"type":"string","description":"The scheduled end date and time.","format":"date-time","nullable":true,"example":"2025-09-30T10:00:00Z"},"agenda_json":{"type":"string","description":"The agenda of the meeting in ProseMirror JSON format.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"}},"additionalProperties":false},"Meeting.Controller.Public.MeetingUpdateV2_Request":{"required":["title","type"],"type":"object","properties":{"title":{"type":"string","description":"The title of the meeting.","example":"Onboard New Client"},"type":{"type":"string","description":"The id for the type of meeting to be conducted.","example":"abc123de"},"starts_at":{"type":"string","description":"The scheduled start date and time.","format":"date-time","nullable":true,"example":"2025-09-30T09:00:00Z"},"ends_at":{"type":"string","description":"The scheduled end date and time.","format":"date-time","nullable":true,"example":"2025-09-30T10:00:00Z"},"agenda_json":{"type":"string","description":"The agenda of the meeting in ProseMirror JSON format.","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"}},"additionalProperties":false},"Meeting.MeetingType.Controller.Public.MeetingTypeCreate_Request":{"required":["label"],"type":"object","properties":{"label":{"type":"string","description":"Short human-friendly description of what the type of Meeting is occuring","example":"Business review"}},"additionalProperties":false},"Meeting.MeetingType.Controller.Public.MeetingTypeCreate_Response":{"required":["meeting_type_id"],"type":"object","properties":{"meeting_type_id":{"type":"string","description":"The unique identifier of the created meeting type.","example":"abc123de"}},"additionalProperties":false},"Meeting.MeetingType.Controller.Public.MeetingTypeList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Meeting.MeetingType.MeetingType"},"description":"Meeting types available for the account"}},"additionalProperties":false},"Meeting.MeetingType.Controller.Public.MeetingTypeUpdate_Request":{"required":["label"],"type":"object","properties":{"label":{"type":"string","description":"Short human-friendly description of what the type of Meeting is occuring","example":"Business review"}},"additionalProperties":false},"Meeting.MeetingType.MeetingType":{"required":["label","meeting_type_id","record_created_at","record_updated_at"],"type":"object","properties":{"meeting_type_id":{"type":"string","description":"Id of the Meeting type","example":"abc123de"},"label":{"type":"string","description":"Short human-friendly description of what the type of Meeting is occuring","example":"Business review"},"record_created_at":{"type":"string","description":"When the Meeting type was created","format":"date-time","example":"2025-09-30T09:00:00Z"},"record_updated_at":{"type":"string","description":"When the Meeting type was last updated","format":"date-time","example":"2025-09-30T09:00:00Z"}},"additionalProperties":false},"Meeting.Model.MeetingLinkInfoV2":{"required":["meeting_id","meeting_link_id","meeting_title"],"type":"object","properties":{"meeting_link_id":{"type":"string","description":"Primary key of the meeting link","example":"v2098mz3"},"meeting_id":{"type":"string","description":"Primary key of the linked meeting","example":"zom2ra31"},"meeting_title":{"type":"string","description":"Title of the linked meeting","example":"Q4 2024 Strategic Review"}},"additionalProperties":false},"Meeting.Model.Public.MeetingOverviewPublic":{"required":["client","contact_attendees_count","id","is_complete","record_created_at","record_updated_at","title","user_attendees_count"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the Meeting","example":"dhka7gwd"},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"Information about the client for which the Meeting is created"},"title":{"type":"string","description":"Title of the Meeting","example":"Onboard New Client"},"type":{"type":"string","description":"Label for the type of Meeting to be conducted","nullable":true,"example":"Business review"},"starts_at":{"type":"string","description":"Scheduled start date and time","format":"date-time","nullable":true,"example":"2025-09-30T00:00:00Z"},"ends_at":{"type":"string","description":"Scheduled end date and time","format":"date-time","nullable":true,"example":"2025-09-30T00:00:00Z"},"agenda_json":{"type":"string","description":"Agenda of the Meeting in ProseMirror JSON format","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"},"is_complete":{"type":"boolean","description":"Indicates if the Meeting is completed","example":true},"user_attendees_count":{"type":"integer","description":"The number of users added to the meeting as attendees.","format":"int32","example":3},"contact_attendees_count":{"type":"integer","description":"The number of contacts added to the meeting as client attendees.","format":"int32","example":5},"record_created_at":{"type":"string","description":"The date and time when the goal was created.","format":"date-time","example":"2025-01-15T10:30:00Z"},"record_updated_at":{"type":"string","description":"The date and time when the goal was last updated.","format":"date-time","example":"2025-03-20T14:45:00Z"}},"additionalProperties":false},"Meeting.Model.Public.MeetingPublic":{"required":["client","contact_attendees","id","is_complete","meeting_type","record_created_at","record_updated_at","title","type","user_attendee_ids"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the Meeting","example":"dhka7gwd"},"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"Information about the client for which the Meeting is created"},"title":{"type":"string","description":"Title of the Meeting","example":"Onboard New Client"},"type":{"type":"string","description":"Type of Meeting to be conducted, replaced by 'meeting_type'\r\n            \r\n- Available values: BusinessReview, AnnualBusinessReview, Discovery, Onboarding, CheckIn, PhoneCall, ProjectMeeting","example":"BusinessReview","deprecated":true},"meeting_type":{"allOf":[{"$ref":"#/components/schemas/Meeting.MeetingType.MeetingType"}],"description":"The type of the meeting."},"starts_at":{"type":"string","description":"Scheduled start date and time","format":"date-time","nullable":true,"example":"2025-09-30T00:00:00Z"},"ends_at":{"type":"string","description":"Scheduled end date and time","format":"date-time","nullable":true,"example":"2025-09-30T00:00:00Z"},"agenda_json":{"type":"string","description":"Agenda of the Meeting in ProseMirror JSON format","nullable":true,"example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"attrs\":{\"textAlign\":null},\"content\":[{\"type\":\"text\",\"text\":\"sample\"}]}]}"},"is_complete":{"type":"boolean","description":"Indicates if the Meeting is completed","example":true},"user_attendee_ids":{"type":"array","items":{"type":"string"},"description":"Users ids added to the Meeting as user attendees","example":["yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"]},"contact_attendees":{"type":"array","items":{"$ref":"#/components/schemas/Contact.Model.Public.ContactPublic"},"description":"Contacts added to the Meeting as client attendees"},"record_created_at":{"type":"string","description":"The date and time when the meeting was created.","format":"date-time","example":"2025-01-15T10:30:00Z"},"record_updated_at":{"type":"string","description":"The date and time when the meeting was last updated.","format":"date-time","example":"2025-03-20T14:45:00Z"}},"additionalProperties":false},"Organization.ClientGroup.Controller.Public.ClientGroupMemberUnassign_Request":{"type":"object","properties":{"client_keys":{"type":"array","items":{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"},"description":"The clients to remove from the client group. Each key may contain an id or name. Optional when removing only users.","nullable":true},"user_keys":{"type":"array","items":{"$ref":"#/components/schemas/Identity.User.Model.Public.UserKeyPublic"},"description":"The users to remove from the client group. Each key may contain an id or email. Optional when removing only clients.","nullable":true}},"additionalProperties":false},"Organization.ClientGroup.Controller.Public.ClientGroupMembersAssign_Request":{"type":"object","properties":{"client_keys":{"type":"array","items":{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"},"description":"The keys used to identify the clients to assign. Provide the client id when available, or the client name when the id is not known. Optional when assigning only users.","nullable":true},"user_keys":{"type":"array","items":{"$ref":"#/components/schemas/Identity.User.Model.Public.UserKeyPublic"},"description":"The users to assign to the client group. Each key may contain an id or email. Optional when assigning only a client.","nullable":true}},"additionalProperties":false},"Organization.ClientGroup.Controller.Public.ClientGroupsGet_Response":{"required":["client_group"],"type":"object","properties":{"client_group":{"allOf":[{"$ref":"#/components/schemas/Organization.ClientGroup.Model.Public.ClientGroupPublic"}],"description":"The client group object containing assigned users and clients."}},"additionalProperties":false},"Organization.ClientGroup.Controller.Public.ClientGroupsList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Organization.ClientGroup.Model.Public.ClientGroupOverviewPublic"},"description":"The client groups available to the authenticated partner account."}},"additionalProperties":false},"Organization.ClientGroup.Model.Public.ClientGroupOverviewPublic":{"required":["client_count","client_group_id","name","user_count"],"type":"object","properties":{"client_group_id":{"type":"string","description":"The unique identifier of the client group.","example":"abc123de"},"name":{"type":"string","description":"The display name of the client group.","example":"North Region"},"client_count":{"type":"integer","description":"The number of clients currently assigned to the group.","format":"int32","example":12},"user_count":{"type":"integer","description":"The number of users currently assigned to the group.","format":"int32","example":4}},"additionalProperties":false},"Organization.ClientGroup.Model.Public.ClientGroupPublic":{"required":["client_group_id","clients","name","user_ids"],"type":"object","properties":{"client_group_id":{"type":"string","description":"The unique identifier of the client group.","example":"abc123de"},"name":{"type":"string","description":"The display name of the client group.","example":"North Region"},"user_ids":{"type":"array","items":{"type":"string"},"description":"The users currently assigned to the client group."},"clients":{"type":"array","items":{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"},"description":"The clients currently assigned to the client group."}},"additionalProperties":false},"Organization.Controller.Public.ClientsClientGroupsList_Request":{"required":["client_key"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The key used to identify the client to assign. Provide the client id when available, or the client name when the id is not known."}},"additionalProperties":false},"Organization.Controller.Public.ClientsClientGroupsList_Response":{"required":["data"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Organization.ClientGroup.Model.Public.ClientGroupOverviewPublic"},"description":"The client groups currently assigned to the client."}},"additionalProperties":false},"Organization.Engagement.EngagementAction.Controller.Public.EngagementActionCreate_Request":{"required":["assigned_user_ids","client_key","description"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the goal for."},"description":{"type":"string","description":"Description of the action item"},"assigned_user_ids":{"type":"array","items":{"$ref":"#/components/schemas/Identity.User.Model.Public.UserKeyPublic"},"description":"Users assigned to this action item"},"due_at":{"type":"string","description":"Date time when the action item is due","format":"date-time","nullable":true}},"additionalProperties":false},"Organization.Engagement.EngagementAction.Controller.Public.EngagementActionCreate_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"Identifier of the created action item."}},"additionalProperties":false},"Organization.Engagement.EngagementAction.Controller.Public.EngagementActionMarkCompleted_Request":{"required":["is_completed"],"type":"object","properties":{"is_completed":{"type":"boolean","description":"To set the status as complete or incomplete"}},"additionalProperties":false},"Organization.Engagement.EngagementAction.Controller.Public.EngagementActionUpdate_Request":{"required":["update_payload"],"type":"object","properties":{"update_payload":{"allOf":[{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Model.Public.EngagementActionUpdatePayloadPublic"}],"description":"Payload to update engagement action"}},"additionalProperties":false},"Organization.Engagement.EngagementAction.Model.Public.EngagementActionPublic":{"required":["assigned_user_ids","client","created_at","description","engagement_action_id","goal_links","is_completed"],"type":"object","properties":{"client":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientBasicInfoPublic"}],"description":"The basic information of the client owns the action items"},"engagement_action_id":{"type":"string","description":"Identifier of the engagement action","example":"dgjsdgt3"},"description":{"type":"string","description":"Description of the engagement action","example":"Action item description"},"due_at":{"type":"string","description":"Due date of the engagement action if any","format":"date-time","nullable":true,"example":"2025-12-04T22:16:31Z"},"is_completed":{"type":"boolean","description":"Indicates whether the engagement action is completed","example":false},"created_at":{"type":"string","description":"Date and time when the engagement action was created","format":"date-time","example":"2025-12-04T22:16:31Z"},"completed_at":{"type":"string","description":"Date and time when the engagement action was completed, if applicable","format":"date-time","nullable":true,"example":"2025-12-04T22:16:31Z"},"assigned_user_ids":{"type":"array","items":{"type":"string"},"description":"Users ids assigned to this action","example":["yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"]},"ticket_link_state":{"allOf":[{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2"}],"oneOf":[{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Created"},{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Pending"},{"$ref":"#/components/schemas/Core.Ticket.TicketLink.Model.TicketLinkStateV2_Error"}],"description":"The state of the ticket link associated with this engagement action, if any","nullable":true,"discriminator":{"propertyName":"type","mapping":{"Created":"#/components/schemas/Wm.Beast.Core.Ticket.Packages.TicketLink.Dto.Model.TicketLinkStateDtoV2.Created","Pending":"#/components/schemas/Wm.Beast.Core.Ticket.Packages.TicketLink.Dto.Model.TicketLinkStateDtoV2.Pending","Error":"#/components/schemas/Wm.Beast.Core.Ticket.Packages.TicketLink.Dto.Model.TicketLinkStateDtoV2.Error"}}},"initiative_links":{"allOf":[{"$ref":"#/components/schemas/Initiative.InitiativeLink.InitiativeLinkInfoV2"}],"description":"The initiative that this action is linked to if any","nullable":true},"meeting_links":{"allOf":[{"$ref":"#/components/schemas/Meeting.Model.MeetingLinkInfoV2"}],"description":"The Meeting that this action is linked to if any","nullable":true},"goal_links":{"type":"array","items":{"$ref":"#/components/schemas/Goal.GoalLink.GoalLinkInfoV2"},"description":"Any goals linked to this engagement action"}},"additionalProperties":false},"Organization.Engagement.EngagementAction.Model.Public.EngagementActionUpdatePayloadPublic":{"required":["assigned_user_keys","description"],"type":"object","properties":{"description":{"type":"string","description":"Description of the action to update","example":"Action Item Description"},"due_at":{"type":"string","description":"Optional due date for the action to update","format":"date-time","nullable":true,"example":"2025-12-04T22:16:31Z"},"assigned_user_keys":{"type":"array","items":{"$ref":"#/components/schemas/Identity.User.Model.Public.UserKeyPublic"},"description":"Users to assign to an action"}},"additionalProperties":false},"Organization.Engagement.EngagementNote.Controller.Public.NotesArchiveStatus_Request":{"required":["is_archived"],"type":"object","properties":{"is_archived":{"type":"boolean","description":"Set to `true` to archive the note, or `false` to unarchive.","example":true}},"additionalProperties":false},"Organization.Engagement.EngagementNote.Controller.Public.NotesCreate_Request":{"required":["client_key","description_json"],"type":"object","properties":{"client_key":{"allOf":[{"$ref":"#/components/schemas/Organization.Model.Public.ClientKeyPublic"}],"description":"The unique key of the client to creat the note for."},"title":{"type":"string","description":"The title of the note (optional).","nullable":true,"example":"Q3 Client Meeting Notes"},"description_json":{"type":"string","description":"The description of the note in ProseMirror JSON format.","example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Meeting notes content here.\"}]}]}"}},"additionalProperties":false},"Organization.Engagement.EngagementNote.Controller.Public.NotesCreate_Response":{"required":["id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the newly created note.","example":"dhka7gwd"}},"additionalProperties":false},"Organization.Engagement.EngagementNote.Controller.Public.NotesUpdate_Request":{"required":["description_json"],"type":"object","properties":{"title":{"type":"string","description":"The title of the note (optional).","nullable":true,"example":"Q3 Client Meeting Notes"},"description_json":{"type":"string","description":"The description of the note in ProseMirror JSON format.","example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Meeting notes content here.\"}]}]}"}},"additionalProperties":false},"Organization.Engagement.EngagementNote.Model.Public.NoteApi":{"required":["created_at","description_json","is_archived","note_id"],"type":"object","properties":{"note_id":{"type":"string","description":"The unique identifier of the note.","example":"dhka7gwd"},"title":{"type":"string","description":"The title of the note (optional).","nullable":true,"example":"Q3 Client Meeting Notes"},"description_json":{"type":"string","description":"The description of the note in ProseMirror JSON format.","example":"{\"type\":\"doc\",\"content\":[{\"type\":\"paragraph\",\"content\":[{\"type\":\"text\",\"text\":\"Meeting notes content here.\"}]}]}"},"is_archived":{"type":"boolean","description":"Indicates whether the note is archived.","example":false},"created_at":{"type":"string","description":"The date and time when the note was created.","format":"date-time","example":"2025-01-15T10:30:00Z"},"updated_at":{"type":"string","description":"The date and time when the note was last updated.","format":"date-time","nullable":true,"example":"2025-03-20T14:45:00Z"},"linked_item":{"allOf":[{"$ref":"#/components/schemas/LinkType.Public.LinkedItemPublic"}],"description":"The service item that is linked to this note, if any","nullable":true}},"additionalProperties":false},"Organization.Model.ClientInfo":{"required":["id","name"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the client","example":"c7f9a8e2-4d3b-4f1e-9c8a-2b5d6e7f8a9b"},"name":{"type":"string","description":"Name of the client organization","example":"Acme Corporation"}},"additionalProperties":false,"description":"Basic client information"},"Organization.Model.Public.ClientBasicInfoPublic":{"required":["id","label"],"type":"object","properties":{"id":{"type":"string","description":"The unique id for the client","example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"label":{"type":"string","description":"The display name for the organization","example":"Acme Corporation"}},"additionalProperties":false},"Organization.Model.Public.ClientKeyPublic":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the client, if not available the unique name will be used","nullable":true,"example":"yqwe36dg-ahbc-48b2-k187-5h0d57c9i9cf"},"name":{"type":"string","description":"Unique name of the client","nullable":true,"example":"Acme Corporation"}},"additionalProperties":false},"ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ConflictApiError_":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScalePadApi.Model.ConflictApiError"},"nullable":true}},"additionalProperties":false},"ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ForbiddenApiError_":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScalePadApi.Model.ForbiddenApiError"},"nullable":true}},"additionalProperties":false},"ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.NotFoundApiError_":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScalePadApi.Model.NotFoundApiError"},"nullable":true}},"additionalProperties":false},"ScalePadApi.Model.ApiErrorContainer_ScalePadApi.Model.ValidationApiError_":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScalePadApi.Model.ValidationApiError"},"nullable":true}},"additionalProperties":false},"ScalePadApi.Model.ConflictApiError":{"type":"object","properties":{"code":{"type":"string","description":"The unique textual code for the error","nullable":true,"example":"CONFLICT"},"title":{"type":"string","description":"A brief human-readable title for the error","nullable":true,"example":"The requested resource already exists"},"detail":{"type":"string","description":"A detailed human-readable description of the error, with suggestions for resolution","nullable":true,"example":"The requested resource already exists. Please use the regenerate method if wishing to replace the existing resource."}},"additionalProperties":false},"ScalePadApi.Model.ForbiddenApiError":{"type":"object","properties":{"code":{"type":"string","description":"The unique textual code for the error","nullable":true,"example":"FORBIDDEN"},"title":{"type":"string","description":"A brief human-readable title for the error","nullable":true,"example":"You do not have permission to perform this action."},"detail":{"type":"string","description":"A detailed human-readable description of the error, with suggestions for resolution","nullable":true,"example":"You do not have permission to perform this action. Permissions missing: FeatureGoal"}},"additionalProperties":false},"ScalePadApi.Model.NotFoundApiError":{"type":"object","properties":{"code":{"type":"string","description":"The unique textual code for the error","nullable":true,"example":"NOT_FOUND"},"title":{"type":"string","description":"A brief human-readable title for the error","nullable":true,"example":"The requested resource could not be found"},"detail":{"type":"string","description":"A detailed human-readable description of the error, with suggestions for resolution","nullable":true,"example":"The requested resource could not be found. Please check the API documentation to ensure the correct URL has been used."}},"additionalProperties":false},"ScalePadApi.Model.Response.PagedResponse_Assessment.AssessmentEvaluation.Model.Public.AssessmentOverviewApi_":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Assessment.AssessmentEvaluation.Model.Public.AssessmentOverviewApi"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":500},"next_cursor":{"type":"string","description":"Indicates if there are more records available beyond the current cursor","nullable":true,"example":"ABC123"}},"additionalProperties":false},"ScalePadApi.Model.Response.PagedResponse_Contract.Model.Public.ContractOverviewApi_":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Contract.Model.Public.ContractOverviewApi"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":500},"next_cursor":{"type":"string","description":"Indicates if there are more records available beyond the current cursor","nullable":true,"example":"ABC123"}},"additionalProperties":false},"ScalePadApi.Model.Response.PagedResponse_Goal.Model.Public.GoalOverviewPublic_":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Goal.Model.Public.GoalOverviewPublic"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":500},"next_cursor":{"type":"string","description":"Indicates if there are more records available beyond the current cursor","nullable":true,"example":"ABC123"}},"additionalProperties":false},"ScalePadApi.Model.Response.PagedResponse_Initiative.Model.Public.InitiativePublic_":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Initiative.Model.Public.InitiativePublic"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":500},"next_cursor":{"type":"string","description":"Indicates if there are more records available beyond the current cursor","nullable":true,"example":"ABC123"}},"additionalProperties":false},"ScalePadApi.Model.Response.PagedResponse_Meeting.Model.Public.MeetingOverviewPublic_":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Meeting.Model.Public.MeetingOverviewPublic"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":500},"next_cursor":{"type":"string","description":"Indicates if there are more records available beyond the current cursor","nullable":true,"example":"ABC123"}},"additionalProperties":false},"ScalePadApi.Model.Response.PagedResponse_Organization.Engagement.EngagementAction.Model.Public.EngagementActionPublic_":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Organization.Engagement.EngagementAction.Model.Public.EngagementActionPublic"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":500},"next_cursor":{"type":"string","description":"Indicates if there are more records available beyond the current cursor","nullable":true,"example":"ABC123"}},"additionalProperties":false},"ScalePadApi.Model.Response.PagedResponse_Organization.Engagement.EngagementNote.Model.Public.NoteApi_":{"required":["data","total_count"],"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Organization.Engagement.EngagementNote.Model.Public.NoteApi"},"description":"The records that match the query"},"total_count":{"type":"integer","description":"The total number of records that match the query","format":"int64","example":500},"next_cursor":{"type":"string","description":"Indicates if there are more records available beyond the current cursor","nullable":true,"example":"ABC123"}},"additionalProperties":false},"ScalePadApi.Model.ValidationApiError":{"type":"object","properties":{"code":{"type":"string","description":"The unique textual code for the error","nullable":true,"example":"VALIDATION_ERROR"},"title":{"type":"string","description":"A brief human-readable title for the error","nullable":true,"example":"The path parameter 'deliverable-id' has an invalid format."},"detail":{"type":"string","description":"A detailed human-readable description of the error, with suggestions for resolution","nullable":true,"example":"The path parameter 'deliverable-id' has an invalid format. Please ensure that the request follows the API specification in the documentation."}},"additionalProperties":false},"ShareAccess.DeliverableShareGeneralLink.Controller.DeliverableShareGeneralLinkCreate_Response":{"required":["expires_at","password","share_url"],"type":"object","properties":{"share_url":{"type":"string","description":"The full URL for the share link","example":"https://app.scalepad.com/shares/lm/9f3K23gyduqwn1291bs1zn"},"expires_at":{"type":"string","description":"When the share link expires","format":"date-time","example":"2026-02-08T00:00:00Z"},"revoked_at":{"type":"string","description":"When the share link was revoked, or null if not revoked","format":"date-time","nullable":true,"example":"2026-02-08T00:00:00Z"},"password":{"type":"string","description":"The password required to access the shared deliverable","example":"*UAYqZae)z1s"}},"additionalProperties":false},"ShareAccess.DeliverableShareGeneralLink.Controller.DeliverableShareGeneralLinkRegenerate_Response":{"required":["expires_at","password","share_url"],"type":"object","properties":{"share_url":{"type":"string","description":"The full URL for the share link","example":"https://app.scalepad.com/shares/lm/9f3K23gyduqwn1291bs1zn"},"expires_at":{"type":"string","description":"When the share link expires","format":"date-time","example":"2026-02-08T00:00:00Z"},"revoked_at":{"type":"string","description":"When the share link was revoked, or null if not revoked","format":"date-time","nullable":true,"example":"2026-02-08T00:00:00Z"},"password":{"type":"string","description":"The password required to access the shared deliverable","example":"*UAYqZae)z1s"}},"additionalProperties":false},"ShareAccess.DeliverableShareGeneralLink.Controller.DeliverableShareGeneralLinkRevoke_Response":{"required":["revoked_at","share_url"],"type":"object","properties":{"share_url":{"type":"string","description":"The full URL for the share link","example":"https://app.scalepad.com/shares/lm/9f3K23gyduqwn1291bs1zn"},"expires_at":{"type":"string","description":"When the share link expires","format":"date-time","nullable":true,"example":"2026-02-08T00:00:00Z"},"revoked_at":{"type":"string","description":"When the share link was revoked","format":"date-time","example":"2026-03-08T00:00:00Z"}},"additionalProperties":false}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"The API key generated from ScalePad application.<br> Example: 'c4d67eca-3b32ed26-b2412e47-2f634617-7e91a0f4-5c8d2b67-e3a19f0b-46d7c582'<br>","name":"x-api-key","in":"header"}}},"security":[{"apiKey":[]}]}