@datocms/cma-client 1.1.1 → 1.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (308) hide show
  1. package/dist/cjs/generated/Client.js.map +1 -1
  2. package/dist/cjs/generated/resources/AccessToken.js +36 -0
  3. package/dist/cjs/generated/resources/AccessToken.js.map +1 -1
  4. package/dist/cjs/generated/resources/AuditLogEvent.js +6 -0
  5. package/dist/cjs/generated/resources/AuditLogEvent.js.map +1 -1
  6. package/dist/cjs/generated/resources/BuildEvent.js +12 -0
  7. package/dist/cjs/generated/resources/BuildEvent.js.map +1 -1
  8. package/dist/cjs/generated/resources/BuildTrigger.js +54 -0
  9. package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
  10. package/dist/cjs/generated/resources/DailyUsage.js +6 -0
  11. package/dist/cjs/generated/resources/DailyUsage.js.map +1 -1
  12. package/dist/cjs/generated/resources/EditingSession.js +15 -0
  13. package/dist/cjs/generated/resources/EditingSession.js.map +1 -1
  14. package/dist/cjs/generated/resources/Environment.js +30 -0
  15. package/dist/cjs/generated/resources/Environment.js.map +1 -1
  16. package/dist/cjs/generated/resources/Field.js +48 -0
  17. package/dist/cjs/generated/resources/Field.js.map +1 -1
  18. package/dist/cjs/generated/resources/Fieldset.js +30 -0
  19. package/dist/cjs/generated/resources/Fieldset.js.map +1 -1
  20. package/dist/cjs/generated/resources/Item.js +114 -0
  21. package/dist/cjs/generated/resources/Item.js.map +1 -1
  22. package/dist/cjs/generated/resources/ItemType.js +36 -0
  23. package/dist/cjs/generated/resources/ItemType.js.map +1 -1
  24. package/dist/cjs/generated/resources/ItemTypeFilter.js +33 -3
  25. package/dist/cjs/generated/resources/ItemTypeFilter.js.map +1 -1
  26. package/dist/cjs/generated/resources/ItemVersion.js +24 -0
  27. package/dist/cjs/generated/resources/ItemVersion.js.map +1 -1
  28. package/dist/cjs/generated/resources/JobResult.js +6 -0
  29. package/dist/cjs/generated/resources/JobResult.js.map +1 -1
  30. package/dist/cjs/generated/resources/MaintenanceMode.js +18 -0
  31. package/dist/cjs/generated/resources/MaintenanceMode.js.map +1 -1
  32. package/dist/cjs/generated/resources/MenuItem.js +32 -2
  33. package/dist/cjs/generated/resources/MenuItem.js.map +1 -1
  34. package/dist/cjs/generated/resources/Plugin.js +36 -0
  35. package/dist/cjs/generated/resources/Plugin.js.map +1 -1
  36. package/dist/cjs/generated/resources/PublicInfo.js +6 -0
  37. package/dist/cjs/generated/resources/PublicInfo.js.map +1 -1
  38. package/dist/cjs/generated/resources/Role.js +30 -0
  39. package/dist/cjs/generated/resources/Role.js.map +1 -1
  40. package/dist/cjs/generated/resources/ScheduledPublication.js +12 -0
  41. package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
  42. package/dist/cjs/generated/resources/ScheduledUnpublishing.js +12 -0
  43. package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
  44. package/dist/cjs/generated/resources/SearchResult.js +12 -0
  45. package/dist/cjs/generated/resources/SearchResult.js.map +1 -1
  46. package/dist/cjs/generated/resources/Session.js +6 -0
  47. package/dist/cjs/generated/resources/Session.js.map +1 -1
  48. package/dist/cjs/generated/resources/Site.js +18 -0
  49. package/dist/cjs/generated/resources/Site.js.map +1 -1
  50. package/dist/cjs/generated/resources/SiteInvitation.js +36 -0
  51. package/dist/cjs/generated/resources/SiteInvitation.js.map +1 -1
  52. package/dist/cjs/generated/resources/SsoGroup.js +24 -0
  53. package/dist/cjs/generated/resources/SsoGroup.js.map +1 -1
  54. package/dist/cjs/generated/resources/SsoSettings.js +18 -0
  55. package/dist/cjs/generated/resources/SsoSettings.js.map +1 -1
  56. package/dist/cjs/generated/resources/SsoUser.js +24 -0
  57. package/dist/cjs/generated/resources/SsoUser.js.map +1 -1
  58. package/dist/cjs/generated/resources/SubscriptionFeature.js +6 -0
  59. package/dist/cjs/generated/resources/SubscriptionFeature.js.map +1 -1
  60. package/dist/cjs/generated/resources/SubscriptionLimit.js +12 -0
  61. package/dist/cjs/generated/resources/SubscriptionLimit.js.map +1 -1
  62. package/dist/cjs/generated/resources/Upload.js +66 -0
  63. package/dist/cjs/generated/resources/Upload.js.map +1 -1
  64. package/dist/cjs/generated/resources/UploadFilter.js +30 -0
  65. package/dist/cjs/generated/resources/UploadFilter.js.map +1 -1
  66. package/dist/cjs/generated/resources/UploadRequest.js +6 -0
  67. package/dist/cjs/generated/resources/UploadRequest.js.map +1 -1
  68. package/dist/cjs/generated/resources/UploadSmartTag.js +12 -0
  69. package/dist/cjs/generated/resources/UploadSmartTag.js.map +1 -1
  70. package/dist/cjs/generated/resources/UploadTag.js +18 -0
  71. package/dist/cjs/generated/resources/UploadTag.js.map +1 -1
  72. package/dist/cjs/generated/resources/UsageCounter.js +6 -0
  73. package/dist/cjs/generated/resources/UsageCounter.js.map +1 -1
  74. package/dist/cjs/generated/resources/User.js +30 -0
  75. package/dist/cjs/generated/resources/User.js.map +1 -1
  76. package/dist/cjs/generated/resources/Webhook.js +30 -0
  77. package/dist/cjs/generated/resources/Webhook.js.map +1 -1
  78. package/dist/cjs/generated/resources/WebhookCall.js +18 -0
  79. package/dist/cjs/generated/resources/WebhookCall.js.map +1 -1
  80. package/dist/cjs/generated/resources/WhiteLabelSettings.js +12 -0
  81. package/dist/cjs/generated/resources/WhiteLabelSettings.js.map +1 -1
  82. package/dist/cjs/generated/resources/Workflow.js +30 -0
  83. package/dist/cjs/generated/resources/Workflow.js.map +1 -1
  84. package/dist/cjs/index.js +2 -1
  85. package/dist/cjs/index.js.map +1 -1
  86. package/dist/esm/buildBlockRecord.d.ts +2 -0
  87. package/dist/esm/generated/Client.d.ts +9 -0
  88. package/dist/esm/generated/Client.js.map +1 -1
  89. package/dist/esm/generated/SchemaTypes.d.ts +185 -44
  90. package/dist/esm/generated/SimpleSchemaTypes.d.ts +190 -41
  91. package/dist/esm/generated/resources/AccessToken.d.ts +36 -0
  92. package/dist/esm/generated/resources/AccessToken.js +36 -0
  93. package/dist/esm/generated/resources/AccessToken.js.map +1 -1
  94. package/dist/esm/generated/resources/AuditLogEvent.d.ts +6 -0
  95. package/dist/esm/generated/resources/AuditLogEvent.js +6 -0
  96. package/dist/esm/generated/resources/AuditLogEvent.js.map +1 -1
  97. package/dist/esm/generated/resources/BuildEvent.d.ts +12 -0
  98. package/dist/esm/generated/resources/BuildEvent.js +12 -0
  99. package/dist/esm/generated/resources/BuildEvent.js.map +1 -1
  100. package/dist/esm/generated/resources/BuildTrigger.d.ts +54 -0
  101. package/dist/esm/generated/resources/BuildTrigger.js +54 -0
  102. package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
  103. package/dist/esm/generated/resources/DailyUsage.d.ts +6 -0
  104. package/dist/esm/generated/resources/DailyUsage.js +6 -0
  105. package/dist/esm/generated/resources/DailyUsage.js.map +1 -1
  106. package/dist/esm/generated/resources/EditingSession.d.ts +15 -0
  107. package/dist/esm/generated/resources/EditingSession.js +15 -0
  108. package/dist/esm/generated/resources/EditingSession.js.map +1 -1
  109. package/dist/esm/generated/resources/Environment.d.ts +30 -0
  110. package/dist/esm/generated/resources/Environment.js +30 -0
  111. package/dist/esm/generated/resources/Environment.js.map +1 -1
  112. package/dist/esm/generated/resources/Field.d.ts +48 -0
  113. package/dist/esm/generated/resources/Field.js +48 -0
  114. package/dist/esm/generated/resources/Field.js.map +1 -1
  115. package/dist/esm/generated/resources/Fieldset.d.ts +30 -0
  116. package/dist/esm/generated/resources/Fieldset.js +30 -0
  117. package/dist/esm/generated/resources/Fieldset.js.map +1 -1
  118. package/dist/esm/generated/resources/Item.d.ts +114 -0
  119. package/dist/esm/generated/resources/Item.js +114 -0
  120. package/dist/esm/generated/resources/Item.js.map +1 -1
  121. package/dist/esm/generated/resources/ItemType.d.ts +36 -0
  122. package/dist/esm/generated/resources/ItemType.js +36 -0
  123. package/dist/esm/generated/resources/ItemType.js.map +1 -1
  124. package/dist/esm/generated/resources/ItemTypeFilter.d.ts +30 -0
  125. package/dist/esm/generated/resources/ItemTypeFilter.js +33 -3
  126. package/dist/esm/generated/resources/ItemTypeFilter.js.map +1 -1
  127. package/dist/esm/generated/resources/ItemVersion.d.ts +24 -0
  128. package/dist/esm/generated/resources/ItemVersion.js +24 -0
  129. package/dist/esm/generated/resources/ItemVersion.js.map +1 -1
  130. package/dist/esm/generated/resources/JobResult.d.ts +6 -0
  131. package/dist/esm/generated/resources/JobResult.js +6 -0
  132. package/dist/esm/generated/resources/JobResult.js.map +1 -1
  133. package/dist/esm/generated/resources/MaintenanceMode.d.ts +18 -0
  134. package/dist/esm/generated/resources/MaintenanceMode.js +18 -0
  135. package/dist/esm/generated/resources/MaintenanceMode.js.map +1 -1
  136. package/dist/esm/generated/resources/MenuItem.d.ts +30 -0
  137. package/dist/esm/generated/resources/MenuItem.js +32 -2
  138. package/dist/esm/generated/resources/MenuItem.js.map +1 -1
  139. package/dist/esm/generated/resources/Plugin.d.ts +36 -0
  140. package/dist/esm/generated/resources/Plugin.js +36 -0
  141. package/dist/esm/generated/resources/Plugin.js.map +1 -1
  142. package/dist/esm/generated/resources/PublicInfo.d.ts +6 -0
  143. package/dist/esm/generated/resources/PublicInfo.js +6 -0
  144. package/dist/esm/generated/resources/PublicInfo.js.map +1 -1
  145. package/dist/esm/generated/resources/Role.d.ts +30 -0
  146. package/dist/esm/generated/resources/Role.js +30 -0
  147. package/dist/esm/generated/resources/Role.js.map +1 -1
  148. package/dist/esm/generated/resources/ScheduledPublication.d.ts +12 -0
  149. package/dist/esm/generated/resources/ScheduledPublication.js +12 -0
  150. package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
  151. package/dist/esm/generated/resources/ScheduledUnpublishing.d.ts +12 -0
  152. package/dist/esm/generated/resources/ScheduledUnpublishing.js +12 -0
  153. package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
  154. package/dist/esm/generated/resources/SearchResult.d.ts +12 -0
  155. package/dist/esm/generated/resources/SearchResult.js +12 -0
  156. package/dist/esm/generated/resources/SearchResult.js.map +1 -1
  157. package/dist/esm/generated/resources/Session.d.ts +6 -0
  158. package/dist/esm/generated/resources/Session.js +6 -0
  159. package/dist/esm/generated/resources/Session.js.map +1 -1
  160. package/dist/esm/generated/resources/Site.d.ts +18 -0
  161. package/dist/esm/generated/resources/Site.js +18 -0
  162. package/dist/esm/generated/resources/Site.js.map +1 -1
  163. package/dist/esm/generated/resources/SiteInvitation.d.ts +36 -0
  164. package/dist/esm/generated/resources/SiteInvitation.js +36 -0
  165. package/dist/esm/generated/resources/SiteInvitation.js.map +1 -1
  166. package/dist/esm/generated/resources/SsoGroup.d.ts +24 -0
  167. package/dist/esm/generated/resources/SsoGroup.js +24 -0
  168. package/dist/esm/generated/resources/SsoGroup.js.map +1 -1
  169. package/dist/esm/generated/resources/SsoSettings.d.ts +18 -0
  170. package/dist/esm/generated/resources/SsoSettings.js +18 -0
  171. package/dist/esm/generated/resources/SsoSettings.js.map +1 -1
  172. package/dist/esm/generated/resources/SsoUser.d.ts +24 -0
  173. package/dist/esm/generated/resources/SsoUser.js +24 -0
  174. package/dist/esm/generated/resources/SsoUser.js.map +1 -1
  175. package/dist/esm/generated/resources/SubscriptionFeature.d.ts +6 -0
  176. package/dist/esm/generated/resources/SubscriptionFeature.js +6 -0
  177. package/dist/esm/generated/resources/SubscriptionFeature.js.map +1 -1
  178. package/dist/esm/generated/resources/SubscriptionLimit.d.ts +12 -0
  179. package/dist/esm/generated/resources/SubscriptionLimit.js +12 -0
  180. package/dist/esm/generated/resources/SubscriptionLimit.js.map +1 -1
  181. package/dist/esm/generated/resources/Upload.d.ts +66 -0
  182. package/dist/esm/generated/resources/Upload.js +66 -0
  183. package/dist/esm/generated/resources/Upload.js.map +1 -1
  184. package/dist/esm/generated/resources/UploadFilter.d.ts +30 -0
  185. package/dist/esm/generated/resources/UploadFilter.js +30 -0
  186. package/dist/esm/generated/resources/UploadFilter.js.map +1 -1
  187. package/dist/esm/generated/resources/UploadRequest.d.ts +6 -0
  188. package/dist/esm/generated/resources/UploadRequest.js +6 -0
  189. package/dist/esm/generated/resources/UploadRequest.js.map +1 -1
  190. package/dist/esm/generated/resources/UploadSmartTag.d.ts +12 -0
  191. package/dist/esm/generated/resources/UploadSmartTag.js +12 -0
  192. package/dist/esm/generated/resources/UploadSmartTag.js.map +1 -1
  193. package/dist/esm/generated/resources/UploadTag.d.ts +18 -0
  194. package/dist/esm/generated/resources/UploadTag.js +18 -0
  195. package/dist/esm/generated/resources/UploadTag.js.map +1 -1
  196. package/dist/esm/generated/resources/UsageCounter.d.ts +6 -0
  197. package/dist/esm/generated/resources/UsageCounter.js +6 -0
  198. package/dist/esm/generated/resources/UsageCounter.js.map +1 -1
  199. package/dist/esm/generated/resources/User.d.ts +30 -0
  200. package/dist/esm/generated/resources/User.js +30 -0
  201. package/dist/esm/generated/resources/User.js.map +1 -1
  202. package/dist/esm/generated/resources/Webhook.d.ts +30 -0
  203. package/dist/esm/generated/resources/Webhook.js +30 -0
  204. package/dist/esm/generated/resources/Webhook.js.map +1 -1
  205. package/dist/esm/generated/resources/WebhookCall.d.ts +18 -0
  206. package/dist/esm/generated/resources/WebhookCall.js +18 -0
  207. package/dist/esm/generated/resources/WebhookCall.js.map +1 -1
  208. package/dist/esm/generated/resources/WhiteLabelSettings.d.ts +12 -0
  209. package/dist/esm/generated/resources/WhiteLabelSettings.js +12 -0
  210. package/dist/esm/generated/resources/WhiteLabelSettings.js.map +1 -1
  211. package/dist/esm/generated/resources/Workflow.d.ts +30 -0
  212. package/dist/esm/generated/resources/Workflow.js +30 -0
  213. package/dist/esm/generated/resources/Workflow.js.map +1 -1
  214. package/dist/esm/index.d.ts +1 -1
  215. package/dist/esm/index.js +1 -1
  216. package/dist/esm/index.js.map +1 -1
  217. package/dist/types/buildBlockRecord.d.ts +2 -0
  218. package/dist/types/generated/Client.d.ts +9 -0
  219. package/dist/types/generated/SchemaTypes.d.ts +185 -44
  220. package/dist/types/generated/SimpleSchemaTypes.d.ts +190 -41
  221. package/dist/types/generated/resources/AccessToken.d.ts +36 -0
  222. package/dist/types/generated/resources/AuditLogEvent.d.ts +6 -0
  223. package/dist/types/generated/resources/BuildEvent.d.ts +12 -0
  224. package/dist/types/generated/resources/BuildTrigger.d.ts +54 -0
  225. package/dist/types/generated/resources/DailyUsage.d.ts +6 -0
  226. package/dist/types/generated/resources/EditingSession.d.ts +15 -0
  227. package/dist/types/generated/resources/Environment.d.ts +30 -0
  228. package/dist/types/generated/resources/Field.d.ts +48 -0
  229. package/dist/types/generated/resources/Fieldset.d.ts +30 -0
  230. package/dist/types/generated/resources/Item.d.ts +114 -0
  231. package/dist/types/generated/resources/ItemType.d.ts +36 -0
  232. package/dist/types/generated/resources/ItemTypeFilter.d.ts +30 -0
  233. package/dist/types/generated/resources/ItemVersion.d.ts +24 -0
  234. package/dist/types/generated/resources/JobResult.d.ts +6 -0
  235. package/dist/types/generated/resources/MaintenanceMode.d.ts +18 -0
  236. package/dist/types/generated/resources/MenuItem.d.ts +30 -0
  237. package/dist/types/generated/resources/Plugin.d.ts +36 -0
  238. package/dist/types/generated/resources/PublicInfo.d.ts +6 -0
  239. package/dist/types/generated/resources/Role.d.ts +30 -0
  240. package/dist/types/generated/resources/ScheduledPublication.d.ts +12 -0
  241. package/dist/types/generated/resources/ScheduledUnpublishing.d.ts +12 -0
  242. package/dist/types/generated/resources/SearchResult.d.ts +12 -0
  243. package/dist/types/generated/resources/Session.d.ts +6 -0
  244. package/dist/types/generated/resources/Site.d.ts +18 -0
  245. package/dist/types/generated/resources/SiteInvitation.d.ts +36 -0
  246. package/dist/types/generated/resources/SsoGroup.d.ts +24 -0
  247. package/dist/types/generated/resources/SsoSettings.d.ts +18 -0
  248. package/dist/types/generated/resources/SsoUser.d.ts +24 -0
  249. package/dist/types/generated/resources/SubscriptionFeature.d.ts +6 -0
  250. package/dist/types/generated/resources/SubscriptionLimit.d.ts +12 -0
  251. package/dist/types/generated/resources/Upload.d.ts +66 -0
  252. package/dist/types/generated/resources/UploadFilter.d.ts +30 -0
  253. package/dist/types/generated/resources/UploadRequest.d.ts +6 -0
  254. package/dist/types/generated/resources/UploadSmartTag.d.ts +12 -0
  255. package/dist/types/generated/resources/UploadTag.d.ts +18 -0
  256. package/dist/types/generated/resources/UsageCounter.d.ts +6 -0
  257. package/dist/types/generated/resources/User.d.ts +30 -0
  258. package/dist/types/generated/resources/Webhook.d.ts +30 -0
  259. package/dist/types/generated/resources/WebhookCall.d.ts +18 -0
  260. package/dist/types/generated/resources/WhiteLabelSettings.d.ts +12 -0
  261. package/dist/types/generated/resources/Workflow.d.ts +30 -0
  262. package/dist/types/index.d.ts +1 -1
  263. package/package.json +4 -4
  264. package/src/generated/Client.ts +9 -0
  265. package/src/generated/SchemaTypes.ts +192 -45
  266. package/src/generated/SimpleSchemaTypes.ts +199 -42
  267. package/src/generated/resources/AccessToken.ts +36 -0
  268. package/src/generated/resources/AuditLogEvent.ts +6 -0
  269. package/src/generated/resources/BuildEvent.ts +12 -0
  270. package/src/generated/resources/BuildTrigger.ts +54 -0
  271. package/src/generated/resources/DailyUsage.ts +6 -0
  272. package/src/generated/resources/EditingSession.ts +15 -0
  273. package/src/generated/resources/Environment.ts +30 -0
  274. package/src/generated/resources/Field.ts +48 -0
  275. package/src/generated/resources/Fieldset.ts +30 -0
  276. package/src/generated/resources/Item.ts +114 -0
  277. package/src/generated/resources/ItemType.ts +36 -0
  278. package/src/generated/resources/ItemTypeFilter.ts +33 -3
  279. package/src/generated/resources/ItemVersion.ts +24 -0
  280. package/src/generated/resources/JobResult.ts +6 -0
  281. package/src/generated/resources/MaintenanceMode.ts +18 -0
  282. package/src/generated/resources/MenuItem.ts +32 -2
  283. package/src/generated/resources/Plugin.ts +36 -0
  284. package/src/generated/resources/PublicInfo.ts +6 -0
  285. package/src/generated/resources/Role.ts +30 -0
  286. package/src/generated/resources/ScheduledPublication.ts +12 -0
  287. package/src/generated/resources/ScheduledUnpublishing.ts +12 -0
  288. package/src/generated/resources/SearchResult.ts +12 -0
  289. package/src/generated/resources/Session.ts +6 -0
  290. package/src/generated/resources/Site.ts +18 -0
  291. package/src/generated/resources/SiteInvitation.ts +36 -0
  292. package/src/generated/resources/SsoGroup.ts +24 -0
  293. package/src/generated/resources/SsoSettings.ts +18 -0
  294. package/src/generated/resources/SsoUser.ts +24 -0
  295. package/src/generated/resources/SubscriptionFeature.ts +6 -0
  296. package/src/generated/resources/SubscriptionLimit.ts +12 -0
  297. package/src/generated/resources/Upload.ts +66 -0
  298. package/src/generated/resources/UploadFilter.ts +30 -0
  299. package/src/generated/resources/UploadRequest.ts +6 -0
  300. package/src/generated/resources/UploadSmartTag.ts +12 -0
  301. package/src/generated/resources/UploadTag.ts +18 -0
  302. package/src/generated/resources/UsageCounter.ts +6 -0
  303. package/src/generated/resources/User.ts +30 -0
  304. package/src/generated/resources/Webhook.ts +30 -0
  305. package/src/generated/resources/WebhookCall.ts +18 -0
  306. package/src/generated/resources/WhiteLabelSettings.ts +12 -0
  307. package/src/generated/resources/Workflow.ts +30 -0
  308. package/src/index.ts +1 -1
@@ -10,6 +10,9 @@ export default class MaintenanceMode extends BaseResource {
10
10
  * Retrieve maintenence mode
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  find() {
15
18
  return this.rawFind().then((body) =>
@@ -23,6 +26,9 @@ export default class MaintenanceMode extends BaseResource {
23
26
  * Retrieve maintenence mode
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawFind(): Promise<SchemaTypes.MaintenanceModeSelfTargetSchema> {
28
34
  return this.client.request<SchemaTypes.MaintenanceModeSelfTargetSchema>({
@@ -35,6 +41,9 @@ export default class MaintenanceMode extends BaseResource {
35
41
  * Activate maintenance mode: this means that the primary environment will be read-only
36
42
  *
37
43
  * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
44
+ *
45
+ * @throws {ApiError}
46
+ * @throws {TimeoutError}
38
47
  */
39
48
  activate(queryParams?: SimpleSchemaTypes.MaintenanceModeActivateHrefSchema) {
40
49
  return this.rawActivate(queryParams).then((body) =>
@@ -48,6 +57,9 @@ export default class MaintenanceMode extends BaseResource {
48
57
  * Activate maintenance mode: this means that the primary environment will be read-only
49
58
  *
50
59
  * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
60
+ *
61
+ * @throws {ApiError}
62
+ * @throws {TimeoutError}
51
63
  */
52
64
  rawActivate(
53
65
  queryParams?: SchemaTypes.MaintenanceModeActivateHrefSchema,
@@ -65,6 +77,9 @@ export default class MaintenanceMode extends BaseResource {
65
77
  * De-activate maintenance mode
66
78
  *
67
79
  * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
80
+ *
81
+ * @throws {ApiError}
82
+ * @throws {TimeoutError}
68
83
  */
69
84
  deactivate() {
70
85
  return this.rawDeactivate().then((body) =>
@@ -78,6 +93,9 @@ export default class MaintenanceMode extends BaseResource {
78
93
  * De-activate maintenance mode
79
94
  *
80
95
  * Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
96
+ *
97
+ * @throws {ApiError}
98
+ * @throws {TimeoutError}
81
99
  */
82
100
  rawDeactivate(): Promise<SchemaTypes.MaintenanceModeDeactivateTargetSchema> {
83
101
  return this.client.request<SchemaTypes.MaintenanceModeDeactivateTargetSchema>(
@@ -10,13 +10,16 @@ export default class MenuItem extends BaseResource {
10
10
  * Create a new menu item
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(body: SimpleSchemaTypes.MenuItemCreateSchema) {
15
18
  return this.rawCreate(
16
19
  Utils.serializeRequestBody<SchemaTypes.MenuItemCreateSchema>(body, {
17
20
  type: 'menu_item',
18
21
  attributes: ['label', 'external_url', 'position', 'open_in_new_tab'],
19
- relationships: ['item_type', 'parent'],
22
+ relationships: ['item_type', 'item_type_filter', 'parent'],
20
23
  }),
21
24
  ).then((body) =>
22
25
  Utils.deserializeResponseBody<SimpleSchemaTypes.MenuItemCreateTargetSchema>(
@@ -29,6 +32,9 @@ export default class MenuItem extends BaseResource {
29
32
  * Create a new menu item
30
33
  *
31
34
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/create
35
+ *
36
+ * @throws {ApiError}
37
+ * @throws {TimeoutError}
32
38
  */
33
39
  rawCreate(
34
40
  body: SchemaTypes.MenuItemCreateSchema,
@@ -44,6 +50,9 @@ export default class MenuItem extends BaseResource {
44
50
  * Update a menu item
45
51
  *
46
52
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/update
53
+ *
54
+ * @throws {ApiError}
55
+ * @throws {TimeoutError}
47
56
  */
48
57
  update(
49
58
  menuItemId: string | SimpleSchemaTypes.MenuItemData,
@@ -55,7 +64,7 @@ export default class MenuItem extends BaseResource {
55
64
  id: Utils.toId(menuItemId),
56
65
  type: 'menu_item',
57
66
  attributes: ['label', 'external_url', 'position', 'open_in_new_tab'],
58
- relationships: ['item_type', 'parent'],
67
+ relationships: ['item_type', 'item_type_filter', 'parent'],
59
68
  }),
60
69
  ).then((body) =>
61
70
  Utils.deserializeResponseBody<SimpleSchemaTypes.MenuItemUpdateTargetSchema>(
@@ -68,6 +77,9 @@ export default class MenuItem extends BaseResource {
68
77
  * Update a menu item
69
78
  *
70
79
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/update
80
+ *
81
+ * @throws {ApiError}
82
+ * @throws {TimeoutError}
71
83
  */
72
84
  rawUpdate(
73
85
  menuItemId: string,
@@ -84,6 +96,9 @@ export default class MenuItem extends BaseResource {
84
96
  * List all menu items
85
97
  *
86
98
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/instances
99
+ *
100
+ * @throws {ApiError}
101
+ * @throws {TimeoutError}
87
102
  */
88
103
  list(queryParams?: SimpleSchemaTypes.MenuItemInstancesHrefSchema) {
89
104
  return this.rawList(queryParams).then((body) =>
@@ -97,6 +112,9 @@ export default class MenuItem extends BaseResource {
97
112
  * List all menu items
98
113
  *
99
114
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/instances
115
+ *
116
+ * @throws {ApiError}
117
+ * @throws {TimeoutError}
100
118
  */
101
119
  rawList(
102
120
  queryParams?: SchemaTypes.MenuItemInstancesHrefSchema,
@@ -112,6 +130,9 @@ export default class MenuItem extends BaseResource {
112
130
  * Retrieve a menu item
113
131
  *
114
132
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/self
133
+ *
134
+ * @throws {ApiError}
135
+ * @throws {TimeoutError}
115
136
  */
116
137
  find(menuItemId: string | SimpleSchemaTypes.MenuItemData) {
117
138
  return this.rawFind(Utils.toId(menuItemId)).then((body) =>
@@ -125,6 +146,9 @@ export default class MenuItem extends BaseResource {
125
146
  * Retrieve a menu item
126
147
  *
127
148
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/self
149
+ *
150
+ * @throws {ApiError}
151
+ * @throws {TimeoutError}
128
152
  */
129
153
  rawFind(menuItemId: string): Promise<SchemaTypes.MenuItemSelfTargetSchema> {
130
154
  return this.client.request<SchemaTypes.MenuItemSelfTargetSchema>({
@@ -137,6 +161,9 @@ export default class MenuItem extends BaseResource {
137
161
  * Delete a menu item
138
162
  *
139
163
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy
164
+ *
165
+ * @throws {ApiError}
166
+ * @throws {TimeoutError}
140
167
  */
141
168
  destroy(menuItemId: string | SimpleSchemaTypes.MenuItemData) {
142
169
  return this.rawDestroy(Utils.toId(menuItemId)).then((body) =>
@@ -150,6 +177,9 @@ export default class MenuItem extends BaseResource {
150
177
  * Delete a menu item
151
178
  *
152
179
  * Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy
180
+ *
181
+ * @throws {ApiError}
182
+ * @throws {TimeoutError}
153
183
  */
154
184
  rawDestroy(
155
185
  menuItemId: string,
@@ -10,6 +10,9 @@ export default class Plugin extends BaseResource {
10
10
  * Create a new plugin
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(body: SimpleSchemaTypes.PluginCreateSchema) {
15
18
  return this.rawCreate(
@@ -39,6 +42,9 @@ export default class Plugin extends BaseResource {
39
42
  * Create a new plugin
40
43
  *
41
44
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/create
45
+ *
46
+ * @throws {ApiError}
47
+ * @throws {TimeoutError}
42
48
  */
43
49
  rawCreate(
44
50
  body: SchemaTypes.PluginCreateSchema,
@@ -54,6 +60,9 @@ export default class Plugin extends BaseResource {
54
60
  * Update a plugin
55
61
  *
56
62
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/update
63
+ *
64
+ * @throws {ApiError}
65
+ * @throws {TimeoutError}
57
66
  */
58
67
  update(
59
68
  pluginId: string | SimpleSchemaTypes.PluginData,
@@ -85,6 +94,9 @@ export default class Plugin extends BaseResource {
85
94
  * Update a plugin
86
95
  *
87
96
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/update
97
+ *
98
+ * @throws {ApiError}
99
+ * @throws {TimeoutError}
88
100
  */
89
101
  rawUpdate(
90
102
  pluginId: string,
@@ -101,6 +113,9 @@ export default class Plugin extends BaseResource {
101
113
  * List all plugins
102
114
  *
103
115
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/instances
116
+ *
117
+ * @throws {ApiError}
118
+ * @throws {TimeoutError}
104
119
  */
105
120
  list() {
106
121
  return this.rawList().then((body) =>
@@ -114,6 +129,9 @@ export default class Plugin extends BaseResource {
114
129
  * List all plugins
115
130
  *
116
131
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/instances
132
+ *
133
+ * @throws {ApiError}
134
+ * @throws {TimeoutError}
117
135
  */
118
136
  rawList(): Promise<SchemaTypes.PluginInstancesTargetSchema> {
119
137
  return this.client.request<SchemaTypes.PluginInstancesTargetSchema>({
@@ -126,6 +144,9 @@ export default class Plugin extends BaseResource {
126
144
  * Retrieve a plugins
127
145
  *
128
146
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
147
+ *
148
+ * @throws {ApiError}
149
+ * @throws {TimeoutError}
129
150
  */
130
151
  find(pluginId: string | SimpleSchemaTypes.PluginData) {
131
152
  return this.rawFind(Utils.toId(pluginId)).then((body) =>
@@ -139,6 +160,9 @@ export default class Plugin extends BaseResource {
139
160
  * Retrieve a plugins
140
161
  *
141
162
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
163
+ *
164
+ * @throws {ApiError}
165
+ * @throws {TimeoutError}
142
166
  */
143
167
  rawFind(pluginId: string): Promise<SchemaTypes.PluginSelfTargetSchema> {
144
168
  return this.client.request<SchemaTypes.PluginSelfTargetSchema>({
@@ -151,6 +175,9 @@ export default class Plugin extends BaseResource {
151
175
  * Delete a plugin
152
176
  *
153
177
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/destroy
178
+ *
179
+ * @throws {ApiError}
180
+ * @throws {TimeoutError}
154
181
  */
155
182
  destroy(pluginId: string | SimpleSchemaTypes.PluginData) {
156
183
  return this.rawDestroy(Utils.toId(pluginId)).then((body) =>
@@ -164,6 +191,9 @@ export default class Plugin extends BaseResource {
164
191
  * Delete a plugin
165
192
  *
166
193
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/destroy
194
+ *
195
+ * @throws {ApiError}
196
+ * @throws {TimeoutError}
167
197
  */
168
198
  rawDestroy(pluginId: string): Promise<SchemaTypes.PluginDestroyTargetSchema> {
169
199
  return this.client.request<SchemaTypes.PluginDestroyTargetSchema>({
@@ -176,6 +206,9 @@ export default class Plugin extends BaseResource {
176
206
  * Retrieve all fields using the plugin
177
207
  *
178
208
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/fields
209
+ *
210
+ * @throws {ApiError}
211
+ * @throws {TimeoutError}
179
212
  */
180
213
  fields(pluginId: string | SimpleSchemaTypes.PluginData) {
181
214
  return this.rawFields(Utils.toId(pluginId)).then((body) =>
@@ -189,6 +222,9 @@ export default class Plugin extends BaseResource {
189
222
  * Retrieve all fields using the plugin
190
223
  *
191
224
  * Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/fields
225
+ *
226
+ * @throws {ApiError}
227
+ * @throws {TimeoutError}
192
228
  */
193
229
  rawFields(pluginId: string): Promise<SchemaTypes.PluginFieldsTargetSchema> {
194
230
  return this.client.request<SchemaTypes.PluginFieldsTargetSchema>({
@@ -10,6 +10,9 @@ export default class PublicInfo extends BaseResource {
10
10
  * Retrieve public site info
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/public-info/self
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  find() {
15
18
  return this.rawFind().then((body) =>
@@ -23,6 +26,9 @@ export default class PublicInfo extends BaseResource {
23
26
  * Retrieve public site info
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/public-info/self
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawFind(): Promise<SchemaTypes.PublicInfoSelfTargetSchema> {
28
34
  return this.client.request<SchemaTypes.PublicInfoSelfTargetSchema>({
@@ -10,6 +10,9 @@ export default class Role extends BaseResource {
10
10
  * Create a new role
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(body: SimpleSchemaTypes.RoleCreateSchema) {
15
18
  return this.rawCreate(
@@ -55,6 +58,9 @@ export default class Role extends BaseResource {
55
58
  * Create a new role
56
59
  *
57
60
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
61
+ *
62
+ * @throws {ApiError}
63
+ * @throws {TimeoutError}
58
64
  */
59
65
  rawCreate(
60
66
  body: SchemaTypes.RoleCreateSchema,
@@ -70,6 +76,9 @@ export default class Role extends BaseResource {
70
76
  * Update a role
71
77
  *
72
78
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
79
+ *
80
+ * @throws {ApiError}
81
+ * @throws {TimeoutError}
73
82
  */
74
83
  update(
75
84
  roleId: string | SimpleSchemaTypes.RoleData,
@@ -120,6 +129,9 @@ export default class Role extends BaseResource {
120
129
  * Update a role
121
130
  *
122
131
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
132
+ *
133
+ * @throws {ApiError}
134
+ * @throws {TimeoutError}
123
135
  */
124
136
  rawUpdate(
125
137
  roleId: string,
@@ -136,6 +148,9 @@ export default class Role extends BaseResource {
136
148
  * List all roles
137
149
  *
138
150
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
151
+ *
152
+ * @throws {ApiError}
153
+ * @throws {TimeoutError}
139
154
  */
140
155
  list() {
141
156
  return this.rawList().then((body) =>
@@ -149,6 +164,9 @@ export default class Role extends BaseResource {
149
164
  * List all roles
150
165
  *
151
166
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
167
+ *
168
+ * @throws {ApiError}
169
+ * @throws {TimeoutError}
152
170
  */
153
171
  rawList(): Promise<SchemaTypes.RoleInstancesTargetSchema> {
154
172
  return this.client.request<SchemaTypes.RoleInstancesTargetSchema>({
@@ -161,6 +179,9 @@ export default class Role extends BaseResource {
161
179
  * Retrieve a role
162
180
  *
163
181
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
182
+ *
183
+ * @throws {ApiError}
184
+ * @throws {TimeoutError}
164
185
  */
165
186
  find(roleId: string | SimpleSchemaTypes.RoleData) {
166
187
  return this.rawFind(Utils.toId(roleId)).then((body) =>
@@ -174,6 +195,9 @@ export default class Role extends BaseResource {
174
195
  * Retrieve a role
175
196
  *
176
197
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
198
+ *
199
+ * @throws {ApiError}
200
+ * @throws {TimeoutError}
177
201
  */
178
202
  rawFind(roleId: string): Promise<SchemaTypes.RoleSelfTargetSchema> {
179
203
  return this.client.request<SchemaTypes.RoleSelfTargetSchema>({
@@ -186,6 +210,9 @@ export default class Role extends BaseResource {
186
210
  * Delete a role
187
211
  *
188
212
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
213
+ *
214
+ * @throws {ApiError}
215
+ * @throws {TimeoutError}
189
216
  */
190
217
  destroy(roleId: string | SimpleSchemaTypes.RoleData) {
191
218
  return this.rawDestroy(Utils.toId(roleId)).then((body) =>
@@ -199,6 +226,9 @@ export default class Role extends BaseResource {
199
226
  * Delete a role
200
227
  *
201
228
  * Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
229
+ *
230
+ * @throws {ApiError}
231
+ * @throws {TimeoutError}
202
232
  */
203
233
  rawDestroy(roleId: string): Promise<SchemaTypes.RoleDestroyTargetSchema> {
204
234
  return this.client.request<SchemaTypes.RoleDestroyTargetSchema>({
@@ -10,6 +10,9 @@ export default class ScheduledPublication extends BaseResource {
10
10
  * Create a new scheduled publication
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(
15
18
  itemId: string | SimpleSchemaTypes.ItemData,
@@ -36,6 +39,9 @@ export default class ScheduledPublication extends BaseResource {
36
39
  * Create a new scheduled publication
37
40
  *
38
41
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create
42
+ *
43
+ * @throws {ApiError}
44
+ * @throws {TimeoutError}
39
45
  */
40
46
  rawCreate(
41
47
  itemId: string,
@@ -54,6 +60,9 @@ export default class ScheduledPublication extends BaseResource {
54
60
  * Delete a scheduled publication
55
61
  *
56
62
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy
63
+ *
64
+ * @throws {ApiError}
65
+ * @throws {TimeoutError}
57
66
  */
58
67
  destroy(itemId: string | SimpleSchemaTypes.ItemData) {
59
68
  return this.rawDestroy(Utils.toId(itemId)).then((body) =>
@@ -67,6 +76,9 @@ export default class ScheduledPublication extends BaseResource {
67
76
  * Delete a scheduled publication
68
77
  *
69
78
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy
79
+ *
80
+ * @throws {ApiError}
81
+ * @throws {TimeoutError}
70
82
  */
71
83
  rawDestroy(
72
84
  itemId: string,
@@ -10,6 +10,9 @@ export default class ScheduledUnpublishing extends BaseResource {
10
10
  * Create a new scheduled unpublishing
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(
15
18
  itemId: string | SimpleSchemaTypes.ItemData,
@@ -36,6 +39,9 @@ export default class ScheduledUnpublishing extends BaseResource {
36
39
  * Create a new scheduled unpublishing
37
40
  *
38
41
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create
42
+ *
43
+ * @throws {ApiError}
44
+ * @throws {TimeoutError}
39
45
  */
40
46
  rawCreate(
41
47
  itemId: string,
@@ -54,6 +60,9 @@ export default class ScheduledUnpublishing extends BaseResource {
54
60
  * Delete a scheduled unpublishing
55
61
  *
56
62
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy
63
+ *
64
+ * @throws {ApiError}
65
+ * @throws {TimeoutError}
57
66
  */
58
67
  destroy(itemId: string | SimpleSchemaTypes.ItemData) {
59
68
  return this.rawDestroy(Utils.toId(itemId)).then((body) =>
@@ -67,6 +76,9 @@ export default class ScheduledUnpublishing extends BaseResource {
67
76
  * Delete a scheduled unpublishing
68
77
  *
69
78
  * Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy
79
+ *
80
+ * @throws {ApiError}
81
+ * @throws {TimeoutError}
70
82
  */
71
83
  rawDestroy(
72
84
  itemId: string,
@@ -10,6 +10,9 @@ export default class SearchResult extends BaseResource {
10
10
  * Search for results
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  list(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema) {
15
18
  return this.rawList(queryParams).then((body) =>
@@ -23,6 +26,9 @@ export default class SearchResult extends BaseResource {
23
26
  * Search for results
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawList(
28
34
  queryParams: SchemaTypes.SearchResultInstancesHrefSchema,
@@ -38,6 +44,9 @@ export default class SearchResult extends BaseResource {
38
44
  * Async iterator to auto-paginate over elements returned by list()
39
45
  *
40
46
  * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
47
+ *
48
+ * @throws {ApiError}
49
+ * @throws {TimeoutError}
41
50
  */
42
51
  async *listPagedIterator(
43
52
  queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema,
@@ -57,6 +66,9 @@ export default class SearchResult extends BaseResource {
57
66
  * Async iterator to auto-paginate over elements returned by rawList()
58
67
  *
59
68
  * Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
69
+ *
70
+ * @throws {ApiError}
71
+ * @throws {TimeoutError}
60
72
  */
61
73
  rawListPagedIterator(
62
74
  queryParams: SchemaTypes.SearchResultInstancesHrefSchema,
@@ -11,6 +11,9 @@ export default class Session extends BaseResource {
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
13
13
  *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
16
+ *
14
17
  * @deprecated This API call is to be considered private and might change without notice
15
18
  */
16
19
  create(body: SimpleSchemaTypes.SessionCreateSchema) {
@@ -32,6 +35,9 @@ export default class Session extends BaseResource {
32
35
  *
33
36
  * Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
34
37
  *
38
+ * @throws {ApiError}
39
+ * @throws {TimeoutError}
40
+ *
35
41
  * @deprecated This API call is to be considered private and might change without notice
36
42
  */
37
43
  rawCreate(
@@ -10,6 +10,9 @@ export default class Site extends BaseResource {
10
10
  * Retrieve the site
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  find(queryParams?: SimpleSchemaTypes.SiteSelfHrefSchema) {
15
18
  return this.rawFind(queryParams).then((body) =>
@@ -23,6 +26,9 @@ export default class Site extends BaseResource {
23
26
  * Retrieve the site
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawFind(
28
34
  queryParams?: SchemaTypes.SiteSelfHrefSchema,
@@ -38,6 +44,9 @@ export default class Site extends BaseResource {
38
44
  * Update the site's settings
39
45
  *
40
46
  * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
47
+ *
48
+ * @throws {ApiError}
49
+ * @throws {TimeoutError}
41
50
  */
42
51
  update(body: SimpleSchemaTypes.SiteUpdateSchema) {
43
52
  return this.rawUpdate(
@@ -67,6 +76,9 @@ export default class Site extends BaseResource {
67
76
  * Update the site's settings
68
77
  *
69
78
  * Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
79
+ *
80
+ * @throws {ApiError}
81
+ * @throws {TimeoutError}
70
82
  */
71
83
  rawUpdate(
72
84
  body: SchemaTypes.SiteUpdateSchema,
@@ -82,6 +94,9 @@ export default class Site extends BaseResource {
82
94
  * Activate improved timezone management
83
95
  *
84
96
  * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
97
+ *
98
+ * @throws {ApiError}
99
+ * @throws {TimeoutError}
85
100
  */
86
101
  activateImprovedTimezoneManagement() {
87
102
  return this.rawActivateImprovedTimezoneManagement().then((body) =>
@@ -95,6 +110,9 @@ export default class Site extends BaseResource {
95
110
  * Activate improved timezone management
96
111
  *
97
112
  * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
113
+ *
114
+ * @throws {ApiError}
115
+ * @throws {TimeoutError}
98
116
  */
99
117
  rawActivateImprovedTimezoneManagement(): Promise<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema> {
100
118
  return this.client.request<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema>(