contentful-management 12.0.0-new-beta.2 → 12.0.0-new-beta.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 (879) hide show
  1. package/package.json +1 -1
  2. package/dist/browser/index.js +0 -23417
  3. package/dist/browser/index.js.map +0 -1
  4. package/dist/browser/index.min.js +0 -2
  5. package/dist/browser/index.min.js.map +0 -1
  6. package/dist/cjs/index.cjs +0 -14186
  7. package/dist/cjs/index.cjs.map +0 -1
  8. package/dist/esm/adapters/REST/endpoints/access-token.mjs +0 -131
  9. package/dist/esm/adapters/REST/endpoints/access-token.mjs.map +0 -1
  10. package/dist/esm/adapters/REST/endpoints/ai-action-invocation.mjs +0 -8
  11. package/dist/esm/adapters/REST/endpoints/ai-action-invocation.mjs.map +0 -1
  12. package/dist/esm/adapters/REST/endpoints/ai-action.mjs +0 -49
  13. package/dist/esm/adapters/REST/endpoints/ai-action.mjs.map +0 -1
  14. package/dist/esm/adapters/REST/endpoints/api-key.mjs +0 -44
  15. package/dist/esm/adapters/REST/endpoints/api-key.mjs.map +0 -1
  16. package/dist/esm/adapters/REST/endpoints/app-access-token.mjs +0 -8
  17. package/dist/esm/adapters/REST/endpoints/app-access-token.mjs.map +0 -1
  18. package/dist/esm/adapters/REST/endpoints/app-action-call.mjs +0 -112
  19. package/dist/esm/adapters/REST/endpoints/app-action-call.mjs.map +0 -1
  20. package/dist/esm/adapters/REST/endpoints/app-action.mjs +0 -36
  21. package/dist/esm/adapters/REST/endpoints/app-action.mjs.map +0 -1
  22. package/dist/esm/adapters/REST/endpoints/app-bundle.mjs +0 -35
  23. package/dist/esm/adapters/REST/endpoints/app-bundle.mjs.map +0 -1
  24. package/dist/esm/adapters/REST/endpoints/app-definition.mjs +0 -45
  25. package/dist/esm/adapters/REST/endpoints/app-definition.mjs.map +0 -1
  26. package/dist/esm/adapters/REST/endpoints/app-details.mjs +0 -14
  27. package/dist/esm/adapters/REST/endpoints/app-details.mjs.map +0 -1
  28. package/dist/esm/adapters/REST/endpoints/app-event-subscription.mjs +0 -14
  29. package/dist/esm/adapters/REST/endpoints/app-event-subscription.mjs.map +0 -1
  30. package/dist/esm/adapters/REST/endpoints/app-installation.mjs +0 -42
  31. package/dist/esm/adapters/REST/endpoints/app-installation.mjs.map +0 -1
  32. package/dist/esm/adapters/REST/endpoints/app-key.mjs +0 -17
  33. package/dist/esm/adapters/REST/endpoints/app-key.mjs.map +0 -1
  34. package/dist/esm/adapters/REST/endpoints/app-signed-request.mjs +0 -8
  35. package/dist/esm/adapters/REST/endpoints/app-signed-request.mjs.map +0 -1
  36. package/dist/esm/adapters/REST/endpoints/app-signing-secret.mjs +0 -14
  37. package/dist/esm/adapters/REST/endpoints/app-signing-secret.mjs.map +0 -1
  38. package/dist/esm/adapters/REST/endpoints/app-upload.mjs +0 -25
  39. package/dist/esm/adapters/REST/endpoints/app-upload.mjs.map +0 -1
  40. package/dist/esm/adapters/REST/endpoints/asset-key.mjs +0 -32
  41. package/dist/esm/adapters/REST/endpoints/asset-key.mjs.map +0 -1
  42. package/dist/esm/adapters/REST/endpoints/asset.mjs +0 -208
  43. package/dist/esm/adapters/REST/endpoints/asset.mjs.map +0 -1
  44. package/dist/esm/adapters/REST/endpoints/bulk-action.mjs +0 -29
  45. package/dist/esm/adapters/REST/endpoints/bulk-action.mjs.map +0 -1
  46. package/dist/esm/adapters/REST/endpoints/comment.mjs +0 -91
  47. package/dist/esm/adapters/REST/endpoints/comment.mjs.map +0 -1
  48. package/dist/esm/adapters/REST/endpoints/concept-scheme.mjs +0 -54
  49. package/dist/esm/adapters/REST/endpoints/concept-scheme.mjs.map +0 -1
  50. package/dist/esm/adapters/REST/endpoints/concept.mjs +0 -70
  51. package/dist/esm/adapters/REST/endpoints/concept.mjs.map +0 -1
  52. package/dist/esm/adapters/REST/endpoints/content-type.mjs +0 -53
  53. package/dist/esm/adapters/REST/endpoints/content-type.mjs.map +0 -1
  54. package/dist/esm/adapters/REST/endpoints/editor-interface.mjs +0 -23
  55. package/dist/esm/adapters/REST/endpoints/editor-interface.mjs.map +0 -1
  56. package/dist/esm/adapters/REST/endpoints/entry.mjs +0 -114
  57. package/dist/esm/adapters/REST/endpoints/entry.mjs.map +0 -1
  58. package/dist/esm/adapters/REST/endpoints/environment-alias.mjs +0 -41
  59. package/dist/esm/adapters/REST/endpoints/environment-alias.mjs.map +0 -1
  60. package/dist/esm/adapters/REST/endpoints/environment-template-installation.mjs +0 -21
  61. package/dist/esm/adapters/REST/endpoints/environment-template-installation.mjs.map +0 -1
  62. package/dist/esm/adapters/REST/endpoints/environment-template.mjs +0 -41
  63. package/dist/esm/adapters/REST/endpoints/environment-template.mjs.map +0 -1
  64. package/dist/esm/adapters/REST/endpoints/environment.mjs +0 -46
  65. package/dist/esm/adapters/REST/endpoints/environment.mjs.map +0 -1
  66. package/dist/esm/adapters/REST/endpoints/extension.mjs +0 -39
  67. package/dist/esm/adapters/REST/endpoints/extension.mjs.map +0 -1
  68. package/dist/esm/adapters/REST/endpoints/function-log.mjs +0 -25
  69. package/dist/esm/adapters/REST/endpoints/function-log.mjs.map +0 -1
  70. package/dist/esm/adapters/REST/endpoints/function.mjs +0 -22
  71. package/dist/esm/adapters/REST/endpoints/function.mjs.map +0 -1
  72. package/dist/esm/adapters/REST/endpoints/http.mjs +0 -23
  73. package/dist/esm/adapters/REST/endpoints/http.mjs.map +0 -1
  74. package/dist/esm/adapters/REST/endpoints/index.mjs +0 -142
  75. package/dist/esm/adapters/REST/endpoints/index.mjs.map +0 -1
  76. package/dist/esm/adapters/REST/endpoints/locale.mjs +0 -34
  77. package/dist/esm/adapters/REST/endpoints/locale.mjs.map +0 -1
  78. package/dist/esm/adapters/REST/endpoints/oauth-application.mjs +0 -142
  79. package/dist/esm/adapters/REST/endpoints/oauth-application.mjs.map +0 -1
  80. package/dist/esm/adapters/REST/endpoints/organization-invitation.mjs +0 -27
  81. package/dist/esm/adapters/REST/endpoints/organization-invitation.mjs.map +0 -1
  82. package/dist/esm/adapters/REST/endpoints/organization-membership.mjs +0 -30
  83. package/dist/esm/adapters/REST/endpoints/organization-membership.mjs.map +0 -1
  84. package/dist/esm/adapters/REST/endpoints/organization.mjs +0 -26
  85. package/dist/esm/adapters/REST/endpoints/organization.mjs.map +0 -1
  86. package/dist/esm/adapters/REST/endpoints/personal-access-token.mjs +0 -33
  87. package/dist/esm/adapters/REST/endpoints/personal-access-token.mjs.map +0 -1
  88. package/dist/esm/adapters/REST/endpoints/preview-api-key.mjs +0 -13
  89. package/dist/esm/adapters/REST/endpoints/preview-api-key.mjs.map +0 -1
  90. package/dist/esm/adapters/REST/endpoints/raw.mjs +0 -55
  91. package/dist/esm/adapters/REST/endpoints/raw.mjs.map +0 -1
  92. package/dist/esm/adapters/REST/endpoints/release-action.mjs +0 -21
  93. package/dist/esm/adapters/REST/endpoints/release-action.mjs.map +0 -1
  94. package/dist/esm/adapters/REST/endpoints/release-asset.mjs +0 -143
  95. package/dist/esm/adapters/REST/endpoints/release-asset.mjs.map +0 -1
  96. package/dist/esm/adapters/REST/endpoints/release-entry.mjs +0 -56
  97. package/dist/esm/adapters/REST/endpoints/release-entry.mjs.map +0 -1
  98. package/dist/esm/adapters/REST/endpoints/release.mjs +0 -73
  99. package/dist/esm/adapters/REST/endpoints/release.mjs.map +0 -1
  100. package/dist/esm/adapters/REST/endpoints/resource-provider.mjs +0 -15
  101. package/dist/esm/adapters/REST/endpoints/resource-provider.mjs.map +0 -1
  102. package/dist/esm/adapters/REST/endpoints/resource-type.mjs +0 -25
  103. package/dist/esm/adapters/REST/endpoints/resource-type.mjs.map +0 -1
  104. package/dist/esm/adapters/REST/endpoints/resource.mjs +0 -9
  105. package/dist/esm/adapters/REST/endpoints/resource.mjs.map +0 -1
  106. package/dist/esm/adapters/REST/endpoints/role.mjs +0 -43
  107. package/dist/esm/adapters/REST/endpoints/role.mjs.map +0 -1
  108. package/dist/esm/adapters/REST/endpoints/scheduled-action.mjs +0 -38
  109. package/dist/esm/adapters/REST/endpoints/scheduled-action.mjs.map +0 -1
  110. package/dist/esm/adapters/REST/endpoints/snapshot.mjs +0 -26
  111. package/dist/esm/adapters/REST/endpoints/snapshot.mjs.map +0 -1
  112. package/dist/esm/adapters/REST/endpoints/space-member.mjs +0 -9
  113. package/dist/esm/adapters/REST/endpoints/space-member.mjs.map +0 -1
  114. package/dist/esm/adapters/REST/endpoints/space-membership.mjs +0 -54
  115. package/dist/esm/adapters/REST/endpoints/space-membership.mjs.map +0 -1
  116. package/dist/esm/adapters/REST/endpoints/space.mjs +0 -31
  117. package/dist/esm/adapters/REST/endpoints/space.mjs.map +0 -1
  118. package/dist/esm/adapters/REST/endpoints/tag.mjs +0 -31
  119. package/dist/esm/adapters/REST/endpoints/tag.mjs.map +0 -1
  120. package/dist/esm/adapters/REST/endpoints/task.mjs +0 -34
  121. package/dist/esm/adapters/REST/endpoints/task.mjs.map +0 -1
  122. package/dist/esm/adapters/REST/endpoints/team-membership.mjs +0 -32
  123. package/dist/esm/adapters/REST/endpoints/team-membership.mjs.map +0 -1
  124. package/dist/esm/adapters/REST/endpoints/team-space-membership.mjs +0 -46
  125. package/dist/esm/adapters/REST/endpoints/team-space-membership.mjs.map +0 -1
  126. package/dist/esm/adapters/REST/endpoints/team.mjs +0 -32
  127. package/dist/esm/adapters/REST/endpoints/team.mjs.map +0 -1
  128. package/dist/esm/adapters/REST/endpoints/ui-config.mjs +0 -19
  129. package/dist/esm/adapters/REST/endpoints/ui-config.mjs.map +0 -1
  130. package/dist/esm/adapters/REST/endpoints/upload-credentials.mjs +0 -14
  131. package/dist/esm/adapters/REST/endpoints/upload-credentials.mjs.map +0 -1
  132. package/dist/esm/adapters/REST/endpoints/upload.mjs +0 -39
  133. package/dist/esm/adapters/REST/endpoints/upload.mjs.map +0 -1
  134. package/dist/esm/adapters/REST/endpoints/usage.mjs +0 -15
  135. package/dist/esm/adapters/REST/endpoints/usage.mjs.map +0 -1
  136. package/dist/esm/adapters/REST/endpoints/user-ui-config.mjs +0 -19
  137. package/dist/esm/adapters/REST/endpoints/user-ui-config.mjs.map +0 -1
  138. package/dist/esm/adapters/REST/endpoints/user.mjs +0 -22
  139. package/dist/esm/adapters/REST/endpoints/user.mjs.map +0 -1
  140. package/dist/esm/adapters/REST/endpoints/utils.mjs +0 -22
  141. package/dist/esm/adapters/REST/endpoints/utils.mjs.map +0 -1
  142. package/dist/esm/adapters/REST/endpoints/webhook.mjs +0 -85
  143. package/dist/esm/adapters/REST/endpoints/webhook.mjs.map +0 -1
  144. package/dist/esm/adapters/REST/endpoints/workflow-definition.mjs +0 -36
  145. package/dist/esm/adapters/REST/endpoints/workflow-definition.mjs.map +0 -1
  146. package/dist/esm/adapters/REST/endpoints/workflow.mjs +0 -42
  147. package/dist/esm/adapters/REST/endpoints/workflow.mjs.map +0 -1
  148. package/dist/esm/adapters/REST/endpoints/workflows-changelog.mjs +0 -10
  149. package/dist/esm/adapters/REST/endpoints/workflows-changelog.mjs.map +0 -1
  150. package/dist/esm/adapters/REST/make-request.mjs +0 -21
  151. package/dist/esm/adapters/REST/make-request.mjs.map +0 -1
  152. package/dist/esm/adapters/REST/rest-adapter.mjs +0 -42
  153. package/dist/esm/adapters/REST/rest-adapter.mjs.map +0 -1
  154. package/dist/esm/common-types.mjs +0 -7
  155. package/dist/esm/common-types.mjs.map +0 -1
  156. package/dist/esm/common-utils.mjs +0 -33
  157. package/dist/esm/common-utils.mjs.map +0 -1
  158. package/dist/esm/constants/editor-interface-defaults/controls-defaults.mjs +0 -162
  159. package/dist/esm/constants/editor-interface-defaults/controls-defaults.mjs.map +0 -1
  160. package/dist/esm/constants/editor-interface-defaults/editors-defaults.mjs +0 -32
  161. package/dist/esm/constants/editor-interface-defaults/editors-defaults.mjs.map +0 -1
  162. package/dist/esm/constants/editor-interface-defaults/index.mjs +0 -13
  163. package/dist/esm/constants/editor-interface-defaults/index.mjs.map +0 -1
  164. package/dist/esm/constants/editor-interface-defaults/sidebar-defaults.mjs +0 -65
  165. package/dist/esm/constants/editor-interface-defaults/sidebar-defaults.mjs.map +0 -1
  166. package/dist/esm/constants/editor-interface-defaults/types.mjs +0 -16
  167. package/dist/esm/constants/editor-interface-defaults/types.mjs.map +0 -1
  168. package/dist/esm/create-adapter.mjs +0 -20
  169. package/dist/esm/create-adapter.mjs.map +0 -1
  170. package/dist/esm/create-app-definition-api.mjs +0 -253
  171. package/dist/esm/create-app-definition-api.mjs.map +0 -1
  172. package/dist/esm/create-contentful-api.mjs +0 -588
  173. package/dist/esm/create-contentful-api.mjs.map +0 -1
  174. package/dist/esm/create-entry-api.mjs +0 -489
  175. package/dist/esm/create-entry-api.mjs.map +0 -1
  176. package/dist/esm/create-environment-api.mjs +0 -2441
  177. package/dist/esm/create-environment-api.mjs.map +0 -1
  178. package/dist/esm/create-environment-template-api.mjs +0 -272
  179. package/dist/esm/create-environment-template-api.mjs.map +0 -1
  180. package/dist/esm/create-organization-api.mjs +0 -1138
  181. package/dist/esm/create-organization-api.mjs.map +0 -1
  182. package/dist/esm/create-space-api.mjs +0 -1589
  183. package/dist/esm/create-space-api.mjs.map +0 -1
  184. package/dist/esm/create-ui-config-api.mjs +0 -54
  185. package/dist/esm/create-ui-config-api.mjs.map +0 -1
  186. package/dist/esm/create-user-ui-config-api.mjs +0 -54
  187. package/dist/esm/create-user-ui-config-api.mjs.map +0 -1
  188. package/dist/esm/enhance-with-methods.mjs +0 -25
  189. package/dist/esm/enhance-with-methods.mjs.map +0 -1
  190. package/dist/esm/entities/access-token.mjs +0 -34
  191. package/dist/esm/entities/access-token.mjs.map +0 -1
  192. package/dist/esm/entities/ai-action-invocation.mjs +0 -17
  193. package/dist/esm/entities/ai-action-invocation.mjs.map +0 -1
  194. package/dist/esm/entities/ai-action.mjs +0 -73
  195. package/dist/esm/entities/ai-action.mjs.map +0 -1
  196. package/dist/esm/entities/api-key.mjs +0 -54
  197. package/dist/esm/entities/api-key.mjs.map +0 -1
  198. package/dist/esm/entities/app-access-token.mjs +0 -16
  199. package/dist/esm/entities/app-access-token.mjs.map +0 -1
  200. package/dist/esm/entities/app-action-call.mjs +0 -66
  201. package/dist/esm/entities/app-action-call.mjs.map +0 -1
  202. package/dist/esm/entities/app-action.mjs +0 -46
  203. package/dist/esm/entities/app-action.mjs.map +0 -1
  204. package/dist/esm/entities/app-bundle.mjs +0 -46
  205. package/dist/esm/entities/app-bundle.mjs.map +0 -1
  206. package/dist/esm/entities/app-definition.mjs +0 -27
  207. package/dist/esm/entities/app-definition.mjs.map +0 -1
  208. package/dist/esm/entities/app-details.mjs +0 -38
  209. package/dist/esm/entities/app-details.mjs.map +0 -1
  210. package/dist/esm/entities/app-event-subscription.mjs +0 -33
  211. package/dist/esm/entities/app-event-subscription.mjs.map +0 -1
  212. package/dist/esm/entities/app-installation.mjs +0 -53
  213. package/dist/esm/entities/app-installation.mjs.map +0 -1
  214. package/dist/esm/entities/app-key.mjs +0 -42
  215. package/dist/esm/entities/app-key.mjs.map +0 -1
  216. package/dist/esm/entities/app-signed-request.mjs +0 -16
  217. package/dist/esm/entities/app-signed-request.mjs.map +0 -1
  218. package/dist/esm/entities/app-signing-secret.mjs +0 -33
  219. package/dist/esm/entities/app-signing-secret.mjs.map +0 -1
  220. package/dist/esm/entities/app-upload.mjs +0 -45
  221. package/dist/esm/entities/app-upload.mjs.map +0 -1
  222. package/dist/esm/entities/asset-key.mjs +0 -16
  223. package/dist/esm/entities/asset-key.mjs.map +0 -1
  224. package/dist/esm/entities/asset.mjs +0 -130
  225. package/dist/esm/entities/asset.mjs.map +0 -1
  226. package/dist/esm/entities/bulk-action.mjs +0 -59
  227. package/dist/esm/entities/bulk-action.mjs.map +0 -1
  228. package/dist/esm/entities/comment.mjs +0 -61
  229. package/dist/esm/entities/comment.mjs.map +0 -1
  230. package/dist/esm/entities/content-type.mjs +0 -118
  231. package/dist/esm/entities/content-type.mjs.map +0 -1
  232. package/dist/esm/entities/editor-interface.mjs +0 -48
  233. package/dist/esm/entities/editor-interface.mjs.map +0 -1
  234. package/dist/esm/entities/entry.mjs +0 -25
  235. package/dist/esm/entities/entry.mjs.map +0 -1
  236. package/dist/esm/entities/environment-alias.mjs +0 -56
  237. package/dist/esm/entities/environment-alias.mjs.map +0 -1
  238. package/dist/esm/entities/environment-template-installation.mjs +0 -21
  239. package/dist/esm/entities/environment-template-installation.mjs.map +0 -1
  240. package/dist/esm/entities/environment-template.mjs +0 -16
  241. package/dist/esm/entities/environment-template.mjs.map +0 -1
  242. package/dist/esm/entities/environment.mjs +0 -32
  243. package/dist/esm/entities/environment.mjs.map +0 -1
  244. package/dist/esm/entities/extension.mjs +0 -52
  245. package/dist/esm/entities/extension.mjs.map +0 -1
  246. package/dist/esm/entities/function-log.mjs +0 -24
  247. package/dist/esm/entities/function-log.mjs.map +0 -1
  248. package/dist/esm/entities/function.mjs +0 -64
  249. package/dist/esm/entities/function.mjs.map +0 -1
  250. package/dist/esm/entities/index.mjs +0 -117
  251. package/dist/esm/entities/index.mjs.map +0 -1
  252. package/dist/esm/entities/locale.mjs +0 -55
  253. package/dist/esm/entities/locale.mjs.map +0 -1
  254. package/dist/esm/entities/oauth-application.mjs +0 -64
  255. package/dist/esm/entities/oauth-application.mjs.map +0 -1
  256. package/dist/esm/entities/organization-invitation.mjs +0 -16
  257. package/dist/esm/entities/organization-invitation.mjs.map +0 -1
  258. package/dist/esm/entities/organization-membership.mjs +0 -51
  259. package/dist/esm/entities/organization-membership.mjs.map +0 -1
  260. package/dist/esm/entities/organization.mjs +0 -30
  261. package/dist/esm/entities/organization.mjs.map +0 -1
  262. package/dist/esm/entities/personal-access-token.mjs +0 -34
  263. package/dist/esm/entities/personal-access-token.mjs.map +0 -1
  264. package/dist/esm/entities/preview-api-key.mjs +0 -29
  265. package/dist/esm/entities/preview-api-key.mjs.map +0 -1
  266. package/dist/esm/entities/release-action.mjs +0 -53
  267. package/dist/esm/entities/release-action.mjs.map +0 -1
  268. package/dist/esm/entities/release.mjs +0 -107
  269. package/dist/esm/entities/release.mjs.map +0 -1
  270. package/dist/esm/entities/resource-provider.mjs +0 -138
  271. package/dist/esm/entities/resource-provider.mjs.map +0 -1
  272. package/dist/esm/entities/resource-type.mjs +0 -95
  273. package/dist/esm/entities/resource-type.mjs.map +0 -1
  274. package/dist/esm/entities/resource.mjs +0 -11
  275. package/dist/esm/entities/resource.mjs.map +0 -1
  276. package/dist/esm/entities/role.mjs +0 -51
  277. package/dist/esm/entities/role.mjs.map +0 -1
  278. package/dist/esm/entities/scheduled-action.mjs +0 -147
  279. package/dist/esm/entities/scheduled-action.mjs.map +0 -1
  280. package/dist/esm/entities/snapshot.mjs +0 -34
  281. package/dist/esm/entities/snapshot.mjs.map +0 -1
  282. package/dist/esm/entities/space-member.mjs +0 -21
  283. package/dist/esm/entities/space-member.mjs.map +0 -1
  284. package/dist/esm/entities/space-membership.mjs +0 -51
  285. package/dist/esm/entities/space-membership.mjs.map +0 -1
  286. package/dist/esm/entities/space.mjs +0 -31
  287. package/dist/esm/entities/space.mjs.map +0 -1
  288. package/dist/esm/entities/tag.mjs +0 -54
  289. package/dist/esm/entities/tag.mjs.map +0 -1
  290. package/dist/esm/entities/task.mjs +0 -55
  291. package/dist/esm/entities/task.mjs.map +0 -1
  292. package/dist/esm/entities/team-membership.mjs +0 -52
  293. package/dist/esm/entities/team-membership.mjs.map +0 -1
  294. package/dist/esm/entities/team-space-membership.mjs +0 -51
  295. package/dist/esm/entities/team-space-membership.mjs.map +0 -1
  296. package/dist/esm/entities/team.mjs +0 -51
  297. package/dist/esm/entities/team.mjs.map +0 -1
  298. package/dist/esm/entities/ui-config.mjs +0 -19
  299. package/dist/esm/entities/ui-config.mjs.map +0 -1
  300. package/dist/esm/entities/upload.mjs +0 -37
  301. package/dist/esm/entities/upload.mjs.map +0 -1
  302. package/dist/esm/entities/usage.mjs +0 -23
  303. package/dist/esm/entities/usage.mjs.map +0 -1
  304. package/dist/esm/entities/user-ui-config.mjs +0 -19
  305. package/dist/esm/entities/user-ui-config.mjs.map +0 -1
  306. package/dist/esm/entities/user.mjs +0 -26
  307. package/dist/esm/entities/user.mjs.map +0 -1
  308. package/dist/esm/entities/webhook.mjs +0 -75
  309. package/dist/esm/entities/webhook.mjs.map +0 -1
  310. package/dist/esm/entities/workflow-definition.mjs +0 -29
  311. package/dist/esm/entities/workflow-definition.mjs.map +0 -1
  312. package/dist/esm/index.mjs +0 -40
  313. package/dist/esm/index.mjs.map +0 -1
  314. package/dist/esm/methods/action.mjs +0 -49
  315. package/dist/esm/methods/action.mjs.map +0 -1
  316. package/dist/esm/methods/content-type.mjs +0 -47
  317. package/dist/esm/methods/content-type.mjs.map +0 -1
  318. package/dist/esm/methods/utils.mjs +0 -10
  319. package/dist/esm/methods/utils.mjs.map +0 -1
  320. package/dist/esm/plain/as-iterator.mjs +0 -37
  321. package/dist/esm/plain/as-iterator.mjs.map +0 -1
  322. package/dist/esm/plain/checks.mjs +0 -11
  323. package/dist/esm/plain/checks.mjs.map +0 -1
  324. package/dist/esm/plain/pagination-helper.mjs +0 -68
  325. package/dist/esm/plain/pagination-helper.mjs.map +0 -1
  326. package/dist/esm/plain/plain-client.mjs +0 -564
  327. package/dist/esm/plain/plain-client.mjs.map +0 -1
  328. package/dist/esm/plain/wrappers/wrap.mjs +0 -25
  329. package/dist/esm/plain/wrappers/wrap.mjs.map +0 -1
  330. package/dist/esm/upload-http-client.mjs +0 -15
  331. package/dist/esm/upload-http-client.mjs.map +0 -1
  332. package/dist/types/adapters/REST/endpoints/access-token.d.ts +0 -111
  333. package/dist/types/adapters/REST/endpoints/access-token.js +0 -131
  334. package/dist/types/adapters/REST/endpoints/access-token.js.map +0 -1
  335. package/dist/types/adapters/REST/endpoints/ai-action-invocation.d.ts +0 -2
  336. package/dist/types/adapters/REST/endpoints/ai-action-invocation.js +0 -8
  337. package/dist/types/adapters/REST/endpoints/ai-action-invocation.js.map +0 -1
  338. package/dist/types/adapters/REST/endpoints/ai-action.d.ts +0 -9
  339. package/dist/types/adapters/REST/endpoints/ai-action.js +0 -49
  340. package/dist/types/adapters/REST/endpoints/ai-action.js.map +0 -1
  341. package/dist/types/adapters/REST/endpoints/api-key.d.ts +0 -7
  342. package/dist/types/adapters/REST/endpoints/api-key.js +0 -44
  343. package/dist/types/adapters/REST/endpoints/api-key.js.map +0 -1
  344. package/dist/types/adapters/REST/endpoints/app-access-token.d.ts +0 -2
  345. package/dist/types/adapters/REST/endpoints/app-access-token.js +0 -8
  346. package/dist/types/adapters/REST/endpoints/app-access-token.js.map +0 -1
  347. package/dist/types/adapters/REST/endpoints/app-action-call.d.ts +0 -7
  348. package/dist/types/adapters/REST/endpoints/app-action-call.js +0 -112
  349. package/dist/types/adapters/REST/endpoints/app-action-call.js.map +0 -1
  350. package/dist/types/adapters/REST/endpoints/app-action.d.ts +0 -7
  351. package/dist/types/adapters/REST/endpoints/app-action.js +0 -36
  352. package/dist/types/adapters/REST/endpoints/app-action.js.map +0 -1
  353. package/dist/types/adapters/REST/endpoints/app-bundle.d.ts +0 -5
  354. package/dist/types/adapters/REST/endpoints/app-bundle.js +0 -35
  355. package/dist/types/adapters/REST/endpoints/app-bundle.js.map +0 -1
  356. package/dist/types/adapters/REST/endpoints/app-definition.d.ts +0 -9
  357. package/dist/types/adapters/REST/endpoints/app-definition.js +0 -45
  358. package/dist/types/adapters/REST/endpoints/app-definition.js.map +0 -1
  359. package/dist/types/adapters/REST/endpoints/app-details.d.ts +0 -4
  360. package/dist/types/adapters/REST/endpoints/app-details.js +0 -14
  361. package/dist/types/adapters/REST/endpoints/app-details.js.map +0 -1
  362. package/dist/types/adapters/REST/endpoints/app-event-subscription.d.ts +0 -4
  363. package/dist/types/adapters/REST/endpoints/app-event-subscription.js +0 -14
  364. package/dist/types/adapters/REST/endpoints/app-event-subscription.js.map +0 -1
  365. package/dist/types/adapters/REST/endpoints/app-installation.d.ts +0 -8
  366. package/dist/types/adapters/REST/endpoints/app-installation.js +0 -42
  367. package/dist/types/adapters/REST/endpoints/app-installation.js.map +0 -1
  368. package/dist/types/adapters/REST/endpoints/app-key.d.ts +0 -5
  369. package/dist/types/adapters/REST/endpoints/app-key.js +0 -17
  370. package/dist/types/adapters/REST/endpoints/app-key.js.map +0 -1
  371. package/dist/types/adapters/REST/endpoints/app-signed-request.d.ts +0 -2
  372. package/dist/types/adapters/REST/endpoints/app-signed-request.js +0 -8
  373. package/dist/types/adapters/REST/endpoints/app-signed-request.js.map +0 -1
  374. package/dist/types/adapters/REST/endpoints/app-signing-secret.d.ts +0 -4
  375. package/dist/types/adapters/REST/endpoints/app-signing-secret.js +0 -14
  376. package/dist/types/adapters/REST/endpoints/app-signing-secret.js.map +0 -1
  377. package/dist/types/adapters/REST/endpoints/app-upload.d.ts +0 -4
  378. package/dist/types/adapters/REST/endpoints/app-upload.js +0 -25
  379. package/dist/types/adapters/REST/endpoints/app-upload.js.map +0 -1
  380. package/dist/types/adapters/REST/endpoints/asset-key.d.ts +0 -5
  381. package/dist/types/adapters/REST/endpoints/asset-key.js +0 -32
  382. package/dist/types/adapters/REST/endpoints/asset-key.js.map +0 -1
  383. package/dist/types/adapters/REST/endpoints/asset.d.ts +0 -15
  384. package/dist/types/adapters/REST/endpoints/asset.js +0 -208
  385. package/dist/types/adapters/REST/endpoints/asset.js.map +0 -1
  386. package/dist/types/adapters/REST/endpoints/bulk-action.d.ts +0 -9
  387. package/dist/types/adapters/REST/endpoints/bulk-action.js +0 -29
  388. package/dist/types/adapters/REST/endpoints/bulk-action.js.map +0 -1
  389. package/dist/types/adapters/REST/endpoints/comment.d.ts +0 -10
  390. package/dist/types/adapters/REST/endpoints/comment.js +0 -91
  391. package/dist/types/adapters/REST/endpoints/comment.js.map +0 -1
  392. package/dist/types/adapters/REST/endpoints/concept-scheme.d.ts +0 -10
  393. package/dist/types/adapters/REST/endpoints/concept-scheme.js +0 -54
  394. package/dist/types/adapters/REST/endpoints/concept-scheme.js.map +0 -1
  395. package/dist/types/adapters/REST/endpoints/concept.d.ts +0 -12
  396. package/dist/types/adapters/REST/endpoints/concept.js +0 -70
  397. package/dist/types/adapters/REST/endpoints/concept.js.map +0 -1
  398. package/dist/types/adapters/REST/endpoints/content-type.d.ts +0 -9
  399. package/dist/types/adapters/REST/endpoints/content-type.js +0 -53
  400. package/dist/types/adapters/REST/endpoints/content-type.js.map +0 -1
  401. package/dist/types/adapters/REST/endpoints/editor-interface.d.ts +0 -4
  402. package/dist/types/adapters/REST/endpoints/editor-interface.js +0 -23
  403. package/dist/types/adapters/REST/endpoints/editor-interface.js.map +0 -1
  404. package/dist/types/adapters/REST/endpoints/entry.d.ts +0 -14
  405. package/dist/types/adapters/REST/endpoints/entry.js +0 -114
  406. package/dist/types/adapters/REST/endpoints/entry.js.map +0 -1
  407. package/dist/types/adapters/REST/endpoints/environment-alias.d.ts +0 -9
  408. package/dist/types/adapters/REST/endpoints/environment-alias.js +0 -41
  409. package/dist/types/adapters/REST/endpoints/environment-alias.js.map +0 -1
  410. package/dist/types/adapters/REST/endpoints/environment-template-installation.d.ts +0 -3
  411. package/dist/types/adapters/REST/endpoints/environment-template-installation.js +0 -21
  412. package/dist/types/adapters/REST/endpoints/environment-template-installation.js.map +0 -1
  413. package/dist/types/adapters/REST/endpoints/environment-template.d.ts +0 -11
  414. package/dist/types/adapters/REST/endpoints/environment-template.js +0 -41
  415. package/dist/types/adapters/REST/endpoints/environment-template.js.map +0 -1
  416. package/dist/types/adapters/REST/endpoints/environment.d.ts +0 -7
  417. package/dist/types/adapters/REST/endpoints/environment.js +0 -46
  418. package/dist/types/adapters/REST/endpoints/environment.js.map +0 -1
  419. package/dist/types/adapters/REST/endpoints/extension.d.ts +0 -9
  420. package/dist/types/adapters/REST/endpoints/extension.js +0 -39
  421. package/dist/types/adapters/REST/endpoints/extension.js.map +0 -1
  422. package/dist/types/adapters/REST/endpoints/function-log.d.ts +0 -3
  423. package/dist/types/adapters/REST/endpoints/function-log.js +0 -25
  424. package/dist/types/adapters/REST/endpoints/function-log.js.map +0 -1
  425. package/dist/types/adapters/REST/endpoints/function.d.ts +0 -4
  426. package/dist/types/adapters/REST/endpoints/function.js +0 -22
  427. package/dist/types/adapters/REST/endpoints/function.js.map +0 -1
  428. package/dist/types/adapters/REST/endpoints/http.d.ts +0 -7
  429. package/dist/types/adapters/REST/endpoints/http.js +0 -23
  430. package/dist/types/adapters/REST/endpoints/http.js.map +0 -1
  431. package/dist/types/adapters/REST/endpoints/index.d.ts +0 -139
  432. package/dist/types/adapters/REST/endpoints/index.js +0 -142
  433. package/dist/types/adapters/REST/endpoints/index.js.map +0 -1
  434. package/dist/types/adapters/REST/endpoints/locale.d.ts +0 -6
  435. package/dist/types/adapters/REST/endpoints/locale.js +0 -34
  436. package/dist/types/adapters/REST/endpoints/locale.js.map +0 -1
  437. package/dist/types/adapters/REST/endpoints/oauth-application.d.ts +0 -122
  438. package/dist/types/adapters/REST/endpoints/oauth-application.js +0 -142
  439. package/dist/types/adapters/REST/endpoints/oauth-application.js.map +0 -1
  440. package/dist/types/adapters/REST/endpoints/organization-invitation.d.ts +0 -3
  441. package/dist/types/adapters/REST/endpoints/organization-invitation.js +0 -27
  442. package/dist/types/adapters/REST/endpoints/organization-invitation.js.map +0 -1
  443. package/dist/types/adapters/REST/endpoints/organization-membership.d.ts +0 -5
  444. package/dist/types/adapters/REST/endpoints/organization-membership.js +0 -30
  445. package/dist/types/adapters/REST/endpoints/organization-membership.js.map +0 -1
  446. package/dist/types/adapters/REST/endpoints/organization.d.ts +0 -3
  447. package/dist/types/adapters/REST/endpoints/organization.js +0 -26
  448. package/dist/types/adapters/REST/endpoints/organization.js.map +0 -1
  449. package/dist/types/adapters/REST/endpoints/personal-access-token.d.ts +0 -17
  450. package/dist/types/adapters/REST/endpoints/personal-access-token.js +0 -33
  451. package/dist/types/adapters/REST/endpoints/personal-access-token.js.map +0 -1
  452. package/dist/types/adapters/REST/endpoints/preview-api-key.d.ts +0 -3
  453. package/dist/types/adapters/REST/endpoints/preview-api-key.js +0 -13
  454. package/dist/types/adapters/REST/endpoints/preview-api-key.js.map +0 -1
  455. package/dist/types/adapters/REST/endpoints/raw.d.ts +0 -7
  456. package/dist/types/adapters/REST/endpoints/raw.js +0 -55
  457. package/dist/types/adapters/REST/endpoints/raw.js.map +0 -1
  458. package/dist/types/adapters/REST/endpoints/release-action.d.ts +0 -4
  459. package/dist/types/adapters/REST/endpoints/release-action.js +0 -21
  460. package/dist/types/adapters/REST/endpoints/release-action.js.map +0 -1
  461. package/dist/types/adapters/REST/endpoints/release-asset.d.ts +0 -9
  462. package/dist/types/adapters/REST/endpoints/release-asset.js +0 -143
  463. package/dist/types/adapters/REST/endpoints/release-asset.js.map +0 -1
  464. package/dist/types/adapters/REST/endpoints/release-entry.d.ts +0 -7
  465. package/dist/types/adapters/REST/endpoints/release-entry.js +0 -56
  466. package/dist/types/adapters/REST/endpoints/release-entry.js.map +0 -1
  467. package/dist/types/adapters/REST/endpoints/release.d.ts +0 -11
  468. package/dist/types/adapters/REST/endpoints/release.js +0 -73
  469. package/dist/types/adapters/REST/endpoints/release.js.map +0 -1
  470. package/dist/types/adapters/REST/endpoints/resource-provider.d.ts +0 -4
  471. package/dist/types/adapters/REST/endpoints/resource-provider.js +0 -15
  472. package/dist/types/adapters/REST/endpoints/resource-provider.js.map +0 -1
  473. package/dist/types/adapters/REST/endpoints/resource-type.d.ts +0 -6
  474. package/dist/types/adapters/REST/endpoints/resource-type.js +0 -25
  475. package/dist/types/adapters/REST/endpoints/resource-type.js.map +0 -1
  476. package/dist/types/adapters/REST/endpoints/resource.d.ts +0 -2
  477. package/dist/types/adapters/REST/endpoints/resource.js +0 -9
  478. package/dist/types/adapters/REST/endpoints/resource.js.map +0 -1
  479. package/dist/types/adapters/REST/endpoints/role.d.ts +0 -12
  480. package/dist/types/adapters/REST/endpoints/role.js +0 -43
  481. package/dist/types/adapters/REST/endpoints/role.js.map +0 -1
  482. package/dist/types/adapters/REST/endpoints/scheduled-action.d.ts +0 -6
  483. package/dist/types/adapters/REST/endpoints/scheduled-action.js +0 -38
  484. package/dist/types/adapters/REST/endpoints/scheduled-action.js.map +0 -1
  485. package/dist/types/adapters/REST/endpoints/snapshot.d.ts +0 -5
  486. package/dist/types/adapters/REST/endpoints/snapshot.js +0 -26
  487. package/dist/types/adapters/REST/endpoints/snapshot.js.map +0 -1
  488. package/dist/types/adapters/REST/endpoints/space-member.d.ts +0 -3
  489. package/dist/types/adapters/REST/endpoints/space-member.js +0 -9
  490. package/dist/types/adapters/REST/endpoints/space-member.js.map +0 -1
  491. package/dist/types/adapters/REST/endpoints/space-membership.d.ts +0 -9
  492. package/dist/types/adapters/REST/endpoints/space-membership.js +0 -54
  493. package/dist/types/adapters/REST/endpoints/space-membership.js.map +0 -1
  494. package/dist/types/adapters/REST/endpoints/space.d.ts +0 -7
  495. package/dist/types/adapters/REST/endpoints/space.js +0 -31
  496. package/dist/types/adapters/REST/endpoints/space.js.map +0 -1
  497. package/dist/types/adapters/REST/endpoints/tag.d.ts +0 -6
  498. package/dist/types/adapters/REST/endpoints/tag.js +0 -31
  499. package/dist/types/adapters/REST/endpoints/tag.js.map +0 -1
  500. package/dist/types/adapters/REST/endpoints/task.d.ts +0 -10
  501. package/dist/types/adapters/REST/endpoints/task.js +0 -34
  502. package/dist/types/adapters/REST/endpoints/task.js.map +0 -1
  503. package/dist/types/adapters/REST/endpoints/team-membership.d.ts +0 -10
  504. package/dist/types/adapters/REST/endpoints/team-membership.js +0 -32
  505. package/dist/types/adapters/REST/endpoints/team-membership.js.map +0 -1
  506. package/dist/types/adapters/REST/endpoints/team-space-membership.d.ts +0 -8
  507. package/dist/types/adapters/REST/endpoints/team-space-membership.js +0 -46
  508. package/dist/types/adapters/REST/endpoints/team-space-membership.js.map +0 -1
  509. package/dist/types/adapters/REST/endpoints/team.d.ts +0 -7
  510. package/dist/types/adapters/REST/endpoints/team.js +0 -32
  511. package/dist/types/adapters/REST/endpoints/team.js.map +0 -1
  512. package/dist/types/adapters/REST/endpoints/ui-config.d.ts +0 -3
  513. package/dist/types/adapters/REST/endpoints/ui-config.js +0 -19
  514. package/dist/types/adapters/REST/endpoints/ui-config.js.map +0 -1
  515. package/dist/types/adapters/REST/endpoints/upload-credentials.d.ts +0 -2
  516. package/dist/types/adapters/REST/endpoints/upload-credentials.js +0 -14
  517. package/dist/types/adapters/REST/endpoints/upload-credentials.js.map +0 -1
  518. package/dist/types/adapters/REST/endpoints/upload.d.ts +0 -4
  519. package/dist/types/adapters/REST/endpoints/upload.js +0 -39
  520. package/dist/types/adapters/REST/endpoints/upload.js.map +0 -1
  521. package/dist/types/adapters/REST/endpoints/usage.d.ts +0 -3
  522. package/dist/types/adapters/REST/endpoints/usage.js +0 -15
  523. package/dist/types/adapters/REST/endpoints/usage.js.map +0 -1
  524. package/dist/types/adapters/REST/endpoints/user-ui-config.d.ts +0 -3
  525. package/dist/types/adapters/REST/endpoints/user-ui-config.js +0 -19
  526. package/dist/types/adapters/REST/endpoints/user-ui-config.js.map +0 -1
  527. package/dist/types/adapters/REST/endpoints/user.d.ts +0 -6
  528. package/dist/types/adapters/REST/endpoints/user.js +0 -22
  529. package/dist/types/adapters/REST/endpoints/user.js.map +0 -1
  530. package/dist/types/adapters/REST/endpoints/utils.d.ts +0 -3
  531. package/dist/types/adapters/REST/endpoints/utils.js +0 -22
  532. package/dist/types/adapters/REST/endpoints/utils.js.map +0 -1
  533. package/dist/types/adapters/REST/endpoints/webhook.d.ts +0 -29
  534. package/dist/types/adapters/REST/endpoints/webhook.js +0 -85
  535. package/dist/types/adapters/REST/endpoints/webhook.js.map +0 -1
  536. package/dist/types/adapters/REST/endpoints/workflow-definition.d.ts +0 -6
  537. package/dist/types/adapters/REST/endpoints/workflow-definition.js +0 -36
  538. package/dist/types/adapters/REST/endpoints/workflow-definition.js.map +0 -1
  539. package/dist/types/adapters/REST/endpoints/workflow.d.ts +0 -7
  540. package/dist/types/adapters/REST/endpoints/workflow.js +0 -42
  541. package/dist/types/adapters/REST/endpoints/workflow.js.map +0 -1
  542. package/dist/types/adapters/REST/endpoints/workflows-changelog.d.ts +0 -2
  543. package/dist/types/adapters/REST/endpoints/workflows-changelog.js +0 -10
  544. package/dist/types/adapters/REST/endpoints/workflows-changelog.js.map +0 -1
  545. package/dist/types/adapters/REST/make-request.d.ts +0 -7
  546. package/dist/types/adapters/REST/make-request.js +0 -21
  547. package/dist/types/adapters/REST/make-request.js.map +0 -1
  548. package/dist/types/adapters/REST/rest-adapter.d.ts +0 -25
  549. package/dist/types/adapters/REST/rest-adapter.js +0 -42
  550. package/dist/types/adapters/REST/rest-adapter.js.map +0 -1
  551. package/dist/types/adapters/REST/types.d.ts +0 -6
  552. package/dist/types/common-types.d.ts +0 -2950
  553. package/dist/types/common-types.js +0 -7
  554. package/dist/types/common-types.js.map +0 -1
  555. package/dist/types/common-utils.d.ts +0 -9
  556. package/dist/types/common-utils.js +0 -33
  557. package/dist/types/common-utils.js.map +0 -1
  558. package/dist/types/constants/editor-interface-defaults/controls-defaults.d.ts +0 -244
  559. package/dist/types/constants/editor-interface-defaults/controls-defaults.js +0 -162
  560. package/dist/types/constants/editor-interface-defaults/controls-defaults.js.map +0 -1
  561. package/dist/types/constants/editor-interface-defaults/editors-defaults.d.ts +0 -23
  562. package/dist/types/constants/editor-interface-defaults/editors-defaults.js +0 -32
  563. package/dist/types/constants/editor-interface-defaults/editors-defaults.js.map +0 -1
  564. package/dist/types/constants/editor-interface-defaults/index.d.ts +0 -22
  565. package/dist/types/constants/editor-interface-defaults/index.js +0 -13
  566. package/dist/types/constants/editor-interface-defaults/index.js.map +0 -1
  567. package/dist/types/constants/editor-interface-defaults/sidebar-defaults.d.ts +0 -13
  568. package/dist/types/constants/editor-interface-defaults/sidebar-defaults.js +0 -65
  569. package/dist/types/constants/editor-interface-defaults/sidebar-defaults.js.map +0 -1
  570. package/dist/types/constants/editor-interface-defaults/types.d.ts +0 -12
  571. package/dist/types/constants/editor-interface-defaults/types.js +0 -16
  572. package/dist/types/constants/editor-interface-defaults/types.js.map +0 -1
  573. package/dist/types/create-adapter.d.ts +0 -13
  574. package/dist/types/create-adapter.js +0 -20
  575. package/dist/types/create-adapter.js.map +0 -1
  576. package/dist/types/create-app-definition-api.d.ts +0 -169
  577. package/dist/types/create-app-definition-api.js +0 -253
  578. package/dist/types/create-app-definition-api.js.map +0 -1
  579. package/dist/types/create-contentful-api.d.ts +0 -445
  580. package/dist/types/create-contentful-api.js +0 -588
  581. package/dist/types/create-contentful-api.js.map +0 -1
  582. package/dist/types/create-entry-api.d.ts +0 -331
  583. package/dist/types/create-entry-api.js +0 -489
  584. package/dist/types/create-entry-api.js.map +0 -1
  585. package/dist/types/create-environment-api.d.ts +0 -1687
  586. package/dist/types/create-environment-api.js +0 -2441
  587. package/dist/types/create-environment-api.js.map +0 -1
  588. package/dist/types/create-environment-template-api.d.ts +0 -198
  589. package/dist/types/create-environment-template-api.js +0 -272
  590. package/dist/types/create-environment-template-api.js.map +0 -1
  591. package/dist/types/create-organization-api.d.ts +0 -1179
  592. package/dist/types/create-organization-api.js +0 -1138
  593. package/dist/types/create-organization-api.js.map +0 -1
  594. package/dist/types/create-space-api.d.ts +0 -1150
  595. package/dist/types/create-space-api.js +0 -1589
  596. package/dist/types/create-space-api.js.map +0 -1
  597. package/dist/types/create-ui-config-api.d.ts +0 -34
  598. package/dist/types/create-ui-config-api.js +0 -54
  599. package/dist/types/create-ui-config-api.js.map +0 -1
  600. package/dist/types/create-user-ui-config-api.d.ts +0 -34
  601. package/dist/types/create-user-ui-config-api.js +0 -54
  602. package/dist/types/create-user-ui-config-api.js.map +0 -1
  603. package/dist/types/enhance-with-methods.d.ts +0 -12
  604. package/dist/types/enhance-with-methods.js +0 -25
  605. package/dist/types/enhance-with-methods.js.map +0 -1
  606. package/dist/types/entities/access-token.d.ts +0 -61
  607. package/dist/types/entities/access-token.js +0 -34
  608. package/dist/types/entities/access-token.js.map +0 -1
  609. package/dist/types/entities/ai-action-invocation.d.ts +0 -82
  610. package/dist/types/entities/ai-action-invocation.js +0 -17
  611. package/dist/types/entities/ai-action-invocation.js.map +0 -1
  612. package/dist/types/entities/ai-action.d.ts +0 -75
  613. package/dist/types/entities/ai-action.js +0 -73
  614. package/dist/types/entities/ai-action.js.map +0 -1
  615. package/dist/types/entities/api-key.d.ts +0 -70
  616. package/dist/types/entities/api-key.js +0 -54
  617. package/dist/types/entities/api-key.js.map +0 -1
  618. package/dist/types/entities/app-access-token.d.ts +0 -34
  619. package/dist/types/entities/app-access-token.js +0 -16
  620. package/dist/types/entities/app-access-token.js.map +0 -1
  621. package/dist/types/entities/app-action-call.d.ts +0 -92
  622. package/dist/types/entities/app-action-call.js +0 -66
  623. package/dist/types/entities/app-action-call.js.map +0 -1
  624. package/dist/types/entities/app-action.d.ts +0 -161
  625. package/dist/types/entities/app-action.js +0 -46
  626. package/dist/types/entities/app-action.js.map +0 -1
  627. package/dist/types/entities/app-bundle.d.ts +0 -86
  628. package/dist/types/entities/app-bundle.js +0 -46
  629. package/dist/types/entities/app-bundle.js.map +0 -1
  630. package/dist/types/entities/app-definition.d.ts +0 -88
  631. package/dist/types/entities/app-definition.js +0 -27
  632. package/dist/types/entities/app-definition.js.map +0 -1
  633. package/dist/types/entities/app-details.d.ts +0 -54
  634. package/dist/types/entities/app-details.js +0 -38
  635. package/dist/types/entities/app-details.js.map +0 -1
  636. package/dist/types/entities/app-event-subscription.d.ts +0 -50
  637. package/dist/types/entities/app-event-subscription.js +0 -33
  638. package/dist/types/entities/app-event-subscription.js.map +0 -1
  639. package/dist/types/entities/app-installation.d.ts +0 -70
  640. package/dist/types/entities/app-installation.js +0 -53
  641. package/dist/types/entities/app-installation.js.map +0 -1
  642. package/dist/types/entities/app-key.d.ts +0 -77
  643. package/dist/types/entities/app-key.js +0 -42
  644. package/dist/types/entities/app-key.js.map +0 -1
  645. package/dist/types/entities/app-signed-request.d.ts +0 -42
  646. package/dist/types/entities/app-signed-request.js +0 -16
  647. package/dist/types/entities/app-signed-request.js.map +0 -1
  648. package/dist/types/entities/app-signing-secret.d.ts +0 -45
  649. package/dist/types/entities/app-signing-secret.js +0 -33
  650. package/dist/types/entities/app-signing-secret.js.map +0 -1
  651. package/dist/types/entities/app-upload.d.ts +0 -44
  652. package/dist/types/entities/app-upload.js +0 -45
  653. package/dist/types/entities/app-upload.js.map +0 -1
  654. package/dist/types/entities/asset-key.d.ts +0 -20
  655. package/dist/types/entities/asset-key.js +0 -16
  656. package/dist/types/entities/asset-key.js.map +0 -1
  657. package/dist/types/entities/asset.d.ts +0 -277
  658. package/dist/types/entities/asset.js +0 -130
  659. package/dist/types/entities/asset.js.map +0 -1
  660. package/dist/types/entities/bulk-action.d.ts +0 -122
  661. package/dist/types/entities/bulk-action.js +0 -59
  662. package/dist/types/entities/bulk-action.js.map +0 -1
  663. package/dist/types/entities/comment.d.ts +0 -102
  664. package/dist/types/entities/comment.js +0 -61
  665. package/dist/types/entities/comment.js.map +0 -1
  666. package/dist/types/entities/concept-scheme.d.ts +0 -22
  667. package/dist/types/entities/concept.d.ts +0 -30
  668. package/dist/types/entities/content-type-fields.d.ts +0 -81
  669. package/dist/types/entities/content-type.d.ts +0 -213
  670. package/dist/types/entities/content-type.js +0 -118
  671. package/dist/types/entities/content-type.js.map +0 -1
  672. package/dist/types/entities/editor-interface.d.ts +0 -168
  673. package/dist/types/entities/editor-interface.js +0 -48
  674. package/dist/types/entities/editor-interface.js.map +0 -1
  675. package/dist/types/entities/entry.d.ts +0 -53
  676. package/dist/types/entities/entry.js +0 -25
  677. package/dist/types/entities/entry.js.map +0 -1
  678. package/dist/types/entities/environment-alias.d.ts +0 -74
  679. package/dist/types/entities/environment-alias.js +0 -56
  680. package/dist/types/entities/environment-alias.js.map +0 -1
  681. package/dist/types/entities/environment-template-installation.d.ts +0 -57
  682. package/dist/types/entities/environment-template-installation.js +0 -21
  683. package/dist/types/entities/environment-template-installation.js.map +0 -1
  684. package/dist/types/entities/environment-template.d.ts +0 -40
  685. package/dist/types/entities/environment-template.js +0 -16
  686. package/dist/types/entities/environment-template.js.map +0 -1
  687. package/dist/types/entities/environment.d.ts +0 -38
  688. package/dist/types/entities/environment.js +0 -32
  689. package/dist/types/entities/environment.js.map +0 -1
  690. package/dist/types/entities/extension.d.ts +0 -103
  691. package/dist/types/entities/extension.js +0 -52
  692. package/dist/types/entities/extension.js.map +0 -1
  693. package/dist/types/entities/field-type.d.ts +0 -51
  694. package/dist/types/entities/function-log.d.ts +0 -46
  695. package/dist/types/entities/function-log.js +0 -24
  696. package/dist/types/entities/function-log.js.map +0 -1
  697. package/dist/types/entities/function.d.ts +0 -32
  698. package/dist/types/entities/function.js +0 -64
  699. package/dist/types/entities/function.js.map +0 -1
  700. package/dist/types/entities/index.d.ts +0 -127
  701. package/dist/types/entities/index.js +0 -117
  702. package/dist/types/entities/index.js.map +0 -1
  703. package/dist/types/entities/locale.d.ts +0 -95
  704. package/dist/types/entities/locale.js +0 -55
  705. package/dist/types/entities/locale.js.map +0 -1
  706. package/dist/types/entities/oauth-application.d.ts +0 -56
  707. package/dist/types/entities/oauth-application.js +0 -64
  708. package/dist/types/entities/oauth-application.js.map +0 -1
  709. package/dist/types/entities/organization-invitation.d.ts +0 -25
  710. package/dist/types/entities/organization-invitation.js +0 -16
  711. package/dist/types/entities/organization-invitation.js.map +0 -1
  712. package/dist/types/entities/organization-membership.d.ts +0 -69
  713. package/dist/types/entities/organization-membership.js +0 -51
  714. package/dist/types/entities/organization-membership.js.map +0 -1
  715. package/dist/types/entities/organization.d.ts +0 -33
  716. package/dist/types/entities/organization.js +0 -30
  717. package/dist/types/entities/organization.js.map +0 -1
  718. package/dist/types/entities/personal-access-token.d.ts +0 -51
  719. package/dist/types/entities/personal-access-token.js +0 -34
  720. package/dist/types/entities/personal-access-token.js.map +0 -1
  721. package/dist/types/entities/preview-api-key.d.ts +0 -20
  722. package/dist/types/entities/preview-api-key.js +0 -29
  723. package/dist/types/entities/preview-api-key.js.map +0 -1
  724. package/dist/types/entities/release-action.d.ts +0 -58
  725. package/dist/types/entities/release-action.js +0 -53
  726. package/dist/types/entities/release-action.js.map +0 -1
  727. package/dist/types/entities/release.d.ts +0 -142
  728. package/dist/types/entities/release.js +0 -107
  729. package/dist/types/entities/release.js.map +0 -1
  730. package/dist/types/entities/resource-provider.d.ts +0 -38
  731. package/dist/types/entities/resource-provider.js +0 -138
  732. package/dist/types/entities/resource-provider.js.map +0 -1
  733. package/dist/types/entities/resource-type.d.ts +0 -52
  734. package/dist/types/entities/resource-type.js +0 -95
  735. package/dist/types/entities/resource-type.js.map +0 -1
  736. package/dist/types/entities/resource.d.ts +0 -38
  737. package/dist/types/entities/resource.js +0 -11
  738. package/dist/types/entities/resource.js.map +0 -1
  739. package/dist/types/entities/role.d.ts +0 -85
  740. package/dist/types/entities/role.js +0 -51
  741. package/dist/types/entities/role.js.map +0 -1
  742. package/dist/types/entities/scheduled-action.d.ts +0 -112
  743. package/dist/types/entities/scheduled-action.js +0 -147
  744. package/dist/types/entities/scheduled-action.js.map +0 -1
  745. package/dist/types/entities/snapshot.d.ts +0 -24
  746. package/dist/types/entities/snapshot.js +0 -34
  747. package/dist/types/entities/snapshot.js.map +0 -1
  748. package/dist/types/entities/space-member.d.ts +0 -31
  749. package/dist/types/entities/space-member.js +0 -21
  750. package/dist/types/entities/space-member.js.map +0 -1
  751. package/dist/types/entities/space-membership.d.ts +0 -64
  752. package/dist/types/entities/space-membership.js +0 -51
  753. package/dist/types/entities/space-membership.js.map +0 -1
  754. package/dist/types/entities/space.d.ts +0 -31
  755. package/dist/types/entities/space.js +0 -31
  756. package/dist/types/entities/space.js.map +0 -1
  757. package/dist/types/entities/tag.d.ts +0 -51
  758. package/dist/types/entities/tag.js +0 -54
  759. package/dist/types/entities/tag.js.map +0 -1
  760. package/dist/types/entities/task.d.ts +0 -43
  761. package/dist/types/entities/task.js +0 -55
  762. package/dist/types/entities/task.js.map +0 -1
  763. package/dist/types/entities/team-membership.d.ts +0 -78
  764. package/dist/types/entities/team-membership.js +0 -52
  765. package/dist/types/entities/team-membership.js.map +0 -1
  766. package/dist/types/entities/team-space-membership.d.ts +0 -88
  767. package/dist/types/entities/team-space-membership.js +0 -51
  768. package/dist/types/entities/team-space-membership.js.map +0 -1
  769. package/dist/types/entities/team.d.ts +0 -73
  770. package/dist/types/entities/team.js +0 -51
  771. package/dist/types/entities/team.js.map +0 -1
  772. package/dist/types/entities/ui-config.d.ts +0 -59
  773. package/dist/types/entities/ui-config.js +0 -19
  774. package/dist/types/entities/ui-config.js.map +0 -1
  775. package/dist/types/entities/upload-credential.d.ts +0 -43
  776. package/dist/types/entities/upload.d.ts +0 -41
  777. package/dist/types/entities/upload.js +0 -37
  778. package/dist/types/entities/upload.js.map +0 -1
  779. package/dist/types/entities/usage.d.ts +0 -55
  780. package/dist/types/entities/usage.js +0 -23
  781. package/dist/types/entities/usage.js.map +0 -1
  782. package/dist/types/entities/user-ui-config.d.ts +0 -46
  783. package/dist/types/entities/user-ui-config.js +0 -19
  784. package/dist/types/entities/user-ui-config.js.map +0 -1
  785. package/dist/types/entities/user.d.ts +0 -57
  786. package/dist/types/entities/user.js +0 -26
  787. package/dist/types/entities/user.js.map +0 -1
  788. package/dist/types/entities/utils.d.ts +0 -5
  789. package/dist/types/entities/webhook.d.ts +0 -279
  790. package/dist/types/entities/webhook.js +0 -75
  791. package/dist/types/entities/webhook.js.map +0 -1
  792. package/dist/types/entities/widget-parameters.d.ts +0 -21
  793. package/dist/types/entities/workflow-definition.d.ts +0 -118
  794. package/dist/types/entities/workflow-definition.js +0 -29
  795. package/dist/types/entities/workflow-definition.js.map +0 -1
  796. package/dist/types/entities/workflow.d.ts +0 -64
  797. package/dist/types/entities/workflows-changelog-entry.d.ts +0 -33
  798. package/dist/types/export-types.d.ts +0 -78
  799. package/dist/types/index.d.ts +0 -66
  800. package/dist/types/index.js +0 -40
  801. package/dist/types/index.js.map +0 -1
  802. package/dist/types/methods/action.d.ts +0 -42
  803. package/dist/types/methods/action.js +0 -49
  804. package/dist/types/methods/action.js.map +0 -1
  805. package/dist/types/methods/content-type.d.ts +0 -5
  806. package/dist/types/methods/content-type.js +0 -47
  807. package/dist/types/methods/content-type.js.map +0 -1
  808. package/dist/types/methods/release-action.d.ts +0 -15
  809. package/dist/types/methods/utils.d.ts +0 -5
  810. package/dist/types/methods/utils.js +0 -10
  811. package/dist/types/methods/utils.js.map +0 -1
  812. package/dist/types/plain/as-iterator.d.ts +0 -5
  813. package/dist/types/plain/as-iterator.js +0 -37
  814. package/dist/types/plain/as-iterator.js.map +0 -1
  815. package/dist/types/plain/checks.d.ts +0 -13
  816. package/dist/types/plain/checks.js +0 -11
  817. package/dist/types/plain/checks.js.map +0 -1
  818. package/dist/types/plain/common-types.d.ts +0 -464
  819. package/dist/types/plain/entities/ai-action-invocation.d.ts +0 -18
  820. package/dist/types/plain/entities/ai-action.d.ts +0 -84
  821. package/dist/types/plain/entities/app-access-token.d.ts +0 -29
  822. package/dist/types/plain/entities/app-action-call.d.ts +0 -147
  823. package/dist/types/plain/entities/app-action.d.ts +0 -157
  824. package/dist/types/plain/entities/app-bundle.d.ts +0 -67
  825. package/dist/types/plain/entities/app-definition.d.ts +0 -100
  826. package/dist/types/plain/entities/app-details.d.ts +0 -56
  827. package/dist/types/plain/entities/app-event-subscription.d.ts +0 -75
  828. package/dist/types/plain/entities/app-installation.d.ts +0 -87
  829. package/dist/types/plain/entities/app-key.d.ts +0 -91
  830. package/dist/types/plain/entities/app-signed-request.d.ts +0 -34
  831. package/dist/types/plain/entities/app-signing-secret.d.ts +0 -49
  832. package/dist/types/plain/entities/app-upload.d.ts +0 -54
  833. package/dist/types/plain/entities/comment.d.ts +0 -198
  834. package/dist/types/plain/entities/concept-scheme.d.ts +0 -136
  835. package/dist/types/plain/entities/concept.d.ts +0 -164
  836. package/dist/types/plain/entities/editor-interface.d.ts +0 -67
  837. package/dist/types/plain/entities/environment-alias.d.ts +0 -99
  838. package/dist/types/plain/entities/environment.d.ts +0 -116
  839. package/dist/types/plain/entities/extension.d.ts +0 -157
  840. package/dist/types/plain/entities/function-log.d.ts +0 -51
  841. package/dist/types/plain/entities/function.d.ts +0 -51
  842. package/dist/types/plain/entities/locale.d.ts +0 -112
  843. package/dist/types/plain/entities/oauth-application.d.ts +0 -90
  844. package/dist/types/plain/entities/organization.d.ts +0 -33
  845. package/dist/types/plain/entities/resource-provider.d.ts +0 -59
  846. package/dist/types/plain/entities/resource-type.d.ts +0 -14
  847. package/dist/types/plain/entities/resource.d.ts +0 -40
  848. package/dist/types/plain/entities/role.d.ts +0 -206
  849. package/dist/types/plain/entities/space-member.d.ts +0 -32
  850. package/dist/types/plain/entities/space-membership.d.ts +0 -155
  851. package/dist/types/plain/entities/space.d.ts +0 -102
  852. package/dist/types/plain/entities/tag.d.ts +0 -103
  853. package/dist/types/plain/entities/task.d.ts +0 -114
  854. package/dist/types/plain/entities/team-membership.d.ts +0 -110
  855. package/dist/types/plain/entities/team-space-membership.d.ts +0 -127
  856. package/dist/types/plain/entities/team.d.ts +0 -105
  857. package/dist/types/plain/entities/ui-config.d.ts +0 -44
  858. package/dist/types/plain/entities/upload-credential.d.ts +0 -38
  859. package/dist/types/plain/entities/upload.d.ts +0 -56
  860. package/dist/types/plain/entities/usage.d.ts +0 -49
  861. package/dist/types/plain/entities/user-ui-config.d.ts +0 -44
  862. package/dist/types/plain/entities/user.d.ts +0 -80
  863. package/dist/types/plain/entities/webhook.d.ts +0 -186
  864. package/dist/types/plain/entities/workflow-definition.d.ts +0 -90
  865. package/dist/types/plain/entities/workflow.d.ts +0 -118
  866. package/dist/types/plain/entities/workflows-changelog.d.ts +0 -26
  867. package/dist/types/plain/pagination-helper.d.ts +0 -22
  868. package/dist/types/plain/pagination-helper.js +0 -68
  869. package/dist/types/plain/pagination-helper.js.map +0 -1
  870. package/dist/types/plain/plain-client.d.ts +0 -8
  871. package/dist/types/plain/plain-client.js +0 -564
  872. package/dist/types/plain/plain-client.js.map +0 -1
  873. package/dist/types/plain/wrappers/wrap.d.ts +0 -32
  874. package/dist/types/plain/wrappers/wrap.js +0 -25
  875. package/dist/types/plain/wrappers/wrap.js.map +0 -1
  876. package/dist/types/plain/wrappers/wrap.test-d.d.ts +0 -1
  877. package/dist/types/upload-http-client.d.ts +0 -9
  878. package/dist/types/upload-http-client.js +0 -15
  879. package/dist/types/upload-http-client.js.map +0 -1
@@ -1,1687 +0,0 @@
1
- import type { AcceptsQueryOptions, BasicCursorPaginationOptions, CreatedAtIntervalParams, CursorBasedParams, QueryOptions } from './common-types';
2
- import type { BasicQueryOptions, MakeRequest } from './common-types';
3
- import type { CreateAppInstallationProps } from './entities/app-installation';
4
- import type { CreateAppSignedRequestProps } from './entities/app-signed-request';
5
- import type { CreateAppActionCallProps, AppActionCallRawResponseProps } from './entities/app-action-call';
6
- import type { AssetFileProp, AssetProps, CreateAssetFromFilesOptions, CreateAssetProps } from './entities/asset';
7
- import type { CreateAssetKeyProps } from './entities/asset-key';
8
- import type { BulkAction, BulkActionPayload, BulkActionPublishPayload, BulkActionUnpublishPayload, BulkActionValidatePayload } from './entities/bulk-action';
9
- import type { ReleaseActionQueryOptions } from './entities/release-action';
10
- import type { ReleasePayload, ReleaseQueryOptions, ReleaseValidatePayload } from './entities/release';
11
- import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type';
12
- import type { CreateEntryProps, EntryProps, EntryReferenceOptionsProps, EntryReferenceProps } from './entities/entry';
13
- import type { CreateExtensionProps } from './entities/extension';
14
- import type { CreateLocaleProps } from './entities/locale';
15
- import type { TagVisibility } from './entities/tag';
16
- import type { CreateAppAccessTokenProps } from './entities/app-access-token';
17
- import type { ResourceQueryOptions } from './entities/resource';
18
- import type { AiActionInvocationType } from './entities/ai-action-invocation';
19
- /**
20
- * @private
21
- */
22
- export type ContentfulEnvironmentAPI = ReturnType<typeof createEnvironmentApi>;
23
- /**
24
- * Creates API object with methods to access the Environment API
25
- * @param {ContentfulEnvironmentAPI} makeRequest - function to make requests via an adapter
26
- * @return {ContentfulSpaceAPI}
27
- * @private
28
- */
29
- export default function createEnvironmentApi(makeRequest: MakeRequest): {
30
- /**
31
- * Deletes the environment
32
- * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
33
- * @example ```javascript
34
- * const contentful = require('contentful-management')
35
- *
36
- * const client = contentful.createClient({
37
- * accessToken: '<content_management_api_key>'
38
- * })
39
- *
40
- * client.getSpace('<space_id>')
41
- * .then((space) => space.getEnvironment('<environment-id>'))
42
- * .then((environment) => environment.delete())
43
- * .then(() => console.log('Environment deleted.'))
44
- * .catch(console.error)
45
- * ```
46
- */
47
- delete: () => Promise<void>;
48
- /**
49
- * Updates the environment
50
- * @return Promise for the updated environment.
51
- * @example ```javascript
52
- * const contentful = require('contentful-management')
53
- *
54
- * const client = contentful.createClient({
55
- * accessToken: '<content_management_api_key>'
56
- * })
57
- *
58
- * client.getSpace('<space_id>')
59
- * .then((space) => space.getEnvironment('<environment-id>'))
60
- * .then((environment) => {
61
- * environment.name = 'New name'
62
- * return environment.update()
63
- * })
64
- * .then((environment) => console.log(`Environment ${environment.sys.id} renamed.`)
65
- * .catch(console.error)
66
- * ```
67
- */
68
- update: () => Promise<import("./export-types").Environment>;
69
- /**
70
- * Creates SDK Entry object (locally) from entry data
71
- * @param entryData - Entry Data
72
- * @return Entry
73
- * @example ```javascript
74
- * environment.getEntry('entryId').then(entry => {
75
- *
76
- * // Build a plainObject in order to make it usable for React (saving in state or redux)
77
- * const plainObject = entry.toPlainObject();
78
- *
79
- * // The entry is being updated in some way as plainObject:
80
- * const updatedPlainObject = {
81
- * ...plainObject,
82
- * fields: {
83
- * ...plainObject.fields,
84
- * title: {
85
- * 'en-US': 'updatedTitle'
86
- * }
87
- * }
88
- * };
89
- *
90
- * // Rebuild an sdk object out of the updated plainObject:
91
- * const entryWithMethodsAgain = environment.getEntryFromData(updatedPlainObject);
92
- *
93
- * // Update with help of the sdk method:
94
- * entryWithMethodsAgain.update();
95
- *
96
- * });
97
- * ```
98
- **/
99
- getEntryFromData(entryData: EntryProps): import("./export-types").Entry;
100
- /**
101
- * Creates SDK Asset object (locally) from entry data
102
- * @param assetData - Asset ID
103
- * @return Asset
104
- * @example ```javascript
105
- * environment.getAsset('asset_id').then(asset => {
106
- *
107
- * // Build a plainObject in order to make it usable for React (saving in state or redux)
108
- * const plainObject = asset.toPlainObject();
109
- *
110
- * // The asset is being updated in some way as plainObject:
111
- * const updatedPlainObject = {
112
- * ...plainObject,
113
- * fields: {
114
- * ...plainObject.fields,
115
- * title: {
116
- * 'en-US': 'updatedTitle'
117
- * }
118
- * }
119
- * };
120
- *
121
- * // Rebuild an sdk object out of the updated plainObject:
122
- * const assetWithMethodsAgain = environment.getAssetFromData(updatedPlainObject);
123
- *
124
- * // Update with help of the sdk method:
125
- * assetWithMethodsAgain.update();
126
- *
127
- * });
128
- * ```
129
- */
130
- getAssetFromData(assetData: AssetProps): import("./export-types").Asset;
131
- /**
132
- *
133
- * @description Get a BulkAction by ID.
134
- * See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/bulk-action
135
- * @param bulkActionId - ID of the BulkAction to fetch
136
- * @returns - Promise with the BulkAction
137
- *
138
- * @example ```javascript
139
- * const contentful = require('contentful-management')
140
- *
141
- * const client = contentful.createClient({
142
- * accessToken: '<content_management_api_key>'
143
- * })
144
- *
145
- * client.getSpace('<space_id>')
146
- * .then((space) => space.getEnvironment('<environment_id>'))
147
- * .then((environment) => environment.getBulkAction('<bulk_action_id>'))
148
- * .then((bulkAction) => console.log(bulkAction))
149
- * ```
150
- */
151
- getBulkAction<T extends BulkActionPayload = any>(bulkActionId: string): Promise<BulkAction<T>>;
152
- /**
153
- * @description Creates a BulkAction that will attempt to publish all items contained in the payload.
154
- * See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/publish-bulk-action
155
- * @param {BulkActionPayload} payload - Object containing the items to be processed in the bulkAction
156
- * @returns - Promise with the BulkAction
157
- *
158
- * @example
159
- *
160
- * ```javascript
161
- * const contentful = require('contentful-management')
162
- *
163
- * const client = contentful.createClient({
164
- * accessToken: '<content_management_api_key>'
165
- * })
166
- *
167
- * const payload = {
168
- * entities: {
169
- * sys: { type: 'Array' }
170
- * items: [
171
- * { sys: { type: 'Link', id: '<entry-id>', linkType: 'Entry', version: 2 } }
172
- * ]
173
- * }
174
- * }
175
- *
176
- * // Using Thenables
177
- * client.getSpace('<space_id>')
178
- * .then((space) => space.getEnvironment('<environment_id>'))
179
- * .then((environment) => environment.createPublishBulkAction(payload))
180
- * .then((bulkAction) => console.log(bulkAction.waitProcessing()))
181
- * .catch(console.error)
182
- *
183
- * // Using async/await
184
- * try {
185
- * const space = await client.getSpace('<space_id>')
186
- * const environment = await space.getEnvironment('<environment_id>')
187
- * const bulkActionInProgress = await environment.createPublishBulkAction(payload)
188
- *
189
- * // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
190
- * const bulkActionCompleted = await bulkActionInProgress.waitProcessing()
191
- * console.log(bulkActionCompleted)
192
- * } catch (error) {
193
- * console.log(error)
194
- * }
195
- * ```
196
- */
197
- createPublishBulkAction(payload: BulkActionPublishPayload): Promise<BulkAction<BulkActionPublishPayload>>;
198
- /**
199
- * @description Creates a BulkAction that will attempt to validate all items contained in the payload.
200
- * See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/validate-bulk-action
201
- * @param {BulkActionPayload} payload - Object containing the items to be processed in the bulkAction
202
- * @returns - Promise with the BulkAction
203
- *
204
- * @example
205
- *
206
- * ```javascript
207
- * const contentful = require('contentful-management')
208
- *
209
- * const client = contentful.createClient({
210
- * accessToken: '<content_management_api_key>'
211
- * })
212
- *
213
- * const payload = {
214
- * action: 'publish',
215
- * entities: {
216
- * sys: { type: 'Array' }
217
- * items: [
218
- * { sys: { type: 'Link', id: '<entry-id>', linkType: 'Entry' } }
219
- * ]
220
- * }
221
- * }
222
- *
223
- * // Using Thenables
224
- * client.getSpace('<space_id>')
225
- * .then((space) => space.getEnvironment('<environment_id>'))
226
- * .then((environment) => environment.createValidateBulkAction(payload))
227
- * .then((bulkAction) => console.log(bulkAction.waitProcessing()))
228
- * .catch(console.error)
229
- *
230
- * // Using async/await
231
- * try {
232
- * const space = await client.getSpace('<space_id>')
233
- * const environment = await space.getEnvironment('<environment_id>')
234
- * const bulkActionInProgress = await environment.createValidateBulkAction(payload)
235
- *
236
- * // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
237
- * const bulkActionCompleted = await bulkActionInProgress.waitProcessing()
238
- * console.log(bulkActionCompleted)
239
- * } catch (error) {
240
- * console.log(error)
241
- * }
242
- * ```
243
- */
244
- createValidateBulkAction(payload: BulkActionValidatePayload): Promise<BulkAction<BulkActionValidatePayload>>;
245
- /**
246
- * @description Creates a BulkAction that will attempt to unpublish all items contained in the payload.
247
- * See: https://www.contentful.com/developers/docs/references/content-management-api/#/reference/bulk-actions/unpublish-bulk-action
248
- * @param {BulkActionPayload} payload - Object containing the items to be processed in the bulkAction
249
- * @returns - Promise with the BulkAction
250
- *
251
- * @example
252
- *
253
- * ```javascript
254
- * const contentful = require('contentful-management')
255
- *
256
- * const client = contentful.createClient({
257
- * accessToken: '<content_management_api_key>'
258
- * })
259
- *
260
- * const payload = {
261
- * entities: {
262
- * sys: { type: 'Array' }
263
- * items: [
264
- * { sys: { type: 'Link', id: 'entry-id', linkType: 'Entry' } }
265
- * ]
266
- * }
267
- * }
268
- *
269
- * // Using Thenables
270
- * client.getSpace('<space_id>')
271
- * .then((space) => space.getEnvironment('<environment_id>'))
272
- * .then((environment) => environment.createUnpublishBulkAction(payload))
273
- * .then((bulkAction) => console.log(bulkAction.waitProcessing()))
274
- * .catch(console.error)
275
- *
276
- * // Using async/await
277
- * try {
278
- * const space = await clientgetSpace('<space_id>')
279
- * const environment = await space.getEnvironment('<environment_id>')
280
- * const bulkActionInProgress = await environment.createUnpublishBulkAction(payload)
281
- *
282
- * // You can wait for a recently created BulkAction to be processed by using `bulkAction.waitProcessing()`
283
- * const bulkActionCompleted = await bulkActionInProgress.waitProcessing()
284
- * console.log(bulkActionCompleted)
285
- * } catch (error) {
286
- * console.log(error)
287
- * }
288
- * ```
289
- */
290
- createUnpublishBulkAction(payload: BulkActionUnpublishPayload): Promise<BulkAction<BulkActionUnpublishPayload>>;
291
- /**
292
- * Gets a Content Type
293
- * @param contentTypeId - Content Type ID
294
- * @return Promise for a Content Type
295
- * @example ```javascript
296
- * const contentful = require('contentful-management')
297
- *
298
- * const client = contentful.createClient({
299
- * accessToken: '<content_management_api_key>'
300
- * })
301
- *
302
- * client.getSpace('<space_id>')
303
- * .then((space) => space.getEnvironment('<environment-id>'))
304
- * .then((environment) => environment.getContentType('<content_type_id>'))
305
- * .then((contentType) => console.log(contentType))
306
- * .catch(console.error)
307
- * ```
308
- */
309
- getContentType(contentTypeId: string): Promise<import("./export-types").ContentType>;
310
- /**
311
- * Gets a collection of Content Types
312
- * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
313
- * @return Promise for a collection of Content Types
314
- * @example ```javascript
315
- * const contentful = require('contentful-management')
316
- *
317
- * const client = contentful.createClient({
318
- * accessToken: '<content_management_api_key>'
319
- * })
320
- *
321
- * client.getSpace('<space_id>')
322
- * .then((space) => space.getEnvironment('<environment-id>'))
323
- * .then((environment) => environment.getContentTypes())
324
- * .then((response) => console.log(response.items))
325
- * .catch(console.error)
326
- * ```
327
- */
328
- getContentTypes(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").ContentType, ContentTypeProps>>;
329
- /**
330
- * Creates a Content Type
331
- * @param data - Object representation of the Content Type to be created
332
- * @return Promise for the newly created Content Type
333
- * @example ```javascript
334
- * const contentful = require('contentful-management')
335
- *
336
- * const client = contentful.createClient({
337
- * accessToken: '<content_management_api_key>'
338
- * })
339
- *
340
- * client.getSpace('<space_id>')
341
- * .then((space) => space.getEnvironment('<environment-id>'))
342
- * .then((environment) => environment.createContentType({
343
- * name: 'Blog Post',
344
- * fields: [
345
- * {
346
- * id: 'title',
347
- * name: 'Title',
348
- * required: true,
349
- * localized: false,
350
- * type: 'Text'
351
- * }
352
- * ]
353
- * }))
354
- * .then((contentType) => console.log(contentType))
355
- * .catch(console.error)
356
- * ```
357
- */
358
- createContentType(data: CreateContentTypeProps): Promise<import("./export-types").ContentType>;
359
- /**
360
- * Creates a Content Type with a custom ID
361
- * @param contentTypeId - Content Type ID
362
- * @param data - Object representation of the Content Type to be created
363
- * @return Promise for the newly created Content Type
364
- * @example ```javascript
365
- * const contentful = require('contentful-management')
366
- *
367
- * const client = contentful.createClient({
368
- * accessToken: '<content_management_api_key>'
369
- * })
370
- *
371
- * client.getSpace('<space_id>')
372
- * .then((space) => space.getEnvironment('<environment-id>'))
373
- * .then((environment) => environment.createContentTypeWithId('<content-type-id>', {
374
- * name: 'Blog Post',
375
- * fields: [
376
- * {
377
- * id: 'title',
378
- * name: 'Title',
379
- * required: true,
380
- * localized: false,
381
- * type: 'Text'
382
- * }
383
- * ]
384
- * }))
385
- * .then((contentType) => console.log(contentType))
386
- * .catch(console.error)
387
- * ```
388
- */
389
- createContentTypeWithId(contentTypeId: string, data: CreateContentTypeProps): Promise<import("./export-types").ContentType>;
390
- /**
391
- * Gets an EditorInterface for a ContentType
392
- * @param contentTypeId - Content Type ID
393
- * @return Promise for an EditorInterface
394
- * @example ```javascript
395
- * const contentful = require('contentful-management')
396
- *
397
- * const client = contentful.createClient({
398
- * accessToken: '<content_management_api_key>'
399
- * })
400
- *
401
- * client.getSpace('<space_id>')
402
- * .then((space) => space.getEnvironment('<environment-id>'))
403
- * .then((environment) => environment.getEditorInterfaceForContentType('<content_type_id>'))
404
- * .then((EditorInterface) => console.log(EditorInterface))
405
- * .catch(console.error)
406
- * ```
407
- */
408
- getEditorInterfaceForContentType(contentTypeId: string): Promise<import("./export-types").EditorInterface>;
409
- /**
410
- * Gets all EditorInterfaces
411
- * @return Promise for a collection of EditorInterface
412
- * @example ```javascript
413
- * const contentful = require('contentful-management')
414
- *
415
- * const client = contentful.createClient({
416
- * accessToken: '<content_management_api_key>'
417
- * })
418
- *
419
- * client.getSpace('<space_id>')
420
- * .then((space) => space.getEnvironment('<environment-id>'))
421
- * .then((environment) => environment.getEditorInterfaces())
422
- * .then((response) => console.log(response.items))
423
- * .catch(console.error)
424
- * ```
425
- */
426
- getEditorInterfaces(): Promise<import("./common-types").Collection<import("./export-types").EditorInterface, import("./export-types").EditorInterfaceProps>>;
427
- /**
428
- * Gets an Entry
429
- * Warning: if you are using the select operator, when saving, any field that was not selected will be removed
430
- * from your entry in the backend
431
- * @param id - Entry ID
432
- * @param query - Object with search parameters. In this method it's only useful for `locale`.
433
- * @return Promise for an Entry
434
- * @example ```javascript
435
- * const contentful = require('contentful-management')
436
- *
437
- * const client = contentful.createClient({
438
- * accessToken: '<content_management_api_key>'
439
- * })
440
- *
441
- * client.getSpace('<space_id>')
442
- * .then((space) => space.getEnvironment('<environment-id>'))
443
- * .then((environment) => environment.getEntry('<entry-id>'))
444
- * .then((entry) => console.log(entry))
445
- * .catch(console.error)
446
- * ```
447
- */
448
- getEntry(id: string, query?: QueryOptions): Promise<import("./export-types").Entry>;
449
- /**
450
- * Deletes an Entry of this environment
451
- * @param id - Entry ID
452
- * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
453
- * @example ```javascript
454
- * const contentful = require('contentful-management')
455
- *
456
- * const client = contentful.createClient({
457
- * accessToken: '<content_management_api_key>'
458
- * })
459
- *
460
- * client.getSpace('<space_id>')
461
- * .then((space) => space.getEnvironment('<environment-id>'))
462
- * .then((environment) => environment.deleteEntry("4bmLXiuviAZH3jkj5DLRWE"))
463
- * .then(() => console.log('Entry deleted.'))
464
- * .catch(console.error)
465
- * ```
466
- */
467
- deleteEntry(id: string): Promise<void>;
468
- /**
469
- * Gets a collection of Entries
470
- * Warning: if you are using the select operator, when saving, any field that was not selected will be removed
471
- * from your entry in the backend
472
- * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
473
- * @return Promise for a collection of Entries
474
- * @example ```javascript
475
- * const contentful = require('contentful-management')
476
- *
477
- * const client = contentful.createClient({
478
- * accessToken: '<content_management_api_key>'
479
- * })
480
- *
481
- * client.getSpace('<space_id>')
482
- * .then((space) => space.getEnvironment('<environment-id>'))
483
- * .then((environment) => environment.getEntries({'content_type': 'foo'})) // you can add more queries as 'key': 'value'
484
- * .then((response) => console.log(response.items))
485
- * .catch(console.error)
486
- * ```
487
- */
488
- getEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
489
- /**
490
- * Gets a collection of published Entries
491
- * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
492
- * @return Promise for a collection of published Entries
493
- * @example ```javascript
494
- * const contentful = require('contentful-management')
495
- *
496
- * const client = contentful.createClient({
497
- * accessToken: '<content_management_api_key>'
498
- * })
499
- *
500
- * client.getSpace('<space_id>')
501
- * .then((space) => space.getEnvironment('<environment-id>'))
502
- * .then((environment) => environment.getPublishedEntries({'content_type': 'foo'})) // you can add more queries as 'key': 'value'
503
- * .then((response) => console.log(response.items))
504
- * .catch(console.error)
505
- * ```
506
- */
507
- getPublishedEntries(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Entry, EntryProps<import("./common-types").KeyValueMap, unknown>>>;
508
- /**
509
- * Creates a Entry
510
- * @param contentTypeId - The Content Type ID of the newly created Entry
511
- * @param data - Object representation of the Entry to be created
512
- * @return Promise for the newly created Entry
513
- * @example ```javascript
514
- * const contentful = require('contentful-management')
515
- *
516
- * const client = contentful.createClient({
517
- * accessToken: '<content_management_api_key>'
518
- * })
519
- *
520
- * client.getSpace('<space_id>')
521
- * .then((space) => space.getEnvironment('<environment-id>'))
522
- * .then((environment) => environment.createEntry('<content_type_id>', {
523
- * fields: {
524
- * title: {
525
- * 'en-US': 'Entry title'
526
- * }
527
- * }
528
- * }))
529
- * .then((entry) => console.log(entry))
530
- * .catch(console.error)
531
- * ```
532
- */
533
- createEntry(contentTypeId: string, data: Omit<EntryProps, "sys">): Promise<import("./export-types").Entry>;
534
- /**
535
- * Creates a Entry with a custom ID
536
- * @param contentTypeId - The Content Type of the newly created Entry
537
- * @param id - Entry ID
538
- * @param data - Object representation of the Entry to be created
539
- * @return Promise for the newly created Entry
540
- * @example ```javascript
541
- * const contentful = require('contentful-management')
542
- *
543
- * const client = contentful.createClient({
544
- * accessToken: '<content_management_api_key>'
545
- * })
546
- *
547
- * // Create entry
548
- * client.getSpace('<space_id>')
549
- * .then((space) => space.getEnvironment('<environment-id>'))
550
- * .then((environment) => environment.createEntryWithId('<content_type_id>', '<entry_id>', {
551
- * fields: {
552
- * title: {
553
- * 'en-US': 'Entry title'
554
- * }
555
- * }
556
- * }))
557
- * .then((entry) => console.log(entry))
558
- * .catch(console.error)
559
- * ```
560
- */
561
- createEntryWithId(contentTypeId: string, id: string, data: CreateEntryProps): Promise<import("./export-types").Entry>;
562
- /**
563
- * Get entry references
564
- * @param entryId - Entry ID
565
- * @param {Object} options.include - Level of the entry descendants from 1 up to 10 maximum
566
- * @returns Promise of Entry references
567
- * @example ```javascript
568
- * const contentful = require('contentful-management');
569
- *
570
- * const client = contentful.createClient({
571
- * accessToken: '<contentful_management_api_key>
572
- * })
573
- *
574
- * // Get entry references
575
- * client.getSpace('<space_id>')
576
- * .then((space) => space.getEnvironment('<environment_id>'))
577
- * .then((environment) => environment.getEntryReferences('<entry_id>', {include: number}))
578
- * .then((entry) => console.log(entry.includes))
579
- * // or
580
- * .then((environment) => environment.getEntry('<entry_id>')).then((entry) => entry.references({include: number}))
581
- * .catch(console.error)
582
- * ```
583
- */
584
- getEntryReferences(entryId: string, options?: EntryReferenceOptionsProps): Promise<EntryReferenceProps>;
585
- /**
586
- * Gets an Asset
587
- * Warning: if you are using the select operator, when saving, any field that was not selected will be removed
588
- * from your entry in the backend
589
- * @param id - Asset ID
590
- * @param query - Object with search parameters. In this method it's only useful for `locale`.
591
- * @return Promise for an Asset
592
- * @example ```javascript
593
- * const contentful = require('contentful-management')
594
- *
595
- * const client = contentful.createClient({
596
- * accessToken: '<content_management_api_key>'
597
- * })
598
- *
599
- * client.getSpace('<space_id>')
600
- * .then((space) => space.getEnvironment('<environment-id>'))
601
- * .then((environment) => environment.getAsset('<asset_id>'))
602
- * .then((asset) => console.log(asset))
603
- * .catch(console.error)
604
- * ```
605
- */
606
- getAsset(id: string, query?: QueryOptions): Promise<import("./export-types").Asset>;
607
- /**
608
- * Gets a collection of Assets
609
- * Warning: if you are using the select operator, when saving, any field that was not selected will be removed
610
- * from your entry in the backend
611
- * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
612
- * @return Promise for a collection of Assets
613
- * @example ```javascript
614
- * const contentful = require('contentful-management')
615
- *
616
- * const client = contentful.createClient({
617
- * accessToken: '<content_management_api_key>'
618
- * })
619
- *
620
- * client.getSpace('<space_id>')
621
- * .then((space) => space.getEnvironment('<environment-id>'))
622
- * .then((environment) => environment.getAssets())
623
- * .then((response) => console.log(response.items))
624
- * .catch(console.error)
625
- * ```
626
- */
627
- getAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Asset, AssetProps<{}>>>;
628
- /**
629
- * Gets a collection of published Assets
630
- * @param query - Object with search parameters. Check the <a href="https://www.contentful.com/developers/docs/javascript/tutorials/using-js-cda-sdk/#retrieving-entries-with-search-parameters">JS SDK tutorial</a> and the <a href="https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters">REST API reference</a> for more details.
631
- * @return Promise for a collection of published Assets
632
- * @example ```javascript
633
- * const contentful = require('contentful-management')
634
- *
635
- * const client = contentful.createClient({
636
- * accessToken: '<content_management_api_key>'
637
- * })
638
- *
639
- * client.getSpace('<space_id>')
640
- * .then((space) => space.getEnvironment('<environment-id>'))
641
- * .then((environment) => environment.getPublishedAssets())
642
- * .then((response) => console.log(response.items))
643
- * .catch(console.error)
644
- * ```
645
- */
646
- getPublishedAssets(query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Asset, AssetProps<{}>>>;
647
- /**
648
- * Creates a Asset. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
649
- * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.
650
- * @return Promise for the newly created Asset
651
- * @example ```javascript
652
- * const client = contentful.createClient({
653
- * accessToken: '<content_management_api_key>'
654
- * })
655
- *
656
- * // Create asset
657
- * client.getSpace('<space_id>')
658
- * .then((space) => space.getEnvironment('<environment-id>'))
659
- * .then((environment) => environment.createAsset({
660
- * fields: {
661
- * title: {
662
- * 'en-US': 'Playsam Streamliner'
663
- * },
664
- * file: {
665
- * 'en-US': {
666
- * contentType: 'image/jpeg',
667
- * fileName: 'example.jpeg',
668
- * upload: 'https://example.com/example.jpg'
669
- * }
670
- * }
671
- * }
672
- * }))
673
- * .then((asset) => asset.processForLocale("en-US")) // OR asset.processForAllLocales()
674
- * .then((asset) => console.log(asset))
675
- * .catch(console.error)
676
- * ```
677
- */
678
- createAsset(data: CreateAssetProps): Promise<import("./export-types").Asset>;
679
- /**
680
- * Creates a Asset with a custom ID. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
681
- * @param id - Asset ID
682
- * @param data - Object representation of the Asset to be created. Note that the field object should have an upload property on asset creation, which will be removed and replaced with an url property when processing is finished.
683
- * @return Promise for the newly created Asset
684
- * @example ```javascript
685
- * const client = contentful.createClient({
686
- * accessToken: '<content_management_api_key>'
687
- * })
688
- *
689
- * // Create asset
690
- * client.getSpace('<space_id>')
691
- * .then((space) => space.getEnvironment('<environment-id>'))
692
- * .then((environment) => environment.createAssetWithId('<asset_id>', {
693
- * title: {
694
- * 'en-US': 'Playsam Streamliner'
695
- * },
696
- * file: {
697
- * 'en-US': {
698
- * contentType: 'image/jpeg',
699
- * fileName: 'example.jpeg',
700
- * upload: 'https://example.com/example.jpg'
701
- * }
702
- * }
703
- * }))
704
- * .then((asset) => asset.process())
705
- * .then((asset) => console.log(asset))
706
- * .catch(console.error)
707
- * ```
708
- */
709
- createAssetWithId(id: string, data: CreateAssetProps): Promise<import("./export-types").Asset>;
710
- /**
711
- * Creates a Asset based on files. After creation, call asset.processForLocale or asset.processForAllLocales to start asset processing.
712
- * @param data - Object representation of the Asset to be created. Note that the field object should have an uploadFrom property on asset creation, which will be removed and replaced with an url property when processing is finished.
713
- * @param data.fields.file.[LOCALE].file - Can be a string, an ArrayBuffer or a Stream.
714
- * @return Promise for the newly created Asset
715
- * @example ```javascript
716
- * const client = contentful.createClient({
717
- * accessToken: '<content_management_api_key>'
718
- * })
719
- *
720
- * client.getSpace('<space_id>')
721
- * .then((space) => space.getEnvironment('<environment-id>'))
722
- * .then((environment) => environment.createAssetFromFiles({
723
- * fields: {
724
- * file: {
725
- * 'en-US': {
726
- * contentType: 'image/jpeg',
727
- * fileName: 'filename_english.jpg',
728
- * file: createReadStream('path/to/filename_english.jpg')
729
- * },
730
- * 'de-DE': {
731
- * contentType: 'image/svg+xml',
732
- * fileName: 'filename_german.svg',
733
- * file: '<svg><path fill="red" d="M50 50h150v50H50z"/></svg>'
734
- * }
735
- * }
736
- * }
737
- * }))
738
- * .then((asset) => console.log(asset))
739
- * .catch(console.error)
740
- * ```
741
- */
742
- createAssetFromFiles(data: Omit<AssetFileProp, "sys">, options?: CreateAssetFromFilesOptions): Promise<import("./export-types").Asset>;
743
- /**
744
- * Creates an asset key for signing asset URLs (Embargoed Assets)
745
- * @param data Object with request payload
746
- * @param data.expiresAt number a UNIX timestamp in the future (but not more than 48 hours from time of calling)
747
- * @return Promise for the newly created AssetKey
748
- * @example ```javascript
749
- * const client = contentful.createClient({
750
- * accessToken: '<content_management_api_key>'
751
- * })
752
- *
753
- * // Create assetKey
754
- * now = () => Math.floor(Date.now() / 1000)
755
- * const withExpiryIn1Hour = () => now() + 1 * 60 * 60
756
- * client.getSpace('<space_id>')
757
- * .then((space) => space.getEnvironment('<environment-id>'))
758
- * .then((environment) => environment.createAssetKey({ expiresAt: withExpiryIn1Hour() }))
759
- * .then((policy, secret) => console.log({ policy, secret }))
760
- * .catch(console.error)
761
- * ```
762
- */
763
- createAssetKey(payload: CreateAssetKeyProps): Promise<import("./export-types").AssetKey>;
764
- /**
765
- * Gets an Upload
766
- * @param id - Upload ID
767
- * @return Promise for an Upload
768
- * @example ```javascript
769
- * const client = contentful.createClient({
770
- * accessToken: '<content_management_api_key>'
771
- * })
772
- * const uploadStream = createReadStream('path/to/filename_english.jpg')
773
- *
774
- * client.getSpace('<space_id>')
775
- * .then((space) => space.getEnvironment('<environment-id>'))
776
- * .then((environment) => environment.getUpload('<upload-id>')
777
- * .then((upload) => console.log(upload))
778
- * .catch(console.error)
779
- */
780
- getUpload(id: string): Promise<{
781
- delete: () => Promise<void>;
782
- } & import("./export-types").UploadProps & {
783
- toPlainObject(): import("./export-types").UploadProps;
784
- }>;
785
- /**
786
- * Creates a Upload.
787
- * @param data - Object with file information.
788
- * @param data.file - Actual file content. Can be a string, an ArrayBuffer or a Stream.
789
- * @return Upload object containing information about the uploaded file.
790
- * @example ```javascript
791
- * const client = contentful.createClient({
792
- * accessToken: '<content_management_api_key>'
793
- * })
794
- * const uploadStream = createReadStream('path/to/filename_english.jpg')
795
- *
796
- * client.getSpace('<space_id>')
797
- * .then((space) => space.getEnvironment('<environment-id>'))
798
- * .then((environment) => environment.createUpload({file: uploadStream})
799
- * .then((upload) => console.log(upload))
800
- * .catch(console.error)
801
- * ```
802
- */
803
- createUpload: (data: {
804
- file: string | ArrayBuffer | ReadableStream;
805
- }) => Promise<{
806
- delete: () => Promise<void>;
807
- } & import("./export-types").UploadProps & {
808
- toPlainObject(): import("./export-types").UploadProps;
809
- }>;
810
- /**
811
- * Gets a Locale
812
- * @param localeId - Locale ID
813
- * @return Promise for an Locale
814
- * @example ```javascript
815
- * const contentful = require('contentful-management')
816
- *
817
- * const client = contentful.createClient({
818
- * accessToken: '<content_management_api_key>'
819
- * })
820
- *
821
- * client.getSpace('<space_id>')
822
- * .then((space) => space.getEnvironment('<environment-id>'))
823
- * .then((environment) => environment.getLocale('<locale_id>'))
824
- * .then((locale) => console.log(locale))
825
- * .catch(console.error)
826
- * ```
827
- */
828
- getLocale(localeId: string): Promise<import("./export-types").Locale>;
829
- /**
830
- * Gets a collection of Locales
831
- * @return Promise for a collection of Locales
832
- * @example ```javascript
833
- * const contentful = require('contentful-management')
834
- *
835
- * const client = contentful.createClient({
836
- * accessToken: '<content_management_api_key>'
837
- * })
838
- *
839
- * client.getSpace('<space_id>')
840
- * .then((space) => space.getEnvironment('<environment-id>'))
841
- * .then((environment) => environment.getLocales())
842
- * .then((response) => console.log(response.items))
843
- * .catch(console.error)
844
- * ```
845
- */
846
- getLocales(query?: BasicQueryOptions): Promise<import("./common-types").Collection<import("./export-types").Locale, import("./export-types").LocaleProps>>;
847
- /**
848
- * Creates a Locale
849
- * @param data - Object representation of the Locale to be created
850
- * @return Promise for the newly created Locale
851
- * @example ```javascript
852
- * const contentful = require('contentful-management')
853
- *
854
- * const client = contentful.createClient({
855
- * accessToken: '<content_management_api_key>'
856
- * })
857
- *
858
- * // Create locale
859
- * client.getSpace('<space_id>')
860
- * .then((space) => space.getEnvironment('<environment-id>'))
861
- * .then((environment) => environment.createLocale({
862
- * name: 'German (Austria)',
863
- * code: 'de-AT',
864
- * fallbackCode: 'de-DE',
865
- * optional: true
866
- * }))
867
- * .then((locale) => console.log(locale))
868
- * .catch(console.error)
869
- * ```
870
- */
871
- createLocale(data: CreateLocaleProps): Promise<import("./export-types").Locale>;
872
- /**
873
- * Gets an UI Extension
874
- * @param id - Extension ID
875
- * @return Promise for an UI Extension
876
- * @example ```javascript
877
- * const contentful = require('contentful-management')
878
- *
879
- * const client = contentful.createClient({
880
- * accessToken: '<content_management_api_key>'
881
- * })
882
- *
883
- * client.getSpace('<space_id>')
884
- * .then((space) => space.getEnvironment('<environment-id>'))
885
- * .then((environment) => environment.getUiExtension('<extension-id>'))
886
- * .then((extension) => console.log(extension))
887
- * .catch(console.error)
888
- * ```
889
- */
890
- getUiExtension(id: string): Promise<import("./export-types").UIExtension>;
891
- /**
892
- * Gets a collection of UI Extension
893
- * @return Promise for a collection of UI Extensions
894
- * @example ```javascript
895
- * const contentful = require('contentful-management')
896
- *
897
- * const client = contentful.createClient({
898
- * accessToken: '<content_management_api_key>'
899
- * })
900
- *
901
- * client.getSpace('<space_id>')
902
- * .then((space) => space.getEnvironment('<environment-id>'))
903
- * .then((environment) => environment.getUiExtensions()
904
- * .then((response) => console.log(response.items))
905
- * .catch(console.error)
906
- * ```
907
- */
908
- getUiExtensions(): Promise<import("./common-types").Collection<import("./export-types").UIExtension, import("./export-types").UIExtensionProps>>;
909
- /**
910
- * Creates a UI Extension
911
- * @param data - Object representation of the UI Extension to be created
912
- * @return Promise for the newly created UI Extension
913
- * @example ```javascript
914
- * const contentful = require('contentful-management')
915
- *
916
- * const client = contentful.createClient({
917
- * accessToken: '<content_management_api_key>'
918
- * })
919
- *
920
- * client.getSpace('<space_id>')
921
- * .then((space) => space.getEnvironment('<environment-id>'))
922
- * .then((environment) => environment.createUiExtension({
923
- * extension: {
924
- * name: 'My awesome extension',
925
- * src: 'https://example.com/my',
926
- * fieldTypes: [
927
- * {
928
- * type: 'Symbol'
929
- * },
930
- * {
931
- * type: 'Text'
932
- * }
933
- * ],
934
- * sidebar: false
935
- * }
936
- * }))
937
- * .then((extension) => console.log(extension))
938
- * .catch(console.error)
939
- * ```
940
- */
941
- createUiExtension(data: CreateExtensionProps): Promise<import("./export-types").UIExtension>;
942
- /**
943
- * Creates a UI Extension with a custom ID
944
- * @param id - Extension ID
945
- * @param data - Object representation of the UI Extension to be created
946
- * @return Promise for the newly created UI Extension
947
- * @example ```javascript
948
- * const contentful = require('contentful-management')
949
- *
950
- * const client = contentful.createClient({
951
- * accessToken: '<content_management_api_key>'
952
- * })
953
- *
954
- * client.getSpace('<space_id>')
955
- * .then((space) => space.getEnvironment('<environment-id>'))
956
- * .then((environment) => environment.createUiExtensionWithId('<extension_id>', {
957
- * extension: {
958
- * name: 'My awesome extension',
959
- * src: 'https://example.com/my',
960
- * fieldTypes: [
961
- * {
962
- * type: 'Symbol'
963
- * },
964
- * {
965
- * type: 'Text'
966
- * }
967
- * ],
968
- * sidebar: false
969
- * }
970
- * }))
971
- * .then((extension) => console.log(extension))
972
- * .catch(console.error)
973
- * ```
974
- */
975
- createUiExtensionWithId(id: string, data: CreateExtensionProps): Promise<import("./export-types").UIExtension>;
976
- /**
977
- * Creates an App Installation
978
- * @param appDefinitionId - AppDefinition ID
979
- * @param data - AppInstallation data
980
- * @param options.acceptAllTerms - Flag for accepting Apps' Marketplace EULA, Terms, and Privacy policy (need to pass `{acceptAllTerms: true}` to install a marketplace app)
981
- * @return Promise for an App Installation
982
- * @example ```javascript
983
- * const contentful = require('contentful-management')
984
- *
985
- * const client = contentful.createClient({
986
- * accessToken: '<content_management_api_key>'
987
- * })
988
- *
989
- * client.getSpace('<space_id>')
990
- * .then((space) => space.getEnvironment('<environment-id>'))
991
- * .then((environment) => environment.createAppInstallation('<app_definition_id>', {
992
- * parameters: {
993
- * someParameter: someValue
994
- * }
995
- * })
996
- * .then((appInstallation) => console.log(appInstallation))
997
- * .catch(console.error)
998
- * ```
999
- */
1000
- createAppInstallation(appDefinitionId: string, data: CreateAppInstallationProps, { acceptAllTerms }?: {
1001
- acceptAllTerms?: boolean;
1002
- }): Promise<import("./export-types").AppInstallation>;
1003
- /**
1004
- * Gets an App Installation
1005
- * @param id - AppDefinition ID
1006
- * @return Promise for an App Installation
1007
- * @example ```javascript
1008
- * const contentful = require('contentful-management')
1009
- *
1010
- * const client = contentful.createClient({
1011
- * accessToken: '<content_management_api_key>'
1012
- * })
1013
- *
1014
- * client.getSpace('<space_id>')
1015
- * .then((space) => space.getEnvironment('<environment-id>'))
1016
- * .then((environment) => environment.getAppInstallation('<app-definition-id>'))
1017
- * .then((appInstallation) => console.log(appInstallation))
1018
- * .catch(console.error)
1019
- * ```
1020
- */
1021
- getAppInstallation(id: string): Promise<import("./export-types").AppInstallation>;
1022
- /**
1023
- * Gets a collection of App Installation
1024
- * @return Promise for a collection of App Installations
1025
- * @example ```javascript
1026
- * const contentful = require('contentful-management')
1027
- *
1028
- * const client = contentful.createClient({
1029
- * accessToken: '<content_management_api_key>'
1030
- * })
1031
- *
1032
- * client.getSpace('<space_id>')
1033
- * .then((space) => space.getEnvironment('<environment-id>'))
1034
- * .then((environment) => environment.getAppInstallations()
1035
- * .then((response) => console.log(response.items))
1036
- * .catch(console.error)
1037
- * ```
1038
- */
1039
- getAppInstallations(): Promise<import("./common-types").Collection<import("./export-types").AppInstallation, import("./export-types").AppInstallationProps>>;
1040
- /**
1041
- * Creates an app action call
1042
- * @param appDefinitionId - AppDefinition ID
1043
- * @param appActionId - action ID
1044
- * @param data - App Action Call data
1045
- * @return Promise for an App Action Call
1046
- * @example ```javascript
1047
- * const contentful = require('contentful-management')
1048
- *
1049
- * const client = contentful.createClient({
1050
- * accessToken: '<content_management_api_key>'
1051
- * })
1052
- *
1053
- * const data = {
1054
- * headers: {
1055
- * 'x-my-header': 'some-value'
1056
- * },
1057
- * body: {
1058
- * 'some-body-value': true
1059
- * }
1060
- * }
1061
- *
1062
- * client.getSpace('<space_id>')
1063
- * .then((space) => space.getEnvironment('<environment-id>'))
1064
- * .then((environment) => environment.createAppActionCall('<app_definition_id>', '<action_id>', data)
1065
- * .then((appActionCall) => console.log(appActionCall))
1066
- * .catch(console.error)
1067
- * ```
1068
- */
1069
- createAppActionCall(appDefinitionId: string, appActionId: string, data: CreateAppActionCallProps): Promise<import("./export-types").AppActionCall>;
1070
- /**
1071
- * Gets the raw response (headers/body) for a completed App Action Call
1072
- * @param appDefinitionId - AppDefinition ID
1073
- * @param appActionId - App Action ID
1074
- * @param callId - App Action Call ID
1075
- * @return Promise for the raw response object including `response.body` and optional `response.headers`
1076
- * @example ```javascript
1077
- * const contentful = require('contentful-management')
1078
- *
1079
- * const client = contentful.createClient({
1080
- * accessToken: '<content_management_api_key>'
1081
- * })
1082
- *
1083
- * client
1084
- * .getSpace('<space_id>')
1085
- * .then((space) => space.getEnvironment('<environment_id>'))
1086
- * .then((environment) => environment.getAppActionCallResponse('<app_definition_id>', '<app_action_id>', '<call_id>'))
1087
- * .then((raw) => console.log(raw.response.body))
1088
- * .catch(console.error)
1089
- * ```
1090
- */
1091
- getAppActionCallResponse(appDefinitionId: string, appActionId: string, callId: string): Promise<AppActionCallRawResponseProps>;
1092
- /**
1093
- * Creates an app signed request
1094
- * @param appDefinitionId - AppDefinition ID
1095
- * @param data - SignedRequest data
1096
- * @return Promise for a Signed Request
1097
- * @example ```javascript
1098
- * const contentful = require('contentful-management')
1099
- *
1100
- * const client = contentful.createClient({
1101
- * accessToken: '<content_management_api_key>'
1102
- * })
1103
- *
1104
- * const data = {
1105
- * method: 'POST',
1106
- * path: '/request_path',
1107
- * body: '{ "key": "data" }',
1108
- * headers: {
1109
- * 'x-my-header': 'some-value'
1110
- * },
1111
- * }
1112
- *
1113
- * client.getSpace('<space_id>')
1114
- * .then((space) => space.getEnvironment('<environment-id>'))
1115
- * .then((environment) => environment.createAppSignedRequest('<app_definition_id>', data)
1116
- * .then((signedRequest) => console.log(signedRequest))
1117
- * .catch(console.error)
1118
- * ```
1119
- */
1120
- createAppSignedRequest(appDefinitionId: string, data: CreateAppSignedRequestProps): Promise<import("./export-types").AppSignedRequest>;
1121
- /**
1122
- * Creates an app access token
1123
- * @param appDefinitionId - AppDefinition ID
1124
- * @param data - Json Web Token
1125
- * @return Promise for an app access token
1126
- * @example ```javascript
1127
- * const contentful = require('contentful-management')
1128
- * const { sign } = require('jsonwebtoken')
1129
- *
1130
- * const signOptions = { algorithm: 'RS256', issuer: '<app_definition_id>', expiresIn: '10m' }
1131
- *
1132
- * const client = contentful.createClient({
1133
- * accessToken: '<content_management_api_key>'
1134
- * })
1135
- *
1136
- * const data = {
1137
- * jwt: sign({}, '<private_key>', signOptions)
1138
- * }
1139
- *
1140
- * client.getSpace('<space_id>')
1141
- * .then((space) => space.getEnvironment('<environment-id>'))
1142
- * .then((environment) => environment.createAppAccessToken('<app_definition_id>', data)
1143
- * .then((appAccessToken) => console.log(appAccessToken))
1144
- * .catch(console.error)
1145
- * ```
1146
- */
1147
- createAppAccessToken(appDefinitionId: string, data: CreateAppAccessTokenProps): Promise<import("./export-types").AppAccessToken>;
1148
- /**
1149
- * Gets a collection of Functions for a given environment
1150
- * @param appInstallationId
1151
- * @param {import('../common-types').AcceptsQueryOptions} query - optional query parameter for filtering functions by action
1152
- * @return Promise containing wrapped collection of Functions in an environment
1153
- * @example ```javascript
1154
- * const contentful = require('contentful-management')
1155
- *
1156
- * const client = contentful.createClient({
1157
- * accessToken: '<content_management_api_key>'
1158
- * })
1159
- *
1160
- * client
1161
- * .getSpace('<space-id>')
1162
- * .then((space) => space.getEnvironment('<environment-id>'))
1163
- * .then((environment) => environment.getFunctionsForEnvironment('<app-installation-id>', { 'accepts[all]': '<action>' }))
1164
- * .then((functions) => console.log(functions.items))
1165
- * .catch(console.error)
1166
- * ```
1167
- */
1168
- getFunctionsForEnvironment(appInstallationId: string, query?: AcceptsQueryOptions): Promise<import("./common-types").Collection<import("./export-types").FunctionProps, import("./export-types").FunctionProps>>;
1169
- /**
1170
- * Gets a collection of FunctionLogs for a given app installation id and FunctionId
1171
- * @param appInstallationId
1172
- * @param functionId
1173
- * @param {import('../common-types').CursorBasedParams} query - optional query parameter for pagination (limit, nextPage, prevPage)
1174
- * @return Promise containing wrapped collection of FunctionLogs
1175
- * * @example ```javascript
1176
- * const contentful = require('contentful-management')
1177
- *
1178
- * const client = contentful.createClient({
1179
- * accessToken: '<content_management_api_key>'
1180
- * })
1181
- *
1182
- * client
1183
- * .getSpace('<space-id>')
1184
- * .then((space) => space.getEnvironment('<environment-id>'))
1185
- * .then((environment) =>
1186
- * environment.getFunctionLogs(
1187
- * '<app-installation-id>',
1188
- * '<function-id>',
1189
- * {
1190
- * query: {
1191
- * // optional limit
1192
- * limit: 10,
1193
- * // optional interval query
1194
- * 'sys.createdAt[gte]': start,
1195
- * 'sys.createdAt[lt]': end,
1196
- * // optional cursor based pagination parameters
1197
- * pagePrev: '<page_prev>',
1198
- * },
1199
- * },
1200
- * )
1201
- * )
1202
- * .then((functionLogs) => console.log(functionLog.items))
1203
- * .catch(console.error)
1204
- * ```
1205
- */
1206
- getFunctionLogs(appInstallationId: string, functionId: string, query?: CursorBasedParams & CreatedAtIntervalParams): Promise<import("./common-types").Collection<import("./entities/function-log").FunctionLogProps, import("./entities/function-log").FunctionLogProps>>;
1207
- /**
1208
- * Gets a FunctionLog by appInstallationId, functionId and logId
1209
- * @param appInstallationId
1210
- * @param functionId
1211
- * @param logId
1212
- * @return Promise containing a wrapped FunctionLog
1213
- * @example ```javascript
1214
- * const contentful = require('contentful-management')
1215
- *
1216
- * const client = contentful.createClient({
1217
- * accessToken: '<content_management_api_key>'
1218
- * })
1219
- *
1220
- * client
1221
- * .getSpace(<space-id>)
1222
- * .then((space) => space.getEnvironment('<environment-id>'))
1223
- * .then((environment) =>
1224
- * environment.getFunctionLog(
1225
- * '<app-installation-id>',
1226
- * '<function-id>',
1227
- * '<log-id>'
1228
- * )
1229
- * )
1230
- * .then((functionLog) => console.log(functionLog))
1231
- * .catch(console.error)
1232
- * ```
1233
- */
1234
- getFunctionLog(appInstallationId: string, functionId: string, logId: string): Promise<import("./entities/function-log").FunctionLogProps>;
1235
- /**
1236
- * Gets all snapshots of an entry
1237
- * @func getEntrySnapshots
1238
- * @param entryId - Entry ID
1239
- * @param query - query additional query paramaters
1240
- * @return Promise for a collection of Entry Snapshots
1241
- * @example ```javascript
1242
- * const contentful = require('contentful-management')
1243
- *
1244
- * const client = contentful.createClient({
1245
- * accessToken: '<content_management_api_key>'
1246
- * })
1247
- *
1248
- * client.getSpace('<space_id>')
1249
- * .then((space) => space.getEnvironment('<environment-id>'))
1250
- * .then((environment) => environment.getEntrySnapshots('<entry_id>'))
1251
- * .then((snapshots) => console.log(snapshots.items))
1252
- * .catch(console.error)
1253
- * ```
1254
- */
1255
- getEntrySnapshots(entryId: string, query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Snapshot<EntryProps>, import("./export-types").SnapshotProps<EntryProps>>>;
1256
- /**
1257
- * Gets all snapshots of a contentType
1258
- * @func getContentTypeSnapshots
1259
- * @param contentTypeId - Content Type ID
1260
- * @param query - query additional query paramaters
1261
- * @return Promise for a collection of Content Type Snapshots
1262
- * @example ```javascript
1263
- * const contentful = require('contentful-management')
1264
- *
1265
- * const client = contentful.createClient({
1266
- * accessToken: '<content_management_api_key>'
1267
- * })
1268
- *
1269
- * client.getSpace('<space_id>')
1270
- * .then((space) => space.getEnvironment('<environment-id>'))
1271
- * .then((environment) => environment.getContentTypeSnapshots('<contentTypeId>'))
1272
- * .then((snapshots) => console.log(snapshots.items))
1273
- * .catch(console.error)
1274
- * ```
1275
- */
1276
- getContentTypeSnapshots(contentTypeId: string, query?: QueryOptions): Promise<import("./common-types").Collection<import("./export-types").Snapshot<ContentTypeProps>, import("./export-types").SnapshotProps<ContentTypeProps>>>;
1277
- createTag(id: string, name: string, visibility?: TagVisibility): Promise<import("./export-types").Tag>;
1278
- getTags(query?: BasicQueryOptions): Promise<import("./common-types").Collection<import("./export-types").Tag, import("./export-types").TagProps>>;
1279
- getTag(id: string): Promise<import("./export-types").Tag>;
1280
- /**
1281
- * Retrieves a Release by ID
1282
- * @param releaseId
1283
- * @returns Promise containing a wrapped Release
1284
- * @example ```javascript
1285
- * const contentful = require('contentful-management')
1286
- *
1287
- * const client = contentful.createClient({
1288
- * accessToken: '<content_management_api_key>'
1289
- * })
1290
- *
1291
- * client.getSpace('<space_id>')
1292
- * .then((space) => space.getEnvironment('<environment-id>'))
1293
- * .then((environment) => environment.getRelease('<release_id>'))
1294
- * .then((release) => console.log(release))
1295
- * .catch(console.error)
1296
- * ```
1297
- */
1298
- getRelease(releaseId: string): Promise<import("./export-types").Release>;
1299
- /**
1300
- * Gets a Collection of Releases,
1301
- * @param {ReleaseQueryOptions} query filtering options for the collection result
1302
- * @returns Promise containing a wrapped Release Collection
1303
- * @example ```javascript
1304
- * const contentful = require('contentful-management')
1305
- *
1306
- * const client = contentful.createClient({
1307
- * accessToken: '<content_management_api_key>'
1308
- * })
1309
- *
1310
- * client.getSpace('<space_id>')
1311
- * .then((space) => space.getEnvironment('<environment-id>'))
1312
- * .then((environment) => environment.getReleases({ 'entities.sys.id[in]': '<asset_id>,<entry_id>' }))
1313
- * .then((releases) => console.log(releases))
1314
- * .catch(console.error)
1315
- * ```
1316
- */
1317
- getReleases(query?: ReleaseQueryOptions): Promise<import("./common-types").CursorPaginatedCollection<import("./export-types").Release, import("./export-types").ReleaseProps>>;
1318
- /**
1319
- * Creates a new Release with the entities and title in the payload
1320
- * @param payload Object containing the payload in order to create a Release
1321
- * @returns Promise containing a wrapped Release, that has other helper methods within.
1322
- * @example ```javascript
1323
- * const contentful = require('contentful-management')
1324
- *
1325
- * const client = contentful.createClient({
1326
- * accessToken: '<content_management_api_key>'
1327
- * })
1328
- *
1329
- * const payload = {
1330
- * title: 'My Release',
1331
- * entities: {
1332
- * sys: { type: 'Array' },
1333
- * items: [
1334
- * { sys: { linkType: 'Entry', type: 'Link', id: '<entry_id>' } }
1335
- * ]
1336
- * }
1337
- * }
1338
- *
1339
- * client.getSpace('<space_id>')
1340
- * .then((space) => space.getEnvironment('<environment-id>'))
1341
- * .then((environment) => environment.createRelease(payload))
1342
- * .then((release) => console.log(release))
1343
- * .catch(console.error)
1344
- * ```
1345
- */
1346
- createRelease(payload: ReleasePayload): Promise<import("./export-types").Release>;
1347
- /**
1348
- * Updates a Release and replaces all the properties.
1349
- * @param {object} options,
1350
- * @param options.releaseId the ID of the release
1351
- * @param options.payload the payload to be updated in the Release
1352
- * @param options.version Release sys.version that to be updated
1353
- * @returns Promise containing a wrapped Release, that has helper methods within.
1354
- *
1355
- * @example ```javascript
1356
- * const contentful = require('contentful-management')
1357
- *
1358
- * const client = contentful.createClient({
1359
- * accessToken: '<content_management_api_key>'
1360
- * })
1361
- *
1362
- *
1363
- * const payload = {
1364
- * title: "Updated Release title",
1365
- * entities: {
1366
- * sys: { type: 'Array' },
1367
- * items: [
1368
- * { sys: { linkType: 'Entry', type: 'Link', id: '<entry_id>' } }
1369
- * ]
1370
- * }
1371
- * }
1372
- *
1373
- * client.getSpace('<space_id>')
1374
- * .then((space) => space.getEnvironment('<environment-id>'))
1375
- * .then((environment) => environment.updateRelease({ releaseId: '<release_id>', version: 1, payload } ))
1376
- * .then((release) => console.log(release))
1377
- * .catch(console.error)
1378
- * ```
1379
- */
1380
- updateRelease({ releaseId, payload, version, }: {
1381
- releaseId: string;
1382
- payload: ReleasePayload;
1383
- version: number;
1384
- }): Promise<import("./export-types").Release>;
1385
- /**
1386
- * Deletes a Release by ID - does not delete any entities.
1387
- * @param releaseId the ID of the release
1388
- *
1389
- * @returns Promise containing a wrapped Release, that has helper methods within.
1390
- * @example ```javascript
1391
- * const contentful = require('contentful-management')
1392
- *
1393
- * const client = contentful.createClient({
1394
- * accessToken: '<content_management_api_key>'
1395
- * })
1396
- *
1397
- * client.getSpace('<space_id>')
1398
- * .then((space) => space.getEnvironment('<environment-id>'))
1399
- * .then((environment) => environment.deleteRelease('<release_id>')
1400
- * .catch(console.error)
1401
- * ```
1402
- */
1403
- deleteRelease(releaseId: string): Promise<void>;
1404
- /**
1405
- * Publishes all Entities contained in a Release.
1406
- * @param options.releaseId the ID of the release
1407
- * @param options.version the version of the release that is to be published
1408
- * @returns Promise containing a wrapped Release, that has helper methods within.
1409
- *
1410
- * @example ```javascript
1411
- * const contentful = require('contentful-management')
1412
- *
1413
- * const client = contentful.createClient({
1414
- * accessToken: '<content_management_api_key>'
1415
- * })
1416
- *
1417
- * client.getSpace('<space_id>')
1418
- * .then((space) => space.getEnvironment('<environment-id>'))
1419
- * .then((environment) => environment.publishRelease({ releaseId: '<release_id>', version: 1 }))
1420
- * .catch(console.error)
1421
- * ```
1422
- */
1423
- publishRelease({ releaseId, version }: {
1424
- releaseId: string;
1425
- version: number;
1426
- }): Promise<import("./export-types").ReleaseAction<any>>;
1427
- /**
1428
- * Unpublishes all Entities contained in a Release.
1429
- * @param options.releaseId the ID of the release
1430
- * @param options.version the version of the release that is to be published
1431
- * @returns Promise containing a wrapped Release, that has helper methods within.
1432
- *
1433
- * @example ```javascript
1434
- * const contentful = require('contentful-management')
1435
- *
1436
- * const client = contentful.createClient({
1437
- * accessToken: '<content_management_api_key>'
1438
- * })
1439
- *
1440
- * client.getSpace('<space_id>')
1441
- * .then((space) => space.getEnvironment('<environment-id>'))
1442
- * .then((environment) => environment.unpublishRelease({ releaseId: '<release_id>', version: 1 }))
1443
- * .catch(console.error)
1444
- * ```
1445
- */
1446
- unpublishRelease({ releaseId, version }: {
1447
- releaseId: string;
1448
- version: number;
1449
- }): Promise<import("./export-types").ReleaseAction<any>>;
1450
- /**
1451
- * Validates all Entities contained in a Release against an action (publish or unpublish)
1452
- * @param options.releaseId the ID of the release
1453
- * @param options.payload (optional) the type of action to be validated against
1454
- *
1455
- * @returns Promise containing a wrapped Release, that has helper methods within.
1456
- *
1457
- * @example ```javascript
1458
- * const contentful = require('contentful-management')
1459
- *
1460
- * const client = contentful.createClient({
1461
- * accessToken: '<content_management_api_key>'
1462
- * })
1463
- *
1464
- * client.getSpace('<space_id>')
1465
- * .then((space) => space.getEnvironment('<environment-id>'))
1466
- * .then((environment) => environment.validateRelease({ releaseId: '<release_id>', payload: { action: 'unpublish' } }))
1467
- * .catch(console.error)
1468
- * ```
1469
- */
1470
- validateRelease({ releaseId, payload, }: {
1471
- releaseId: string;
1472
- payload?: ReleaseValidatePayload;
1473
- }): Promise<import("./export-types").ReleaseAction<any>>;
1474
- /**
1475
- * Archives a Release and prevents new operations (publishing, unpublishing adding new entities etc).
1476
- * @param options.releaseId the ID of the release
1477
- * @param options.version the version of the release that is to be archived
1478
- * @returns Promise containing a wrapped Release, that has helper methods within.
1479
- *
1480
- * @example ```javascript
1481
- * const contentful = require('contentful-management')
1482
- *
1483
- * const client = contentful.createClient({
1484
- * accessToken: '<content_management_api_key>'
1485
- * })
1486
- *
1487
- * client.getSpace('<space_id>')
1488
- * .then((space) => space.getEnvironment('<environment-id>'))
1489
- * .then((environment) => environment.archiveRelease({ releaseId: '<release_id>', version: 1 }))
1490
- * .catch(console.error)
1491
- * ```
1492
- */
1493
- archiveRelease({ releaseId, version }: {
1494
- releaseId: string;
1495
- version: number;
1496
- }): Promise<import("./export-types").Release>;
1497
- /**
1498
- * Unarchives a previously archived Release - this enables the release to be published, unpublished etc.
1499
- * @param options.releaseId the ID of the release
1500
- * @param options.version the version of the release that is to be unarchived
1501
- * @returns Promise containing a wrapped Release, that has helper methods within.
1502
- *
1503
- * @example ```javascript
1504
- * const contentful = require('contentful-management')
1505
- *
1506
- * const client = contentful.createClient({
1507
- * accessToken: '<content_management_api_key>'
1508
- * })
1509
- *
1510
- * client.getSpace('<space_id>')
1511
- * .then((space) => space.getEnvironment('<environment-id>'))
1512
- * .then((environment) => environment.unarchiveRelease({ releaseId: '<release_id>', version: 1 }))
1513
- * .catch(console.error)
1514
- * ```
1515
- */
1516
- unarchiveRelease({ releaseId, version }: {
1517
- releaseId: string;
1518
- version: number;
1519
- }): Promise<import("./export-types").Release>;
1520
- /**
1521
- * Retrieves a ReleaseAction by ID
1522
- * @param params.releaseId The ID of a Release
1523
- * @param params.actionId The ID of a Release Action
1524
- * @returns Promise containing a wrapped ReleaseAction
1525
- * @example ```javascript
1526
- * const contentful = require('contentful-management')
1527
- *
1528
- * const client = contentful.createClient({
1529
- * accessToken: '<content_management_api_key>'
1530
- * })
1531
- *
1532
- * client.getSpace('<space_id>')
1533
- * .then((space) => space.getEnvironment('<environment-id>'))
1534
- * .then((environment) => environment.getReleaseAction({ releaseId: '<release_id>', actionId: '<action_id>' }))
1535
- * .then((releaseAction) => console.log(releaseAction))
1536
- * .catch(console.error)
1537
- * ```
1538
- */
1539
- getReleaseAction({ actionId, releaseId }: {
1540
- actionId: string;
1541
- releaseId: string;
1542
- }): Promise<import("./export-types").ReleaseAction<any>>;
1543
- /**
1544
- * Gets a Collection of ReleaseActions
1545
- * @param {string} params.releaseId ID of the Release to fetch the actions from
1546
- * @param {ReleaseQueryOptions} params.query filtering options for the collection result
1547
- * @returns Promise containing a wrapped ReleaseAction Collection
1548
- *
1549
- * @example ```javascript
1550
- * const contentful = require('contentful-management')
1551
- *
1552
- * const client = contentful.createClient({
1553
- * accessToken: '<content_management_api_key>'
1554
- * })
1555
- *
1556
- * client.getSpace('<space_id>')
1557
- * .then((space) => space.getEnvironment('<environment-id>'))
1558
- * .then((environment) => environment.getReleaseActions({ query: { 'sys.id[in]': '<id_1>,<id_2>', 'sys.release.sys.id[in]': '<id1>,<id2>' } }))
1559
- * .then((releaseActions) => console.log(releaseActions))
1560
- * .catch(console.error)
1561
- * ```
1562
- */
1563
- getReleaseActions({ query }: {
1564
- query?: ReleaseActionQueryOptions;
1565
- }): Promise<import("./common-types").Collection<import("./export-types").ReleaseAction<any>, import("./export-types").ReleaseActionProps<any>>>;
1566
- getUIConfig(): Promise<{
1567
- update: () => Promise<any & import("./export-types").UIConfigProps & {
1568
- toPlainObject(): import("./export-types").UIConfigProps;
1569
- }>;
1570
- } & import("./export-types").UIConfigProps & {
1571
- toPlainObject(): import("./export-types").UIConfigProps;
1572
- }>;
1573
- getUserUIConfig(): Promise<{
1574
- update: () => Promise<any & import("./export-types").UserUIConfigProps & {
1575
- toPlainObject(): import("./export-types").UserUIConfigProps;
1576
- }>;
1577
- } & import("./export-types").UserUIConfigProps & {
1578
- toPlainObject(): import("./export-types").UserUIConfigProps;
1579
- }>;
1580
- /**
1581
- * Gets a collection of all environment template installations in the environment for a given template
1582
- * @param environmentTemplateId - Environment template ID to return installations for
1583
- * @param [options.installationId] - Installation ID to filter for a specific installation
1584
- * @return Promise for a collection of EnvironmentTemplateInstallations
1585
- * ```javascript
1586
- * const contentful = require('contentful-management')
1587
- *
1588
- * const client = contentful.createClient({
1589
- * accessToken: '<content_management_api_key>'
1590
- * })
1591
- *
1592
- * client.getSpace('<space_id>')
1593
- * .then((space) => space.getEnvironment('<environment_id>'))
1594
- * .then((environment) => environment.getEnvironmentTemplateInstallations('<environment_template_id>'))
1595
- * .then((installations) => console.log(installations.items))
1596
- * .catch(console.error)
1597
- * ```
1598
- */
1599
- getEnvironmentTemplateInstallations(environmentTemplateId: string, { installationId, ...query }?: BasicCursorPaginationOptions & {
1600
- installationId?: string;
1601
- }): Promise<import("./common-types").CursorPaginatedCollection<import("./export-types").EnvironmentTemplateInstallation, import("./export-types").EnvironmentTemplateInstallationProps>>;
1602
- /**
1603
- * Gets a collection of all resource types based on native external references app installations in the environment
1604
- * @param query - BasicCursorPaginationOptions
1605
- * @return Promise for a collection of ResourceTypes
1606
- * ```javascript
1607
- * const contentful = require('contentful-management')
1608
- *
1609
- * const client = contentful.createClient({
1610
- * accessToken: '<content_management_api_key>'
1611
- * })
1612
- *
1613
- * client.getSpace('<space_id>')
1614
- * .then((space) => space.getEnvironment('<environment_id>'))
1615
- * .then((environment) => environment.getResourceTypes({limit: 10}))
1616
- * .then((installations) => console.log(installations.items))
1617
- * .catch(console.error)
1618
- * ```
1619
- */
1620
- getResourceTypes(query?: BasicCursorPaginationOptions): Promise<import("./common-types").CursorPaginatedCollectionProp<import("./export-types").SpaceEnvResourceTypeProps>>;
1621
- /**
1622
- * Gets a collection of all resources for a given resource type based on native external references app installations in the environment
1623
- * @param resourceTypeId - Id of the resourceType to get its resources
1624
- * @param query - Either LookupQuery options with 'sys.urn[in]' param or a Search query with 'query' param, in both cases you can add pagination options
1625
- * @return Promise for a collection of Resources for a given resourceTypeId
1626
- * ```javascript
1627
- * const contentful = require('contentful-management')
1628
- *
1629
- * const client = contentful.createClient({
1630
- * accessToken: '<content_management_api_key>'
1631
- * })
1632
- *
1633
- * // Search Query
1634
- * client.getSpace('<space_id>')
1635
- * .then((space) => space.getEnvironment('<environment_id>'))
1636
- * // <search_query> is a string you want to search for in the external resources
1637
- * .then((environment) => environment.getResourcesForResourceType('<resource_type_id>', {query: '<search_query>', limit: 10}))
1638
- * .then((installations) => console.log(installations.items))
1639
- * .catch(console.error)
1640
- *
1641
- * // Lookup query
1642
- *
1643
- * client.getSpace('<space_id>')
1644
- * .then((space) => space.getEnvironment('<environment_id>'))
1645
- * .then((environment) => environment.getResourcesForResourceType('<resource_type_id>', {'sys.urn[in]': '<resource_urn1>,<resource_urn2>', limit: 10}))
1646
- * .then((installations) => console.log(installations.items))
1647
- * .catch(console.error)
1648
- * ```
1649
- */
1650
- getResourcesForResourceType(resourceTypeId: string, query?: ResourceQueryOptions): Promise<import("./common-types").CursorPaginatedCollectionProp<import("./export-types").ResourceProps>>;
1651
- /**
1652
- * Invokes an AI Action.
1653
- * @param aiActionId - The ID of the AI Action to invoke.
1654
- * @param payload - The invocation payload.
1655
- * @returns Promise for an AI Action Invocation.
1656
- * @example ```javascript
1657
- * client.getSpace('<space_id>')
1658
- * .then(space => space.getEnvironment('<environment_id>'))
1659
- * .then(environment => environment.invokeAiAction('<ai_action_id>', {
1660
- * variables: [ ... ],
1661
- * outputFormat: 'RichText'
1662
- * }))
1663
- * .then(invocation => console.log(invocation))
1664
- * .catch(console.error)
1665
- * ```
1666
- */
1667
- invokeAiAction(aiActionId: string, payload: AiActionInvocationType): Promise<import("./export-types").AiActionInvocation>;
1668
- /**
1669
- * Retrieves an AI Action Invocation.
1670
- * @param params - Object containing the AI Action ID and the Invocation ID.
1671
- * @returns Promise for an AI Action Invocation.
1672
- * @example ```javascript
1673
- * client.getSpace('<space_id>')
1674
- * .then(space => space.getEnvironment('<environment_id>'))
1675
- * .then(environment => environment.getAiActionInvocation({
1676
- * aiActionId: '<ai_action_id>',
1677
- * invocationId: '<invocation_id>'
1678
- * }))
1679
- * .then(invocation => console.log(invocation))
1680
- * .catch(console.error)
1681
- * ```
1682
- */
1683
- getAiActionInvocation({ aiActionId, invocationId, }: {
1684
- aiActionId: string;
1685
- invocationId: string;
1686
- }): Promise<import("./export-types").AiActionInvocation>;
1687
- };