@@ -57,6 +57,14 @@ For examples of how to use the SDK to create videos using code checkout the Node
5757 - [ QueuedResponseData] ( #queuedresponsedata )
5858 - [ RenderResponse] ( #renderresponse )
5959 - [ RenderResponseData] ( #renderresponsedata )
60+ - [ Template Response Schemas] ( #template-response-schemas )
61+ - [ TemplateResponse] ( #templateresponse )
62+ - [ TemplateResponseData] ( #templateresponsedata )
63+ - [ TemplateDataResponse] ( #templatedataresponse )
64+ - [ TemplateDataResponseData] ( #templatedataresponsedata )
65+ - [ TemplateListResponse] ( #templatelistresponse )
66+ - [ TemplateListResponseData] ( #templatelistresponsedata )
67+ - [ TemplateListResponseItem] ( #templatelistresponseitem )
6068 - [ Inspecting Media] ( #inspecting-media )
6169 - [ Probe Example] ( #probe-example )
6270 - [ Probe Schemas] ( #probe-schemas )
@@ -1083,6 +1091,98 @@ getData(): [Shotstack.Edit](#edit) | The timeline and output data to be rendered
10831091getCreated(): string | The time the render task was initially queued. | Y
10841092getUpdated(): string | The time the render status was last updated. | Y
10851093
1094+ ---
1095+
1096+ ## Template Response Schemas
1097+
1098+ The following schemas are returned by the templates endpoint, including create, update and rendering a template.
1099+
1100+ ### TemplateResponse
1101+
1102+ The response received after a [template](#create-template) is submitted. The template is saved and a unique
1103+ template id is returned.
1104+
1105+ #### Methods:
1106+
1107+ Method | Description | Required
1108+ :--- | :--- | :---:
1109+ getSuccess(): bool | ` true ` if successfully queued, else ` false ` . | Y
1110+ getMessage(): string | ` Created` , ` Bad Request` or an error message. | Y
1111+ getResponse(): [Shotstack.TemplateResponseData](#templateresponsedata) | ` TemplateResponseData` or an error message. | Y
1112+
1113+ ### TemplateResponseData
1114+
1115+ The response data returned with the [Shotstack.TemplateResponse](#templateresponse).
1116+
1117+ #### Methods:
1118+
1119+ Method | Description | Required
1120+ :--- | :--- | :---:
1121+ getMessage(): string | Success response message or error details. | Y
1122+ getId(): string | The unique id of the template in UUID format. | Y
1123+
1124+ ### TemplateDataResponse
1125+
1126+ The template data including the template name and [Edit](#edit).
1127+
1128+ #### Methods:
1129+
1130+ Method | Description | Required
1131+ :--- | :--- | :---:
1132+ getSuccess(): bool | ` true ` if successfully queued, else ` false ` . | Y
1133+ getMessage(): string | ` Created` , ` Bad Request` or an error message. | Y
1134+ getResponse(): [Shotstack.TemplateDataResponseData](#templatedataresponsedata) | ` TemplateDataResponseData` or an error message. | Y
1135+
1136+ ### TemplateDataResponseData
1137+
1138+ The response data returned with the [TemplateDataResponse](#templatedataresponse).
1139+
1140+ #### Methods:
1141+
1142+ Method | Description | Required
1143+ :--- | :--- | :---:
1144+ getId(): string | The unique id of the template in UUID format. | Y
1145+ getName(): string | The template name. | Y
1146+ getOwner(): string | The owner id of the templates. | Y
1147+ getTemplate(): [Shotstack.Edit](#edit) | ` Edit` or an error message. | Y
1148+
1149+ ### TemplateListResponse
1150+
1151+ A list of previously saved templates.
1152+
1153+ #### Methods:
1154+
1155+ Method | Description | Required
1156+ :--- | :--- | :---:
1157+ getSuccess(): bool | ` true ` if successfully queued, else ` false ` . | Y
1158+ getMessage(): string | ` Created` , ` Bad Request` or an error message. | Y
1159+ getResponse(): [Shotstack.TemplateListResponseData](#templatelistresponsedata) | ` TemplateListResponseData` or an error message. | Y
1160+
1161+ ### TemplateListResponseData
1162+
1163+ The response data returned with the [TemplateListResponse](#templatelistresponse).
1164+
1165+ #### Methods:
1166+
1167+ Method | Description | Required
1168+ :--- | :--- | :---:
1169+ getOwner(): bool | The owner id of the templates. | Y
1170+ getTemplates(): [[Shotstack.TemplateListResponseItem]](#templatelistresponseitem) | The list of templates. | Y
1171+
1172+ ### TemplateListResponseItem
1173+
1174+ The individual template item returned with the [TemplateListResponseData](#templatelistresponsedata) templates
1175+ list.
1176+
1177+ #### Methods:
1178+
1179+ Method | Description | Required
1180+ :--- | :--- | :---:
1181+ getId(): string | The unique id of the template in UUID format. | Y
1182+ getName(): string | The template name | Y
1183+ getCreated(): string | The time the template was created. | -
1184+ getUpdated(): string | The time the template was last updated. | -
1185+
10861186---
10871187## Inspecting Media
10881188
0 commit comments