@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 UploadFilter extends BaseResource {
10
10
  * Create a new filter
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(body: SimpleSchemaTypes.UploadFilterCreateSchema) {
15
18
  return this.rawCreate(
@@ -29,6 +32,9 @@ export default class UploadFilter extends BaseResource {
29
32
  * Create a new filter
30
33
  *
31
34
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/create
35
+ *
36
+ * @throws {ApiError}
37
+ * @throws {TimeoutError}
32
38
  */
33
39
  rawCreate(
34
40
  body: SchemaTypes.UploadFilterCreateSchema,
@@ -44,6 +50,9 @@ export default class UploadFilter extends BaseResource {
44
50
  * Update a filter
45
51
  *
46
52
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/update
53
+ *
54
+ * @throws {ApiError}
55
+ * @throws {TimeoutError}
47
56
  */
48
57
  update(
49
58
  uploadFilterId: string | SimpleSchemaTypes.UploadFilterData,
@@ -68,6 +77,9 @@ export default class UploadFilter extends BaseResource {
68
77
  * Update a filter
69
78
  *
70
79
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/update
80
+ *
81
+ * @throws {ApiError}
82
+ * @throws {TimeoutError}
71
83
  */
72
84
  rawUpdate(
73
85
  uploadFilterId: string,
@@ -84,6 +96,9 @@ export default class UploadFilter extends BaseResource {
84
96
  * List all filters
85
97
  *
86
98
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances
99
+ *
100
+ * @throws {ApiError}
101
+ * @throws {TimeoutError}
87
102
  */
88
103
  list() {
89
104
  return this.rawList().then((body) =>
@@ -97,6 +112,9 @@ export default class UploadFilter extends BaseResource {
97
112
  * List all filters
98
113
  *
99
114
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/instances
115
+ *
116
+ * @throws {ApiError}
117
+ * @throws {TimeoutError}
100
118
  */
101
119
  rawList(): Promise<SchemaTypes.UploadFilterInstancesTargetSchema> {
102
120
  return this.client.request<SchemaTypes.UploadFilterInstancesTargetSchema>({
@@ -109,6 +127,9 @@ export default class UploadFilter extends BaseResource {
109
127
  * Retrieve a filter
110
128
  *
111
129
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/self
130
+ *
131
+ * @throws {ApiError}
132
+ * @throws {TimeoutError}
112
133
  */
113
134
  find(uploadFilterId: string | SimpleSchemaTypes.UploadFilterData) {
114
135
  return this.rawFind(Utils.toId(uploadFilterId)).then((body) =>
@@ -122,6 +143,9 @@ export default class UploadFilter extends BaseResource {
122
143
  * Retrieve a filter
123
144
  *
124
145
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/self
146
+ *
147
+ * @throws {ApiError}
148
+ * @throws {TimeoutError}
125
149
  */
126
150
  rawFind(
127
151
  uploadFilterId: string,
@@ -136,6 +160,9 @@ export default class UploadFilter extends BaseResource {
136
160
  * Delete a filter
137
161
  *
138
162
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy
163
+ *
164
+ * @throws {ApiError}
165
+ * @throws {TimeoutError}
139
166
  */
140
167
  destroy(uploadFilterId: string | SimpleSchemaTypes.UploadFilterData) {
141
168
  return this.rawDestroy(Utils.toId(uploadFilterId)).then((body) =>
@@ -149,6 +176,9 @@ export default class UploadFilter extends BaseResource {
149
176
  * Delete a filter
150
177
  *
151
178
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-filter/destroy
179
+ *
180
+ * @throws {ApiError}
181
+ * @throws {TimeoutError}
152
182
  */
153
183
  rawDestroy(
154
184
  uploadFilterId: string,
@@ -10,6 +10,9 @@ export default class UploadRequest extends BaseResource {
10
10
  * Request a new upload
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-request/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(body: SimpleSchemaTypes.UploadRequestCreateSchema) {
15
18
  return this.rawCreate(
@@ -29,6 +32,9 @@ export default class UploadRequest extends BaseResource {
29
32
  * Request a new upload
30
33
  *
31
34
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-request/create
35
+ *
36
+ * @throws {ApiError}
37
+ * @throws {TimeoutError}
32
38
  */
33
39
  rawCreate(
34
40
  body: SchemaTypes.UploadRequestCreateSchema,
@@ -10,6 +10,9 @@ export default class UploadSmartTag extends BaseResource {
10
10
  * List all automatically created upload tags
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  list(queryParams?: SimpleSchemaTypes.UploadSmartTagInstancesHrefSchema) {
15
18
  return this.rawList(queryParams).then((body) =>
@@ -23,6 +26,9 @@ export default class UploadSmartTag extends BaseResource {
23
26
  * List all automatically created upload tags
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawList(
28
34
  queryParams?: SchemaTypes.UploadSmartTagInstancesHrefSchema,
@@ -40,6 +46,9 @@ export default class UploadSmartTag extends BaseResource {
40
46
  * Async iterator to auto-paginate over elements returned by list()
41
47
  *
42
48
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
49
+ *
50
+ * @throws {ApiError}
51
+ * @throws {TimeoutError}
43
52
  */
44
53
  async *listPagedIterator(
45
54
  queryParams?: SimpleSchemaTypes.UploadSmartTagInstancesHrefSchema,
@@ -59,6 +68,9 @@ export default class UploadSmartTag extends BaseResource {
59
68
  * Async iterator to auto-paginate over elements returned by rawList()
60
69
  *
61
70
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-smart_tag/instances
71
+ *
72
+ * @throws {ApiError}
73
+ * @throws {TimeoutError}
62
74
  */
63
75
  rawListPagedIterator(
64
76
  queryParams?: SchemaTypes.UploadSmartTagInstancesHrefSchema,
@@ -10,6 +10,9 @@ export default class UploadTag extends BaseResource {
10
10
  * List all manually created upload tags
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  list(queryParams?: SimpleSchemaTypes.UploadTagInstancesHrefSchema) {
15
18
  return this.rawList(queryParams).then((body) =>
@@ -23,6 +26,9 @@ export default class UploadTag extends BaseResource {
23
26
  * List all manually created upload tags
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/instances
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawList(
28
34
  queryParams?: SchemaTypes.UploadTagInstancesHrefSchema,
@@ -38,6 +44,9 @@ export default class UploadTag 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/upload-tag/instances
47
+ *
48
+ * @throws {ApiError}
49
+ * @throws {TimeoutError}
41
50
  */
42
51
  async *listPagedIterator(
43
52
  queryParams?: SimpleSchemaTypes.UploadTagInstancesHrefSchema,
@@ -57,6 +66,9 @@ export default class UploadTag 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/upload-tag/instances
69
+ *
70
+ * @throws {ApiError}
71
+ * @throws {TimeoutError}
60
72
  */
61
73
  rawListPagedIterator(
62
74
  queryParams?: SchemaTypes.UploadTagInstancesHrefSchema,
@@ -79,6 +91,9 @@ export default class UploadTag extends BaseResource {
79
91
  * Create a new upload tag
80
92
  *
81
93
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/create
94
+ *
95
+ * @throws {ApiError}
96
+ * @throws {TimeoutError}
82
97
  */
83
98
  create(body: SimpleSchemaTypes.UploadTagCreateSchema) {
84
99
  return this.rawCreate(
@@ -98,6 +113,9 @@ export default class UploadTag extends BaseResource {
98
113
  * Create a new upload tag
99
114
  *
100
115
  * Read more: https://www.datocms.com/docs/content-management-api/resources/upload-tag/create
116
+ *
117
+ * @throws {ApiError}
118
+ * @throws {TimeoutError}
101
119
  */
102
120
  rawCreate(
103
121
  body: SchemaTypes.UploadTagCreateSchema,
@@ -10,6 +10,9 @@ export default class UsageCounter extends BaseResource {
10
10
  * Retrieve a project's usage counter
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/usage-counter/self
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  find(
15
18
  usageCounterId: string | SimpleSchemaTypes.UsageCounterData,
@@ -26,6 +29,9 @@ export default class UsageCounter extends BaseResource {
26
29
  * Retrieve a project's usage counter
27
30
  *
28
31
  * Read more: https://www.datocms.com/docs/content-management-api/resources/usage-counter/self
32
+ *
33
+ * @throws {ApiError}
34
+ * @throws {TimeoutError}
29
35
  */
30
36
  rawFind(
31
37
  usageCounterId: string,
@@ -10,6 +10,9 @@ export default class User extends BaseResource {
10
10
  * Update a collaborator
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/update
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  update(
15
18
  userId: string | SimpleSchemaTypes.UserData,
@@ -34,6 +37,9 @@ export default class User extends BaseResource {
34
37
  * Update a collaborator
35
38
  *
36
39
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/update
40
+ *
41
+ * @throws {ApiError}
42
+ * @throws {TimeoutError}
37
43
  */
38
44
  rawUpdate(
39
45
  userId: string,
@@ -50,6 +56,9 @@ export default class User extends BaseResource {
50
56
  * List all collaborators
51
57
  *
52
58
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
59
+ *
60
+ * @throws {ApiError}
61
+ * @throws {TimeoutError}
53
62
  */
54
63
  list() {
55
64
  return this.rawList().then((body) =>
@@ -63,6 +72,9 @@ export default class User extends BaseResource {
63
72
  * List all collaborators
64
73
  *
65
74
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/instances
75
+ *
76
+ * @throws {ApiError}
77
+ * @throws {TimeoutError}
66
78
  */
67
79
  rawList(): Promise<SchemaTypes.UserInstancesTargetSchema> {
68
80
  return this.client.request<SchemaTypes.UserInstancesTargetSchema>({
@@ -75,6 +87,9 @@ export default class User extends BaseResource {
75
87
  * Retrieve a collaborator
76
88
  *
77
89
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
90
+ *
91
+ * @throws {ApiError}
92
+ * @throws {TimeoutError}
78
93
  */
79
94
  find(
80
95
  userId: string | SimpleSchemaTypes.UserData,
@@ -91,6 +106,9 @@ export default class User extends BaseResource {
91
106
  * Retrieve a collaborator
92
107
  *
93
108
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/self
109
+ *
110
+ * @throws {ApiError}
111
+ * @throws {TimeoutError}
94
112
  */
95
113
  rawFind(
96
114
  userId: string,
@@ -107,6 +125,9 @@ export default class User extends BaseResource {
107
125
  * Retrieve current signed-in user
108
126
  *
109
127
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/me
128
+ *
129
+ * @throws {ApiError}
130
+ * @throws {TimeoutError}
110
131
  */
111
132
  findMe(queryParams?: SimpleSchemaTypes.UserMeHrefSchema) {
112
133
  return this.rawFindMe(queryParams).then((body) =>
@@ -118,6 +139,9 @@ export default class User extends BaseResource {
118
139
  * Retrieve current signed-in user
119
140
  *
120
141
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/me
142
+ *
143
+ * @throws {ApiError}
144
+ * @throws {TimeoutError}
121
145
  */
122
146
  rawFindMe(
123
147
  queryParams?: SchemaTypes.UserMeHrefSchema,
@@ -133,6 +157,9 @@ export default class User extends BaseResource {
133
157
  * Delete a collaborator
134
158
  *
135
159
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/destroy
160
+ *
161
+ * @throws {ApiError}
162
+ * @throws {TimeoutError}
136
163
  */
137
164
  destroy(
138
165
  userId: string | SimpleSchemaTypes.UserData,
@@ -149,6 +176,9 @@ export default class User extends BaseResource {
149
176
  * Delete a collaborator
150
177
  *
151
178
  * Read more: https://www.datocms.com/docs/content-management-api/resources/user/destroy
179
+ *
180
+ * @throws {ApiError}
181
+ * @throws {TimeoutError}
152
182
  */
153
183
  rawDestroy(
154
184
  userId: string,
@@ -10,6 +10,9 @@ export default class Webhook extends BaseResource {
10
10
  * Create a new webhook
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(body: SimpleSchemaTypes.WebhookCreateSchema) {
15
18
  return this.rawCreate(
@@ -40,6 +43,9 @@ export default class Webhook extends BaseResource {
40
43
  * Create a new webhook
41
44
  *
42
45
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/create
46
+ *
47
+ * @throws {ApiError}
48
+ * @throws {TimeoutError}
43
49
  */
44
50
  rawCreate(
45
51
  body: SchemaTypes.WebhookCreateSchema,
@@ -55,6 +61,9 @@ export default class Webhook extends BaseResource {
55
61
  * Update a webhook
56
62
  *
57
63
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/update
64
+ *
65
+ * @throws {ApiError}
66
+ * @throws {TimeoutError}
58
67
  */
59
68
  update(
60
69
  userId: string | SimpleSchemaTypes.UserData,
@@ -89,6 +98,9 @@ export default class Webhook extends BaseResource {
89
98
  * Update a webhook
90
99
  *
91
100
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/update
101
+ *
102
+ * @throws {ApiError}
103
+ * @throws {TimeoutError}
92
104
  */
93
105
  rawUpdate(
94
106
  userId: string,
@@ -105,6 +117,9 @@ export default class Webhook extends BaseResource {
105
117
  * List all webhooks
106
118
  *
107
119
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
120
+ *
121
+ * @throws {ApiError}
122
+ * @throws {TimeoutError}
108
123
  */
109
124
  list() {
110
125
  return this.rawList().then((body) =>
@@ -118,6 +133,9 @@ export default class Webhook extends BaseResource {
118
133
  * List all webhooks
119
134
  *
120
135
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/instances
136
+ *
137
+ * @throws {ApiError}
138
+ * @throws {TimeoutError}
121
139
  */
122
140
  rawList(): Promise<SchemaTypes.WebhookInstancesTargetSchema> {
123
141
  return this.client.request<SchemaTypes.WebhookInstancesTargetSchema>({
@@ -130,6 +148,9 @@ export default class Webhook extends BaseResource {
130
148
  * Retrieve a webhook
131
149
  *
132
150
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
151
+ *
152
+ * @throws {ApiError}
153
+ * @throws {TimeoutError}
133
154
  */
134
155
  find(userId: string | SimpleSchemaTypes.UserData) {
135
156
  return this.rawFind(Utils.toId(userId)).then((body) =>
@@ -143,6 +164,9 @@ export default class Webhook extends BaseResource {
143
164
  * Retrieve a webhook
144
165
  *
145
166
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/self
167
+ *
168
+ * @throws {ApiError}
169
+ * @throws {TimeoutError}
146
170
  */
147
171
  rawFind(userId: string): Promise<SchemaTypes.WebhookSelfTargetSchema> {
148
172
  return this.client.request<SchemaTypes.WebhookSelfTargetSchema>({
@@ -155,6 +179,9 @@ export default class Webhook extends BaseResource {
155
179
  * Delete a webhook
156
180
  *
157
181
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
182
+ *
183
+ * @throws {ApiError}
184
+ * @throws {TimeoutError}
158
185
  */
159
186
  destroy(userId: string | SimpleSchemaTypes.UserData) {
160
187
  return this.rawDestroy(Utils.toId(userId)).then((body) =>
@@ -168,6 +195,9 @@ export default class Webhook extends BaseResource {
168
195
  * Delete a webhook
169
196
  *
170
197
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook/destroy
198
+ *
199
+ * @throws {ApiError}
200
+ * @throws {TimeoutError}
171
201
  */
172
202
  rawDestroy(userId: string): Promise<SchemaTypes.WebhookDestroyTargetSchema> {
173
203
  return this.client.request<SchemaTypes.WebhookDestroyTargetSchema>({
@@ -10,6 +10,9 @@ export default class WebhookCall extends BaseResource {
10
10
  * List all webhooks calls
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  list(queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema) {
15
18
  return this.rawList(queryParams).then((body) =>
@@ -23,6 +26,9 @@ export default class WebhookCall extends BaseResource {
23
26
  * List all webhooks calls
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/instances
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawList(
28
34
  queryParams?: SchemaTypes.WebhookCallInstancesHrefSchema,
@@ -38,6 +44,9 @@ export default class WebhookCall 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/webhook-call/instances
47
+ *
48
+ * @throws {ApiError}
49
+ * @throws {TimeoutError}
41
50
  */
42
51
  async *listPagedIterator(
43
52
  queryParams?: SimpleSchemaTypes.WebhookCallInstancesHrefSchema,
@@ -57,6 +66,9 @@ export default class WebhookCall 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/webhook-call/instances
69
+ *
70
+ * @throws {ApiError}
71
+ * @throws {TimeoutError}
60
72
  */
61
73
  rawListPagedIterator(
62
74
  queryParams?: SchemaTypes.WebhookCallInstancesHrefSchema,
@@ -79,6 +91,9 @@ export default class WebhookCall extends BaseResource {
79
91
  * Re-send the webhook call
80
92
  *
81
93
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook
94
+ *
95
+ * @throws {ApiError}
96
+ * @throws {TimeoutError}
82
97
  */
83
98
  resendWebhook(userId: string | SimpleSchemaTypes.UserData) {
84
99
  return this.rawResendWebhook(Utils.toId(userId));
@@ -88,6 +103,9 @@ export default class WebhookCall extends BaseResource {
88
103
  * Re-send the webhook call
89
104
  *
90
105
  * Read more: https://www.datocms.com/docs/content-management-api/resources/webhook-call/resend_webhook
106
+ *
107
+ * @throws {ApiError}
108
+ * @throws {TimeoutError}
91
109
  */
92
110
  rawResendWebhook(userId: string): Promise<void> {
93
111
  return this.client.request<void>({
@@ -10,6 +10,9 @@ export default class WhiteLabelSettings extends BaseResource {
10
10
  * Retrieve white-label settings
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/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 WhiteLabelSettings extends BaseResource {
23
26
  * Retrieve white-label settings
24
27
  *
25
28
  * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/self
29
+ *
30
+ * @throws {ApiError}
31
+ * @throws {TimeoutError}
26
32
  */
27
33
  rawFind(): Promise<SchemaTypes.WhiteLabelSettingsSelfTargetSchema> {
28
34
  return this.client.request<SchemaTypes.WhiteLabelSettingsSelfTargetSchema>({
@@ -35,6 +41,9 @@ export default class WhiteLabelSettings extends BaseResource {
35
41
  * Update white-label settings
36
42
  *
37
43
  * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update
44
+ *
45
+ * @throws {ApiError}
46
+ * @throws {TimeoutError}
38
47
  */
39
48
  update(body: SimpleSchemaTypes.WhiteLabelSettingsUpdateSchema) {
40
49
  return this.rawUpdate(
@@ -57,6 +66,9 @@ export default class WhiteLabelSettings extends BaseResource {
57
66
  * Update white-label settings
58
67
  *
59
68
  * Read more: https://www.datocms.com/docs/content-management-api/resources/white-label_settings/update
69
+ *
70
+ * @throws {ApiError}
71
+ * @throws {TimeoutError}
60
72
  */
61
73
  rawUpdate(
62
74
  body: SchemaTypes.WhiteLabelSettingsUpdateSchema,
@@ -10,6 +10,9 @@ export default class Workflow extends BaseResource {
10
10
  * Create a new workflow
11
11
  *
12
12
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
13
+ *
14
+ * @throws {ApiError}
15
+ * @throws {TimeoutError}
13
16
  */
14
17
  create(body: SimpleSchemaTypes.WorkflowCreateSchema) {
15
18
  return this.rawCreate(
@@ -29,6 +32,9 @@ export default class Workflow extends BaseResource {
29
32
  * Create a new workflow
30
33
  *
31
34
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/create
35
+ *
36
+ * @throws {ApiError}
37
+ * @throws {TimeoutError}
32
38
  */
33
39
  rawCreate(
34
40
  body: SchemaTypes.WorkflowCreateSchema,
@@ -44,6 +50,9 @@ export default class Workflow extends BaseResource {
44
50
  * Update a workflow
45
51
  *
46
52
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/update
53
+ *
54
+ * @throws {ApiError}
55
+ * @throws {TimeoutError}
47
56
  */
48
57
  update(
49
58
  workflowId: string | SimpleSchemaTypes.WorkflowData,
@@ -68,6 +77,9 @@ export default class Workflow extends BaseResource {
68
77
  * Update a workflow
69
78
  *
70
79
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/update
80
+ *
81
+ * @throws {ApiError}
82
+ * @throws {TimeoutError}
71
83
  */
72
84
  rawUpdate(
73
85
  workflowId: string,
@@ -84,6 +96,9 @@ export default class Workflow extends BaseResource {
84
96
  * List all workflows
85
97
  *
86
98
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
99
+ *
100
+ * @throws {ApiError}
101
+ * @throws {TimeoutError}
87
102
  */
88
103
  list() {
89
104
  return this.rawList().then((body) =>
@@ -97,6 +112,9 @@ export default class Workflow extends BaseResource {
97
112
  * List all workflows
98
113
  *
99
114
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/instances
115
+ *
116
+ * @throws {ApiError}
117
+ * @throws {TimeoutError}
100
118
  */
101
119
  rawList(): Promise<SchemaTypes.WorkflowInstancesTargetSchema> {
102
120
  return this.client.request<SchemaTypes.WorkflowInstancesTargetSchema>({
@@ -109,6 +127,9 @@ export default class Workflow extends BaseResource {
109
127
  * Retrieve a workflow
110
128
  *
111
129
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
130
+ *
131
+ * @throws {ApiError}
132
+ * @throws {TimeoutError}
112
133
  */
113
134
  find(workflowId: string | SimpleSchemaTypes.WorkflowData) {
114
135
  return this.rawFind(Utils.toId(workflowId)).then((body) =>
@@ -122,6 +143,9 @@ export default class Workflow extends BaseResource {
122
143
  * Retrieve a workflow
123
144
  *
124
145
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/self
146
+ *
147
+ * @throws {ApiError}
148
+ * @throws {TimeoutError}
125
149
  */
126
150
  rawFind(workflowId: string): Promise<SchemaTypes.WorkflowSelfTargetSchema> {
127
151
  return this.client.request<SchemaTypes.WorkflowSelfTargetSchema>({
@@ -134,6 +158,9 @@ export default class Workflow extends BaseResource {
134
158
  * Delete a workflow
135
159
  *
136
160
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
161
+ *
162
+ * @throws {ApiError}
163
+ * @throws {TimeoutError}
137
164
  */
138
165
  destroy(workflowId: string | SimpleSchemaTypes.WorkflowData) {
139
166
  return this.rawDestroy(Utils.toId(workflowId));
@@ -143,6 +170,9 @@ export default class Workflow extends BaseResource {
143
170
  * Delete a workflow
144
171
  *
145
172
  * Read more: https://www.datocms.com/docs/content-management-api/resources/workflow/destroy
173
+ *
174
+ * @throws {ApiError}
175
+ * @throws {TimeoutError}
146
176
  */
147
177
  rawDestroy(workflowId: string): Promise<void> {
148
178
  return this.client.request<void>({
package/src/index.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { ApiError, LogLevel } from '@datocms/rest-client-utils';
1
+ export { ApiError, TimeoutError, LogLevel } from '@datocms/rest-client-utils';
2
2
  export { Client } from './generated/Client';
3
3
  export * as Resources from './generated/resources';
4
4
  export type { ClientConfigOptions } from './generated/Client';