webflow-api 2.4.0 → 2.5.0

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 (457) hide show
  1. package/.mock/definition/__package__.yml +2495 -0
  2. package/.mock/definition/accessGroups.yml +80 -0
  3. package/.mock/definition/api.yml +13 -0
  4. package/.mock/definition/assets.yml +414 -0
  5. package/.mock/definition/collections/fields.yml +187 -0
  6. package/.mock/definition/collections/items.yml +1511 -0
  7. package/.mock/definition/collections.yml +185 -0
  8. package/.mock/definition/ecommerce.yml +42 -0
  9. package/.mock/definition/forms.yml +301 -0
  10. package/.mock/definition/inventory.yml +120 -0
  11. package/.mock/definition/orders.yml +1569 -0
  12. package/.mock/definition/pages/scripts.yml +169 -0
  13. package/.mock/definition/pages.yml +443 -0
  14. package/.mock/definition/products.yml +500 -0
  15. package/.mock/definition/scripts.yml +257 -0
  16. package/.mock/definition/sites/activityLogs.yml +65 -0
  17. package/.mock/definition/sites/scripts.yml +228 -0
  18. package/.mock/definition/sites.yml +299 -0
  19. package/.mock/definition/token.yml +71 -0
  20. package/.mock/definition/users.yml +392 -0
  21. package/.mock/definition/webhooks.yml +189 -0
  22. package/.mock/fern.config.json +4 -0
  23. package/Client.d.ts +2 -0
  24. package/README.md +23 -30
  25. package/api/errors/InternalServerError.d.ts +2 -1
  26. package/api/errors/NotFoundError.d.ts +2 -1
  27. package/api/errors/TooManyRequestsError.d.ts +1 -1
  28. package/api/errors/UnauthorizedError.d.ts +2 -1
  29. package/api/resources/accessGroups/client/Client.d.ts +5 -1
  30. package/api/resources/accessGroups/client/Client.js +27 -15
  31. package/api/resources/assets/client/Client.d.ts +31 -11
  32. package/api/resources/assets/client/Client.js +236 -126
  33. package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
  34. package/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
  35. package/api/resources/collections/client/Client.d.ts +15 -22
  36. package/api/resources/collections/client/Client.js +109 -137
  37. package/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
  38. package/api/resources/collections/resources/fields/client/Client.js +163 -32
  39. package/api/resources/collections/resources/items/client/Client.d.ts +302 -30
  40. package/api/resources/collections/resources/items/client/Client.js +959 -221
  41. package/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
  42. package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
  43. package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
  44. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
  45. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
  46. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
  47. package/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  48. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
  49. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
  50. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  51. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
  52. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  53. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
  54. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
  55. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
  56. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
  57. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
  58. package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
  59. package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
  60. package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
  61. package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
  62. package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
  63. package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
  64. package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
  65. package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
  66. package/api/resources/collections/resources/items/types/index.d.ts +9 -0
  67. package/api/resources/collections/resources/items/types/index.js +9 -0
  68. package/api/resources/ecommerce/client/Client.d.ts +2 -0
  69. package/api/resources/ecommerce/client/Client.js +24 -14
  70. package/api/resources/forms/client/Client.d.ts +17 -5
  71. package/api/resources/forms/client/Client.js +140 -76
  72. package/api/resources/inventory/client/Client.d.ts +8 -1
  73. package/api/resources/inventory/client/Client.js +59 -30
  74. package/api/resources/orders/client/Client.d.ts +7 -2
  75. package/api/resources/orders/client/Client.js +164 -89
  76. package/api/resources/pages/client/Client.d.ts +25 -14
  77. package/api/resources/pages/client/Client.js +169 -100
  78. package/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
  79. package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  80. package/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
  81. package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  82. package/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
  83. package/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
  84. package/api/resources/pages/resources/scripts/client/Client.js +104 -46
  85. package/api/resources/products/client/Client.d.ts +26 -10
  86. package/api/resources/products/client/Client.js +188 -98
  87. package/api/resources/scripts/client/Client.d.ts +31 -3
  88. package/api/resources/scripts/client/Client.js +111 -47
  89. package/api/resources/sites/client/Client.d.ts +16 -4
  90. package/api/resources/sites/client/Client.js +101 -59
  91. package/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
  92. package/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
  93. package/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
  94. package/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
  95. package/api/resources/sites/resources/scripts/client/Client.js +125 -61
  96. package/api/resources/token/client/Client.d.ts +7 -2
  97. package/api/resources/token/client/Client.js +23 -24
  98. package/api/resources/users/client/Client.d.ts +21 -6
  99. package/api/resources/users/client/Client.js +149 -78
  100. package/api/resources/webhooks/client/Client.d.ts +15 -2
  101. package/api/resources/webhooks/client/Client.js +114 -59
  102. package/api/types/AssetFolder.d.ts +1 -1
  103. package/api/types/AuthorizationAuthorization.d.ts +1 -1
  104. package/api/types/AuthorizedUser.d.ts +1 -1
  105. package/api/types/BulkCollectionItemFieldData.d.ts +1 -1
  106. package/api/types/CollectionItem.d.ts +1 -1
  107. package/api/types/CollectionItemFieldData.d.ts +1 -1
  108. package/api/types/CollectionItemListNoPagination.d.ts +11 -0
  109. package/api/types/CollectionItemListNoPagination.js +5 -0
  110. package/api/types/CollectionItemWithIdInput.d.ts +24 -0
  111. package/api/types/CollectionItemWithIdInput.js +5 -0
  112. package/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
  113. package/api/types/CollectionItemWithIdInputFieldData.js +5 -0
  114. package/api/types/ConflictErrorBody.d.ts +1 -10
  115. package/api/types/CustomCodeBlock.d.ts +2 -2
  116. package/api/types/DuplicateUserEmail.d.ts +1 -11
  117. package/api/types/ErrorCode.d.ts +38 -0
  118. package/api/types/ErrorCode.js +37 -0
  119. package/api/types/Error_.d.ts +1 -1
  120. package/api/types/ForbiddenErrorBody.d.ts +2 -7
  121. package/api/types/Form.d.ts +8 -8
  122. package/api/types/FormSubmission.d.ts +3 -3
  123. package/api/types/InvalidScopes.d.ts +4 -0
  124. package/api/types/InvalidScopes.js +5 -0
  125. package/api/types/NotEnterprisePlanSite.d.ts +1 -11
  126. package/api/types/Order.d.ts +5 -1
  127. package/api/types/Page.d.ts +2 -0
  128. package/api/types/Site.d.ts +4 -0
  129. package/api/types/SiteActivityLogItem.d.ts +1 -1
  130. package/api/types/SiteActivityLogItemEvent.d.ts +48 -0
  131. package/api/types/SiteActivityLogItemEvent.js +50 -0
  132. package/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
  133. package/api/types/SiteActivityLogItemResourceOperation.js +4 -0
  134. package/api/types/SiteDataCollectionType.d.ts +12 -0
  135. package/api/types/SiteDataCollectionType.js +11 -0
  136. package/api/types/UserLimitReached.d.ts +1 -11
  137. package/api/types/UsersNotEnabled.d.ts +1 -11
  138. package/api/types/index.d.ts +10 -6
  139. package/api/types/index.js +10 -6
  140. package/core/fetcher/Fetcher.d.ts +1 -1
  141. package/core/fetcher/getResponseBody.js +3 -0
  142. package/core/fetcher/requestWithRetries.js +13 -4
  143. package/core/schemas/builders/object/object.js +28 -0
  144. package/core/schemas/builders/object/types.d.ts +5 -0
  145. package/dist/Client.d.ts +2 -0
  146. package/dist/api/errors/InternalServerError.d.ts +2 -1
  147. package/dist/api/errors/NotFoundError.d.ts +2 -1
  148. package/dist/api/errors/TooManyRequestsError.d.ts +1 -1
  149. package/dist/api/errors/UnauthorizedError.d.ts +2 -1
  150. package/dist/api/resources/accessGroups/client/Client.d.ts +5 -1
  151. package/dist/api/resources/accessGroups/client/Client.js +27 -15
  152. package/dist/api/resources/assets/client/Client.d.ts +31 -11
  153. package/dist/api/resources/assets/client/Client.js +236 -126
  154. package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
  155. package/dist/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
  156. package/dist/api/resources/collections/client/Client.d.ts +15 -22
  157. package/dist/api/resources/collections/client/Client.js +109 -137
  158. package/dist/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
  159. package/dist/api/resources/collections/resources/fields/client/Client.js +163 -32
  160. package/dist/api/resources/collections/resources/items/client/Client.d.ts +302 -30
  161. package/dist/api/resources/collections/resources/items/client/Client.js +959 -221
  162. package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
  163. package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +5 -0
  164. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
  165. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +5 -0
  166. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
  167. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +5 -0
  168. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
  169. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +5 -0
  170. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
  171. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
  172. package/dist/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  173. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
  174. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
  175. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  176. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
  177. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  178. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
  179. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
  180. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
  181. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
  182. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
  183. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
  184. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
  185. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
  186. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
  187. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
  188. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
  189. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
  190. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
  191. package/dist/api/resources/collections/resources/items/types/index.d.ts +9 -0
  192. package/dist/api/resources/collections/resources/items/types/index.js +9 -0
  193. package/dist/api/resources/ecommerce/client/Client.d.ts +2 -0
  194. package/dist/api/resources/ecommerce/client/Client.js +24 -14
  195. package/dist/api/resources/forms/client/Client.d.ts +17 -5
  196. package/dist/api/resources/forms/client/Client.js +140 -76
  197. package/dist/api/resources/inventory/client/Client.d.ts +8 -1
  198. package/dist/api/resources/inventory/client/Client.js +59 -30
  199. package/dist/api/resources/orders/client/Client.d.ts +7 -2
  200. package/dist/api/resources/orders/client/Client.js +164 -89
  201. package/dist/api/resources/pages/client/Client.d.ts +25 -14
  202. package/dist/api/resources/pages/client/Client.js +169 -100
  203. package/dist/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
  204. package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  205. package/dist/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
  206. package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  207. package/dist/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
  208. package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
  209. package/dist/api/resources/pages/resources/scripts/client/Client.js +104 -46
  210. package/dist/api/resources/products/client/Client.d.ts +26 -10
  211. package/dist/api/resources/products/client/Client.js +188 -98
  212. package/dist/api/resources/scripts/client/Client.d.ts +31 -3
  213. package/dist/api/resources/scripts/client/Client.js +111 -47
  214. package/dist/api/resources/sites/client/Client.d.ts +16 -4
  215. package/dist/api/resources/sites/client/Client.js +101 -59
  216. package/dist/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
  217. package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
  218. package/dist/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
  219. package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
  220. package/dist/api/resources/sites/resources/scripts/client/Client.js +125 -61
  221. package/dist/api/resources/token/client/Client.d.ts +7 -2
  222. package/dist/api/resources/token/client/Client.js +23 -24
  223. package/dist/api/resources/users/client/Client.d.ts +21 -6
  224. package/dist/api/resources/users/client/Client.js +149 -78
  225. package/dist/api/resources/webhooks/client/Client.d.ts +15 -2
  226. package/dist/api/resources/webhooks/client/Client.js +114 -59
  227. package/dist/api/types/AssetFolder.d.ts +1 -1
  228. package/dist/api/types/AuthorizationAuthorization.d.ts +1 -1
  229. package/dist/api/types/AuthorizedUser.d.ts +1 -1
  230. package/dist/api/types/BulkCollectionItemFieldData.d.ts +1 -1
  231. package/dist/api/types/CollectionItem.d.ts +1 -1
  232. package/dist/api/types/CollectionItemFieldData.d.ts +1 -1
  233. package/dist/api/types/CollectionItemListNoPagination.d.ts +11 -0
  234. package/dist/api/types/CollectionItemListNoPagination.js +5 -0
  235. package/dist/api/types/CollectionItemWithIdInput.d.ts +24 -0
  236. package/dist/api/types/CollectionItemWithIdInput.js +5 -0
  237. package/dist/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
  238. package/dist/api/types/CollectionItemWithIdInputFieldData.js +5 -0
  239. package/dist/api/types/ConflictErrorBody.d.ts +1 -10
  240. package/dist/api/types/CustomCodeBlock.d.ts +2 -2
  241. package/dist/api/types/DuplicateUserEmail.d.ts +1 -11
  242. package/dist/api/types/ErrorCode.d.ts +38 -0
  243. package/dist/api/types/ErrorCode.js +37 -0
  244. package/dist/api/types/Error_.d.ts +1 -1
  245. package/dist/api/types/ForbiddenErrorBody.d.ts +2 -7
  246. package/dist/api/types/Form.d.ts +8 -8
  247. package/dist/api/types/FormSubmission.d.ts +3 -3
  248. package/dist/api/types/InvalidScopes.d.ts +4 -0
  249. package/dist/api/types/InvalidScopes.js +5 -0
  250. package/dist/api/types/NotEnterprisePlanSite.d.ts +1 -11
  251. package/dist/api/types/Order.d.ts +5 -1
  252. package/dist/api/types/Page.d.ts +2 -0
  253. package/dist/api/types/Site.d.ts +4 -0
  254. package/dist/api/types/SiteActivityLogItem.d.ts +1 -1
  255. package/dist/api/types/SiteActivityLogItemEvent.d.ts +48 -0
  256. package/dist/api/types/SiteActivityLogItemEvent.js +50 -0
  257. package/dist/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
  258. package/dist/api/types/SiteActivityLogItemResourceOperation.js +4 -0
  259. package/dist/api/types/SiteDataCollectionType.d.ts +12 -0
  260. package/dist/api/types/SiteDataCollectionType.js +11 -0
  261. package/dist/api/types/UserLimitReached.d.ts +1 -11
  262. package/dist/api/types/UsersNotEnabled.d.ts +1 -11
  263. package/dist/api/types/index.d.ts +10 -6
  264. package/dist/api/types/index.js +10 -6
  265. package/dist/core/fetcher/Fetcher.d.ts +1 -1
  266. package/dist/core/fetcher/getResponseBody.js +3 -0
  267. package/dist/core/fetcher/requestWithRetries.js +13 -4
  268. package/dist/core/schemas/builders/object/object.js +28 -0
  269. package/dist/core/schemas/builders/object/types.d.ts +5 -0
  270. package/dist/errors/WebflowTimeoutError.d.ts +1 -1
  271. package/dist/errors/WebflowTimeoutError.js +2 -2
  272. package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
  273. package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
  274. package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
  275. package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
  276. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
  277. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
  278. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
  279. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
  280. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
  281. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
  282. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
  283. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
  284. package/dist/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  285. package/dist/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
  286. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
  287. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
  288. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  289. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
  290. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  291. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
  292. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
  293. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
  294. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
  295. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
  296. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
  297. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
  298. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
  299. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
  300. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
  301. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
  302. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
  303. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
  304. package/dist/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
  305. package/dist/serialization/resources/collections/resources/items/types/index.js +9 -0
  306. package/dist/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
  307. package/dist/serialization/types/BulkCollectionItemFieldData.js +4 -2
  308. package/dist/serialization/types/CollectionItem.d.ts +1 -1
  309. package/dist/serialization/types/CollectionItem.js +1 -1
  310. package/dist/serialization/types/CollectionItemFieldData.js +4 -2
  311. package/dist/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
  312. package/dist/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
  313. package/dist/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
  314. package/dist/serialization/types/CollectionItemWithIdInput.js +41 -0
  315. package/dist/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
  316. package/dist/serialization/types/{MissingScopes.js → CollectionItemWithIdInputFieldData.js} +7 -8
  317. package/dist/serialization/types/ConflictErrorBody.d.ts +4 -8
  318. package/dist/serialization/types/ConflictErrorBody.js +3 -7
  319. package/dist/serialization/types/DuplicateUserEmail.d.ts +2 -8
  320. package/dist/serialization/types/DuplicateUserEmail.js +1 -7
  321. package/dist/serialization/types/ErrorCode.d.ts +10 -0
  322. package/dist/serialization/types/ErrorCode.js +61 -0
  323. package/dist/serialization/types/Error_.d.ts +2 -1
  324. package/dist/serialization/types/Error_.js +2 -1
  325. package/dist/serialization/types/ForbiddenErrorBody.d.ts +4 -8
  326. package/dist/serialization/types/ForbiddenErrorBody.js +3 -7
  327. package/dist/serialization/types/Form.d.ts +1 -1
  328. package/dist/serialization/types/Form.js +1 -1
  329. package/dist/serialization/types/InvalidScopes.d.ts +10 -0
  330. package/{serialization/types/MissingScopes.js → dist/serialization/types/InvalidScopes.js} +2 -8
  331. package/dist/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
  332. package/dist/serialization/types/NotEnterprisePlanSite.js +1 -7
  333. package/dist/serialization/types/Page.d.ts +1 -0
  334. package/dist/serialization/types/Page.js +1 -0
  335. package/dist/serialization/types/Site.d.ts +3 -0
  336. package/dist/serialization/types/Site.js +3 -0
  337. package/dist/serialization/types/SiteActivityLogItem.d.ts +2 -1
  338. package/dist/serialization/types/SiteActivityLogItem.js +2 -1
  339. package/dist/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
  340. package/dist/serialization/types/SiteActivityLogItemEvent.js +74 -0
  341. package/dist/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
  342. package/dist/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
  343. package/dist/serialization/types/SiteDataCollectionType.d.ts +10 -0
  344. package/dist/serialization/types/SiteDataCollectionType.js +31 -0
  345. package/dist/serialization/types/UserLimitReached.d.ts +2 -8
  346. package/dist/serialization/types/UserLimitReached.js +1 -7
  347. package/dist/serialization/types/UsersNotEnabled.d.ts +2 -8
  348. package/dist/serialization/types/UsersNotEnabled.js +1 -7
  349. package/dist/serialization/types/index.d.ts +10 -5
  350. package/dist/serialization/types/index.js +10 -5
  351. package/dist/version.d.ts +1 -1
  352. package/dist/version.js +1 -1
  353. package/dist/wrapper/ItemsClient.d.ts +23 -49
  354. package/dist/wrapper/ItemsClient.js +50 -216
  355. package/dist/wrapper/WebflowClient.d.ts +1 -1
  356. package/dist/wrapper/WebflowClient.js +11 -1
  357. package/errors/WebflowTimeoutError.d.ts +1 -1
  358. package/errors/WebflowTimeoutError.js +2 -2
  359. package/package.json +1 -2
  360. package/reference.md +821 -230
  361. package/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
  362. package/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
  363. package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
  364. package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
  365. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
  366. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
  367. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
  368. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
  369. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
  370. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
  371. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
  372. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
  373. package/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  374. package/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
  375. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
  376. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
  377. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  378. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
  379. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  380. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
  381. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
  382. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
  383. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
  384. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
  385. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
  386. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
  387. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
  388. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
  389. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
  390. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
  391. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
  392. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
  393. package/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
  394. package/serialization/resources/collections/resources/items/types/index.js +9 -0
  395. package/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
  396. package/serialization/types/BulkCollectionItemFieldData.js +4 -2
  397. package/serialization/types/CollectionItem.d.ts +1 -1
  398. package/serialization/types/CollectionItem.js +1 -1
  399. package/serialization/types/CollectionItemFieldData.js +4 -2
  400. package/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
  401. package/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
  402. package/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
  403. package/serialization/types/CollectionItemWithIdInput.js +41 -0
  404. package/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
  405. package/serialization/types/CollectionItemWithIdInputFieldData.js +36 -0
  406. package/serialization/types/ConflictErrorBody.d.ts +4 -8
  407. package/serialization/types/ConflictErrorBody.js +3 -7
  408. package/serialization/types/DuplicateUserEmail.d.ts +2 -8
  409. package/serialization/types/DuplicateUserEmail.js +1 -7
  410. package/serialization/types/ErrorCode.d.ts +10 -0
  411. package/serialization/types/ErrorCode.js +61 -0
  412. package/serialization/types/Error_.d.ts +2 -1
  413. package/serialization/types/Error_.js +2 -1
  414. package/serialization/types/ForbiddenErrorBody.d.ts +4 -8
  415. package/serialization/types/ForbiddenErrorBody.js +3 -7
  416. package/serialization/types/Form.d.ts +1 -1
  417. package/serialization/types/Form.js +1 -1
  418. package/serialization/types/InvalidScopes.d.ts +10 -0
  419. package/serialization/types/InvalidScopes.js +31 -0
  420. package/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
  421. package/serialization/types/NotEnterprisePlanSite.js +1 -7
  422. package/serialization/types/Page.d.ts +1 -0
  423. package/serialization/types/Page.js +1 -0
  424. package/serialization/types/Site.d.ts +3 -0
  425. package/serialization/types/Site.js +3 -0
  426. package/serialization/types/SiteActivityLogItem.d.ts +2 -1
  427. package/serialization/types/SiteActivityLogItem.js +2 -1
  428. package/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
  429. package/serialization/types/SiteActivityLogItemEvent.js +74 -0
  430. package/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
  431. package/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
  432. package/serialization/types/SiteDataCollectionType.d.ts +10 -0
  433. package/serialization/types/SiteDataCollectionType.js +31 -0
  434. package/serialization/types/UserLimitReached.d.ts +2 -8
  435. package/serialization/types/UserLimitReached.js +1 -7
  436. package/serialization/types/UsersNotEnabled.d.ts +2 -8
  437. package/serialization/types/UsersNotEnabled.js +1 -7
  438. package/serialization/types/index.d.ts +10 -5
  439. package/serialization/types/index.js +10 -5
  440. package/version.d.ts +1 -1
  441. package/version.js +1 -1
  442. package/wrapper/ItemsClient.d.ts +23 -49
  443. package/wrapper/ItemsClient.js +50 -216
  444. package/wrapper/WebflowClient.d.ts +1 -1
  445. package/wrapper/WebflowClient.js +11 -1
  446. package/api/types/MissingScopes.d.ts +0 -14
  447. package/api/types/TooManyRequestsErrorBody.d.ts +0 -9
  448. package/dist/api/types/MissingScopes.d.ts +0 -14
  449. package/dist/api/types/TooManyRequestsErrorBody.d.ts +0 -9
  450. package/dist/serialization/types/MissingScopes.d.ts +0 -16
  451. package/dist/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
  452. package/serialization/types/MissingScopes.d.ts +0 -16
  453. package/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
  454. /package/api/{types/MissingScopes.js → resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js} +0 -0
  455. /package/api/{types/TooManyRequestsErrorBody.js → resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js} +0 -0
  456. /package/{dist/api/types/MissingScopes.js → api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js} +0 -0
  457. /package/{dist/api/types/TooManyRequestsErrorBody.js → api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js} +0 -0
package/reference.md CHANGED
@@ -14,7 +14,9 @@
14
14
  <dl>
15
15
  <dd>
16
16
 
17
- Information about the Authorized User <br><br> Required Scope | `authorized_user:read`
17
+ Information about the Authorized User
18
+
19
+ Required Scope | `authorized_user:read`
18
20
 
19
21
  </dd>
20
22
  </dl>
@@ -69,7 +71,8 @@ await client.token.authorizedBy();
69
71
  <dl>
70
72
  <dd>
71
73
 
72
- Information about the authorization token <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
74
+ Information about the authorization token
75
+ <Note>Access to this endpoint requires a bearer token from a []>Data Client App](/data/docs/getting-started-data-clients).</Note>
73
76
 
74
77
  </dd>
75
78
  </dl>
@@ -126,7 +129,9 @@ await client.token.introspect();
126
129
  <dl>
127
130
  <dd>
128
131
 
129
- List of all sites the provided access token is able to access. </br></br> Required scope | `sites:read`
132
+ List of all sites the provided access token is able to access.
133
+
134
+ Required scope | `sites:read`
130
135
 
131
136
  </dd>
132
137
  </dl>
@@ -181,7 +186,9 @@ await client.sites.list();
181
186
  <dl>
182
187
  <dd>
183
188
 
184
- Get a site by site id </br></br> Required scope | `sites:read`
189
+ Get details of a site.
190
+
191
+ Required scope | `sites:read`
185
192
 
186
193
  </dd>
187
194
  </dl>
@@ -244,7 +251,9 @@ await client.sites.get("580e63e98c9a982ac9b8b741");
244
251
  <dl>
245
252
  <dd>
246
253
 
247
- Get a list of all custom domains related to site. </br></br> Required scope | `sites:read`
254
+ Get a list of all custom domains related to site.
255
+
256
+ Required scope | `sites:read`
248
257
 
249
258
  </dd>
250
259
  </dl>
@@ -307,7 +316,11 @@ await client.sites.getCustomDomain("580e63e98c9a982ac9b8b741");
307
316
  <dl>
308
317
  <dd>
309
318
 
310
- Publish a site to one more more domains. </br></br> Required scope | `sites:write` <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>Endpoint-specific rate limit</p></h2><p>This endpoint has a limit of one successful publish queue per minute.</p></blockquote>
319
+ Publishes a site to one or more more domains.
320
+
321
+ <Note title="Endpoint-specific rate limit">This endpoint has a limit of one successful publish queue per minute.</Note>
322
+
323
+ Required scope | `sites:write`
311
324
 
312
325
  </dd>
313
326
  </dl>
@@ -380,7 +393,9 @@ await client.sites.publish("580e63e98c9a982ac9b8b741");
380
393
  <dl>
381
394
  <dd>
382
395
 
383
- List of all Collections within a Site. </br></br> Required scope | `cms:read`
396
+ List of all Collections within a Site.
397
+
398
+ Required scope | `cms:read`
384
399
 
385
400
  </dd>
386
401
  </dl>
@@ -443,7 +458,9 @@ await client.collections.list("580e63e98c9a982ac9b8b741");
443
458
  <dl>
444
459
  <dd>
445
460
 
446
- Create a Collection for a site. </br></br> Required scope | `cms:write`
461
+ Create a Collection for a site.
462
+
463
+ Required scope | `cms:write`
447
464
 
448
465
  </dd>
449
466
  </dl>
@@ -518,7 +535,9 @@ await client.collections.create("580e63e98c9a982ac9b8b741", {
518
535
  <dl>
519
536
  <dd>
520
537
 
521
- Get the full details of a collection from its ID. </br></br> Required scope | `cms:read`
538
+ Get the full details of a collection from its ID.
539
+
540
+ Required scope | `cms:read`
522
541
 
523
542
  </dd>
524
543
  </dl>
@@ -569,7 +588,7 @@ await client.collections.get("580e63fc8c9a982ac9b8b745");
569
588
  </dl>
570
589
  </details>
571
590
 
572
- <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">deleteCollection</a>(collectionId) -> void</code></summary>
591
+ <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">delete</a>(collectionId) -> void</code></summary>
573
592
  <dl>
574
593
  <dd>
575
594
 
@@ -581,70 +600,9 @@ await client.collections.get("580e63fc8c9a982ac9b8b745");
581
600
  <dl>
582
601
  <dd>
583
602
 
584
- Delete a collection using its ID. </br></br> Required scope | `cms:write`
585
-
586
- </dd>
587
- </dl>
588
- </dd>
589
- </dl>
590
-
591
- #### 🔌 Usage
592
-
593
- <dl>
594
- <dd>
595
-
596
- <dl>
597
- <dd>
598
-
599
- ```typescript
600
- await client.collections.deleteCollection("580e63fc8c9a982ac9b8b745");
601
- ```
602
-
603
- </dd>
604
- </dl>
605
- </dd>
606
- </dl>
607
-
608
- #### ⚙️ Parameters
609
-
610
- <dl>
611
- <dd>
612
-
613
- <dl>
614
- <dd>
615
-
616
- **collectionId:** `string` — Unique identifier for a Collection
617
-
618
- </dd>
619
- </dl>
620
-
621
- <dl>
622
- <dd>
623
-
624
- **requestOptions:** `Collections.RequestOptions`
625
-
626
- </dd>
627
- </dl>
628
- </dd>
629
- </dl>
630
-
631
- </dd>
632
- </dl>
633
- </details>
634
-
635
- <details><summary><code>client.collections.<a href="/src/api/resources/collections/client/Client.ts">delete</a>(collectionId, fieldId) -> void</code></summary>
636
- <dl>
637
- <dd>
638
-
639
- #### 📝 Description
640
-
641
- <dl>
642
- <dd>
643
-
644
- <dl>
645
- <dd>
603
+ Delete a collection using its ID.
646
604
 
647
- Delete a custom field in a collection. This endpoint does not currently support bulk deletion. </br></br> Required scope | `cms:write`
605
+ Required scope | `cms:write`
648
606
 
649
607
  </dd>
650
608
  </dl>
@@ -660,7 +618,7 @@ Delete a custom field in a collection. This endpoint does not currently support
660
618
  <dd>
661
619
 
662
620
  ```typescript
663
- await client.collections.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b8b745");
621
+ await client.collections.delete("580e63fc8c9a982ac9b8b745");
664
622
  ```
665
623
 
666
624
  </dd>
@@ -684,14 +642,6 @@ await client.collections.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b
684
642
  <dl>
685
643
  <dd>
686
644
 
687
- **fieldId:** `string` — Unique identifier for a Field in a collection
688
-
689
- </dd>
690
- </dl>
691
-
692
- <dl>
693
- <dd>
694
-
695
645
  **requestOptions:** `Collections.RequestOptions`
696
646
 
697
647
  </dd>
@@ -717,7 +667,9 @@ await client.collections.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b
717
667
  <dl>
718
668
  <dd>
719
669
 
720
- List of all pages for a site </br></br> Required scope | `pages:read`
670
+ List of all pages for a site.
671
+
672
+ Required scope | `pages:read`
721
673
 
722
674
  </dd>
723
675
  </dl>
@@ -734,7 +686,7 @@ List of all pages for a site </br></br> Required scope | `pages:read`
734
686
 
735
687
  ```typescript
736
688
  await client.pages.list("580e63e98c9a982ac9b8b741", {
737
- locale: "65427cf400e02b306eaa04a0",
689
+ localeId: "65427cf400e02b306eaa04a0",
738
690
  });
739
691
  ```
740
692
 
@@ -790,7 +742,9 @@ await client.pages.list("580e63e98c9a982ac9b8b741", {
790
742
  <dl>
791
743
  <dd>
792
744
 
793
- Get metadata information for a single page </br></br> Required scope | `pages:read`
745
+ Get metadata information for a single page.
746
+
747
+ Required scope | `pages:read`
794
748
 
795
749
  </dd>
796
750
  </dl>
@@ -807,7 +761,7 @@ Get metadata information for a single page </br></br> Required scope | `pages:re
807
761
 
808
762
  ```typescript
809
763
  await client.pages.getMetadata("63c720f9347c2139b248e552", {
810
- locale: "65427cf400e02b306eaa04a0",
764
+ localeId: "65427cf400e02b306eaa04a0",
811
765
  });
812
766
  ```
813
767
 
@@ -863,7 +817,9 @@ await client.pages.getMetadata("63c720f9347c2139b248e552", {
863
817
  <dl>
864
818
  <dd>
865
819
 
866
- Update Page-level metadata, including SEO and Open Graph fields. </br></br> Required scope | `pages:write`
820
+ Update Page-level metadata, including SEO and Open Graph fields.
821
+
822
+ Required scope | `pages:write`
867
823
 
868
824
  </dd>
869
825
  </dl>
@@ -880,19 +836,18 @@ Update Page-level metadata, including SEO and Open Graph fields. </br></br> Requ
880
836
 
881
837
  ```typescript
882
838
  await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
883
- locale: "65427cf400e02b306eaa04a0",
839
+ localeId: "65427cf400e02b306eaa04a0",
884
840
  body: {
885
841
  id: "6596da6045e56dee495bcbba",
886
842
  siteId: "6258612d1ee792848f805dcf",
887
843
  title: "Guide to the Galaxy",
888
844
  slug: "guide-to-the-galaxy",
889
- parentId: "6419db964a9c435aa3af6251",
890
- collectionId: "6390c49774a71f12831a08e3",
891
845
  createdOn: "2024-03-11T10:42:00Z",
892
846
  lastUpdated: "2024-03-11T10:42:42Z",
893
847
  archived: false,
894
848
  draft: false,
895
849
  canBranch: true,
850
+ isBranch: false,
896
851
  seo: {
897
852
  title: "The Ultimate Hitchhiker's Guide to the Galaxy",
898
853
  description:
@@ -962,7 +917,11 @@ await client.pages.updatePageSettings("63c720f9347c2139b248e552", {
962
917
  <dl>
963
918
  <dd>
964
919
 
965
- Get static content from a static page. </br> If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale</br></br> Required scope | `pages:read`
920
+ Get static content from a static page.
921
+
922
+ If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale.
923
+
924
+ Required scope | `pages:read`
966
925
 
967
926
  </dd>
968
927
  </dl>
@@ -979,7 +938,7 @@ Get static content from a static page. </br> If you do not provide a Locale ID i
979
938
 
980
939
  ```typescript
981
940
  await client.pages.getContent("63c720f9347c2139b248e552", {
982
- locale: "65427cf400e02b306eaa04a0",
941
+ localeId: "65427cf400e02b306eaa04a0",
983
942
  });
984
943
  ```
985
944
 
@@ -1056,19 +1015,19 @@ Required scope | `pages:write`
1056
1015
 
1057
1016
  ```typescript
1058
1017
  await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
1059
- locale: "locale",
1018
+ localeId: "65427cf400e02b306eaa04a0",
1060
1019
  nodes: [
1061
1020
  {
1062
1021
  nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad623",
1063
- text: "<h1>The Hitchhiker's Guide to the Galaxy</h1>",
1022
+ text: "<h1>The Hitchhiker\u2019s Guide to the Galaxy</h1>",
1064
1023
  },
1065
1024
  {
1066
1025
  nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad627",
1067
- text: "<div><h3>Don't Panic!</h3><p>Always know where your towel is.</p></div>",
1026
+ text: "<div><h3>Don\u2019t Panic!</h3><p>Always know where your towel is.</p></div>",
1068
1027
  },
1069
1028
  {
1070
1029
  nodeId: "a245c12d-995b-55ee-5ec7-aa36a6cad629",
1071
- text: "<img alt='Marvin, the Paranoid Android' src='path/to/image/with/assetId/659595234426a9fcbad57043'/>",
1030
+ text: '<img alt="Marvin, the Paranoid Android" src="path/to/image/with/assetId/659595234426a9fcbad57043"/>',
1072
1031
  },
1073
1032
  ],
1074
1033
  });
@@ -1128,7 +1087,16 @@ await client.pages.updateStaticContent("63c720f9347c2139b248e552", {
1128
1087
  <dl>
1129
1088
  <dd>
1130
1089
 
1131
- List of scripts registered to a Site. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:read`
1090
+ List of scripts registered to a Site.
1091
+
1092
+ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
1093
+ to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
1094
+ `custom_code` endpoints.
1095
+ Additionally, Scripts can be remotely hosted, or registered as inline snippets.
1096
+
1097
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
1098
+
1099
+ Required scope | `custom_code:read`
1132
1100
 
1133
1101
  </dd>
1134
1102
  </dl>
@@ -1191,7 +1159,16 @@ await client.scripts.list("580e63e98c9a982ac9b8b741");
1191
1159
  <dl>
1192
1160
  <dd>
1193
1161
 
1194
- Add a script to a Site's Custom Code registry. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. Additionally, Scripts can be remotely hosted, or registered as inline snippets. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> </br></br> Required scope | `custom_code:write`
1162
+ Add a script to a Site's Custom Code registry.
1163
+
1164
+ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
1165
+ to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
1166
+ `custom_code` endpoints.
1167
+ Additionally, Scripts can be remotely hosted, or registered as inline snippets.
1168
+
1169
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
1170
+
1171
+ Required scope | `custom_code:write`
1195
1172
 
1196
1173
  </dd>
1197
1174
  </dl>
@@ -1267,7 +1244,15 @@ await client.scripts.registerHosted("580e63e98c9a982ac9b8b741", {
1267
1244
  <dl>
1268
1245
  <dd>
1269
1246
 
1270
- Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. </br></br> <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:write`
1247
+ Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters.
1248
+
1249
+ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
1250
+ to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
1251
+ `custom_code` endpoints.
1252
+
1253
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
1254
+
1255
+ Required scope | `custom_code:write`
1271
1256
 
1272
1257
  </dd>
1273
1258
  </dl>
@@ -1344,7 +1329,9 @@ await client.scripts.registerInline("580e63e98c9a982ac9b8b741", {
1344
1329
  <dl>
1345
1330
  <dd>
1346
1331
 
1347
- List assets for a given site </br></br> Required scope | `assets:read`
1332
+ List assets for a given site
1333
+
1334
+ Required scope | `assets:read`
1348
1335
 
1349
1336
  </dd>
1350
1337
  </dl>
@@ -1407,7 +1394,13 @@ await client.assets.list("580e63e98c9a982ac9b8b741");
1407
1394
  <dl>
1408
1395
  <dd>
1409
1396
 
1410
- Create a new asset entry. </br></br> This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) request to the `uploadUrl` with the `uploadDetails` object as your header information in the request. </br></br> Required scope | `assets:write`
1397
+ Create a new asset entry.
1398
+
1399
+ This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`.
1400
+ You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html)
1401
+ request to the `uploadUrl` with the `uploadDetails` object as your header information in the request.
1402
+
1403
+ Required scope | `assets:write`
1411
1404
 
1412
1405
  </dd>
1413
1406
  </dl>
@@ -1481,7 +1474,9 @@ await client.assets.create("580e63e98c9a982ac9b8b741", {
1481
1474
  <dl>
1482
1475
  <dd>
1483
1476
 
1484
- Get an Asset </br></br> Required scope | `assets:read`
1477
+ Get an Asset
1478
+
1479
+ Required scope | `assets:read`
1485
1480
 
1486
1481
  </dd>
1487
1482
  </dl>
@@ -1546,6 +1541,8 @@ await client.assets.get("580e63fc8c9a982ac9b8b745");
1546
1541
 
1547
1542
  Delete an Asset
1548
1543
 
1544
+ Required Scope: `assets: write`
1545
+
1549
1546
  </dd>
1550
1547
  </dl>
1551
1548
  </dd>
@@ -1607,7 +1604,9 @@ await client.assets.delete("580e63fc8c9a982ac9b8b745");
1607
1604
  <dl>
1608
1605
  <dd>
1609
1606
 
1610
- Update an Asset </br></br> Required scope | `assets:write`
1607
+ Update an Asset
1608
+
1609
+ Required scope | `assets:write`
1611
1610
 
1612
1611
  </dd>
1613
1612
  </dl>
@@ -1623,9 +1622,7 @@ Update an Asset </br></br> Required scope | `assets:write`
1623
1622
  <dd>
1624
1623
 
1625
1624
  ```typescript
1626
- await client.assets.update("580e63fc8c9a982ac9b8b745", {
1627
- displayName: "bulldoze.png",
1628
- });
1625
+ await client.assets.update("580e63fc8c9a982ac9b8b745");
1629
1626
  ```
1630
1627
 
1631
1628
  </dd>
@@ -1680,7 +1677,9 @@ await client.assets.update("580e63fc8c9a982ac9b8b745", {
1680
1677
  <dl>
1681
1678
  <dd>
1682
1679
 
1683
- List Asset Folders within a given site <br><br> Required scope | `assets:read`
1680
+ List Asset Folders within a given site
1681
+
1682
+ Required scope | `assets:read`
1684
1683
 
1685
1684
  </dd>
1686
1685
  </dl>
@@ -1743,7 +1742,9 @@ await client.assets.listFolders("580e63e98c9a982ac9b8b741");
1743
1742
  <dl>
1744
1743
  <dd>
1745
1744
 
1746
- Create an Asset Folder within a given site <br><br> Required scope | `assets:write`
1745
+ Create an Asset Folder within a given site
1746
+
1747
+ Required scope | `assets:write`
1747
1748
 
1748
1749
  </dd>
1749
1750
  </dl>
@@ -1816,7 +1817,9 @@ await client.assets.createFolder("580e63e98c9a982ac9b8b741", {
1816
1817
  <dl>
1817
1818
  <dd>
1818
1819
 
1819
- Get details about a specific Asset Folder <br><br> Required scope | `assets:read`
1820
+ Get details about a specific Asset Folder
1821
+
1822
+ Required scope | `assets:read`
1820
1823
 
1821
1824
  </dd>
1822
1825
  </dl>
@@ -1881,7 +1884,9 @@ await client.assets.getFolder("6390c49774a71f0e3c1a08ee");
1881
1884
  <dl>
1882
1885
  <dd>
1883
1886
 
1884
- List all App-created Webhooks registered for a given site </br></br> Required scope | `sites:read`
1887
+ List all App-created Webhooks registered for a given site
1888
+
1889
+ Required scope | `sites:read`
1885
1890
 
1886
1891
  </dd>
1887
1892
  </dl>
@@ -1944,8 +1949,12 @@ await client.webhooks.list("580e63e98c9a982ac9b8b741");
1944
1949
  <dl>
1945
1950
  <dd>
1946
1951
 
1947
- Create a new Webhook, to be notified when Webflow resources change. Limit of 75 registrations per `triggerType`, per site. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `sites:write`
1952
+ Create a new Webhook.
1948
1953
 
1954
+ Limit of 75 registrations per `triggerType`, per site.
1955
+
1956
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
1957
+ Required scope | `sites:write`
1949
1958
  </dd>
1950
1959
  </dl>
1951
1960
  </dd>
@@ -2025,6 +2034,8 @@ await client.webhooks.create("580e63e98c9a982ac9b8b741", {
2025
2034
 
2026
2035
  Get a specific Webhook instance
2027
2036
 
2037
+ Required scope: `sites:read`
2038
+
2028
2039
  </dd>
2029
2040
  </dl>
2030
2041
  </dd>
@@ -2088,6 +2099,8 @@ await client.webhooks.get("580e64008c9a982ac9b8b754");
2088
2099
 
2089
2100
  Remove a Webhook
2090
2101
 
2102
+ Required scope: `sites:read`
2103
+
2091
2104
  </dd>
2092
2105
  </dl>
2093
2106
  </dd>
@@ -2151,7 +2164,9 @@ await client.webhooks.delete("580e64008c9a982ac9b8b754");
2151
2164
  <dl>
2152
2165
  <dd>
2153
2166
 
2154
- List forms for a given site </br></br> Required scope | `forms:read`
2167
+ List forms for a given site.
2168
+
2169
+ Required scope | `forms:read`
2155
2170
 
2156
2171
  </dd>
2157
2172
  </dl>
@@ -2222,7 +2237,9 @@ await client.forms.list("580e63e98c9a982ac9b8b741");
2222
2237
  <dl>
2223
2238
  <dd>
2224
2239
 
2225
- Get information about a given form</br></br> Required scope | `forms:read`
2240
+ Get information about a given form.
2241
+
2242
+ Required scope | `forms:read`
2226
2243
 
2227
2244
  </dd>
2228
2245
  </dl>
@@ -2285,7 +2302,9 @@ await client.forms.get("580e63e98c9a982ac9b8b741");
2285
2302
  <dl>
2286
2303
  <dd>
2287
2304
 
2288
- List form submissions for a given form </br></br> Required scope | `forms:read`
2305
+ List form submissions for a given form
2306
+
2307
+ Required scope | `forms:read`
2289
2308
 
2290
2309
  </dd>
2291
2310
  </dl>
@@ -2356,7 +2375,9 @@ await client.forms.listSubmissions("580e63e98c9a982ac9b8b741");
2356
2375
  <dl>
2357
2376
  <dd>
2358
2377
 
2359
- Get information about a given form submission</br></br> Required scope | `forms:read`
2378
+ Get information about a given form submissio.
2379
+
2380
+ Required scope | `forms:read`
2360
2381
 
2361
2382
  </dd>
2362
2383
  </dl>
@@ -2419,7 +2440,9 @@ await client.forms.getSubmission("580e63e98c9a982ac9b8b741");
2419
2440
  <dl>
2420
2441
  <dd>
2421
2442
 
2422
- Update hidden fields on a form submission</br></br> Required scope | `forms:write`
2443
+ Update hidden fields on a form submission
2444
+
2445
+ Required scope | `forms:write`
2423
2446
 
2424
2447
  </dd>
2425
2448
  </dl>
@@ -2492,7 +2515,9 @@ await client.forms.updateSubmission("580e63e98c9a982ac9b8b741");
2492
2515
  <dl>
2493
2516
  <dd>
2494
2517
 
2495
- Get a list of users for a site <br><br> Required scope | `users:read`
2518
+ Get a list of users for a site
2519
+
2520
+ Required scope | `users:read`
2496
2521
 
2497
2522
  </dd>
2498
2523
  </dl>
@@ -2563,7 +2588,9 @@ await client.users.list("580e63e98c9a982ac9b8b741");
2563
2588
  <dl>
2564
2589
  <dd>
2565
2590
 
2566
- Get a User by ID <br><br> Required scope | `users:read`
2591
+ Get a User by ID
2592
+
2593
+ Required scope | `users:read`
2567
2594
 
2568
2595
  </dd>
2569
2596
  </dl>
@@ -2634,7 +2661,9 @@ await client.users.get("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741");
2634
2661
  <dl>
2635
2662
  <dd>
2636
2663
 
2637
- Delete a User by ID <br><br> Required scope | `users:write`
2664
+ Delete a User by ID
2665
+
2666
+ Required scope | `users:write`
2638
2667
 
2639
2668
  </dd>
2640
2669
  </dl>
@@ -2705,9 +2734,13 @@ await client.users.delete("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
2705
2734
  <dl>
2706
2735
  <dd>
2707
2736
 
2708
- Update a User by ID <br><br> Required scope | `users:write`
2737
+ Update a User by ID
2738
+
2739
+ Required scope | `users:write`
2740
+
2741
+ <Note class="notice">The <code>email</code> and <code>password</code>
2742
+ fields cannot be updated using this endpoint</Note>
2709
2743
 
2710
- <aside class="notice">The <code>email</code> and <code>password</code> fields cannot be updated using this endpoint</aside>
2711
2744
  </dd>
2712
2745
  </dl>
2713
2746
  </dd>
@@ -2792,7 +2825,11 @@ await client.users.update("580e63e98c9a982ac9b8b741", "580e63e98c9a982ac9b8b741"
2792
2825
  <dl>
2793
2826
  <dd>
2794
2827
 
2795
- Create and invite a user with an email address. The user will be sent and invite via email, which they will need to accept in order to join paid Access Groups. <br><br> Required scope | `users:write`
2828
+ Create and invite a user with an email address.
2829
+
2830
+ The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group.
2831
+
2832
+ Required scope | `users:write`
2796
2833
 
2797
2834
  </dd>
2798
2835
  </dl>
@@ -2868,7 +2905,9 @@ await client.users.invite("580e63e98c9a982ac9b8b741", {
2868
2905
  <dl>
2869
2906
  <dd>
2870
2907
 
2871
- Get a list of access groups for a site <br><br> Required scope | `users:read`
2908
+ Get a list of access groups for a site
2909
+
2910
+ Required scope | `users:read`
2872
2911
 
2873
2912
  </dd>
2874
2913
  </dl>
@@ -2941,7 +2980,10 @@ await client.accessGroups.list("580e63e98c9a982ac9b8b741");
2941
2980
  <dl>
2942
2981
  <dd>
2943
2982
 
2944
- Retrieve all products for a site. Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
2983
+ Retrieve all products for a site.
2984
+
2985
+ Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
2986
+ will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
2945
2987
 
2946
2988
  Required scope | `ecommerce:read`
2947
2989
 
@@ -3014,13 +3056,19 @@ await client.products.list("580e63e98c9a982ac9b8b741");
3014
3056
  <dl>
3015
3057
  <dd>
3016
3058
 
3017
- Creating a new Product involves creating both a Product and a SKU, since a Product Item has to have, at minimum, a single SKU.
3059
+ Create a new product and SKU.
3060
+
3061
+ When you create a product, you will always create a SKU, since a Product Item must have, at minimum, a single SKU.
3018
3062
 
3019
- In order to create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large - you'll need to create `sku-properties`. In our T-shirt example, a single `sku-property` would be Color. Within that property, we'll need to list out the various colors a T-shirt could be as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`.
3063
+ To create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large:
3020
3064
 
3021
- Once, you've created a Product and its `sku-properties` with `enum` values, you can create your default SKU, which will automatically be a combination of the first `sku-properties` you've created. In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. After you've created your product, you can create additional SKUs using the <a href="https://developers.webflow.com/reference/create-skus">Create SKU endpoint</a>
3065
+ - Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants).
3066
+ - A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`.
3067
+ - Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created.
3068
+ - In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue.
3069
+ - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products-sk-us/create-sku)
3022
3070
 
3023
- Upon creation, the default product type will be `Advanced`. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown.
3071
+ Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
3024
3072
 
3025
3073
  Required scope | `ecommerce:write`
3026
3074
 
@@ -3093,7 +3141,8 @@ await client.products.create("580e63e98c9a982ac9b8b741");
3093
3141
  <dl>
3094
3142
  <dd>
3095
3143
 
3096
- Retrieve a single product by its id. All of its SKUs will also be retrieved.
3144
+ Retrieve a single product by its ID. All of its SKUs will also be
3145
+ retrieved.
3097
3146
 
3098
3147
  Required scope | `ecommerce:read`
3099
3148
 
@@ -3166,7 +3215,9 @@ await client.products.get("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b745"
3166
3215
  <dl>
3167
3216
  <dd>
3168
3217
 
3169
- Updating an existing Product will set the product type to `Advanced`. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.
3218
+ Update an existing Product.
3219
+
3220
+ Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
3170
3221
 
3171
3222
  Required scope | `ecommerce:write`
3172
3223
 
@@ -3247,9 +3298,9 @@ await client.products.update("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b8b7
3247
3298
  <dl>
3248
3299
  <dd>
3249
3300
 
3250
- Create additional SKUs to cover every variant of your Product. The Default SKU already counts as one of the variants.
3301
+ Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants)
3251
3302
 
3252
- Creating additional SKUs will set the product type to `Advanced` for the product associated with the SKUs. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.
3303
+ Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
3253
3304
 
3254
3305
  Required scope | `ecommerce:write`
3255
3306
 
@@ -3332,7 +3383,9 @@ await client.products.createSku("580e63e98c9a982ac9b8b741", "580e63fc8c9a982ac9b
3332
3383
  <dl>
3333
3384
  <dd>
3334
3385
 
3335
- Updating an existing SKU will set the product type to `Advanced` for the product associated with the SKU. The product type is used to determine which Product and SKU fields are shown to users in the `Designer` and the `Editor`. Setting it to `Advanced` ensures that all Product and SKU fields will be shown. The product type can be edited in the `Designer` or the `Editor`.
3386
+ Update a specified SKU.
3387
+
3388
+ Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
3336
3389
 
3337
3390
  Required scope | `ecommerce:write`
3338
3391
 
@@ -3498,7 +3551,8 @@ await client.orders.list("580e63e98c9a982ac9b8b741");
3498
3551
  <dl>
3499
3552
  <dd>
3500
3553
 
3501
- Retrieve a single product by its id. All of its SKUs will also be retrieved.
3554
+ Retrieve a single product by its ID. All of its SKUs will also be
3555
+ retrieved.
3502
3556
 
3503
3557
  Required scope | `ecommerce:read`
3504
3558
 
@@ -3571,7 +3625,9 @@ await client.orders.get("580e63e98c9a982ac9b8b741", "5e8518516e147040726cc415");
3571
3625
  <dl>
3572
3626
  <dd>
3573
3627
 
3574
- This API lets you update the fields, `comment`, `shippingProvider`, and/or `shippingTracking` for a given order. All three fields can be updated simultaneously or independently.
3628
+ This API lets you update the fields, `comment`, `shippingProvider`,
3629
+ and/or `shippingTracking` for a given order. All three fields can be
3630
+ updated simultaneously or independently.
3575
3631
 
3576
3632
  Required scope | `ecommerce:write`
3577
3633
 
@@ -3963,7 +4019,12 @@ await client.inventory.list("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b75
3963
4019
  <dl>
3964
4020
  <dd>
3965
4021
 
3966
- Updates the current inventory levels for a particular SKU item. Updates may be given in one or two methods, absolutely or incrementally. Absolute updates are done by setting `quantity` directly. Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
4022
+ Updates the current inventory levels for a particular SKU item.
4023
+
4024
+ Updates may be given in one or two methods, absolutely or incrementally.
4025
+
4026
+ - Absolute updates are done by setting `quantity` directly.
4027
+ - Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server.
3967
4028
 
3968
4029
  Required scope | `ecommerce:write`
3969
4030
 
@@ -4115,7 +4176,16 @@ await client.ecommerce.getSettings("580e63e98c9a982ac9b8b741");
4115
4176
  <dl>
4116
4177
  <dd>
4117
4178
 
4118
- Create a custom field in a collection. </br></br> Slugs must be all lowercase letters without spaces. If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will convert the slug to lowercase and replace spaces with "-." </br></br> Only some field types can be created through the API. This endpoint does not currently support bulk creation. </br></br> Required scope | `cms:write`
4179
+ Create a custom field in a collection.
4180
+
4181
+ Slugs must be all lowercase letters without spaces.
4182
+ If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will
4183
+ convert the slug to lowercase and replace spaces with "-."
4184
+
4185
+ Only some field types can be created through the API.
4186
+ This endpoint does not currently support bulk creation.
4187
+
4188
+ Required scope | `cms:write`
4119
4189
 
4120
4190
  </dd>
4121
4191
  </dl>
@@ -4179,7 +4249,7 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
4179
4249
  </dl>
4180
4250
  </details>
4181
4251
 
4182
- <details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">update</a>(collectionId, fieldId, { ...params }) -> Webflow.Field</code></summary>
4252
+ <details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">delete</a>(collectionId, fieldId) -> void</code></summary>
4183
4253
  <dl>
4184
4254
  <dd>
4185
4255
 
@@ -4191,7 +4261,9 @@ await client.collections.fields.create("580e63fc8c9a982ac9b8b745", {
4191
4261
  <dl>
4192
4262
  <dd>
4193
4263
 
4194
- Update a custom field in a collection. </br></br> Required scope | `cms:write`
4264
+ Delete a custom field in a collection. This endpoint does not currently support bulk deletion.
4265
+
4266
+ Required scope | `cms:write`
4195
4267
 
4196
4268
  </dd>
4197
4269
  </dl>
@@ -4207,11 +4279,7 @@ Update a custom field in a collection. </br></br> Required scope | `cms:write`
4207
4279
  <dd>
4208
4280
 
4209
4281
  ```typescript
4210
- await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b8b745", {
4211
- isRequired: false,
4212
- displayName: "Post Body",
4213
- helpText: "Add the body of your post here",
4214
- });
4282
+ await client.collections.fields.delete("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b8b745");
4215
4283
  ```
4216
4284
 
4217
4285
  </dd>
@@ -4243,14 +4311,6 @@ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
4243
4311
  <dl>
4244
4312
  <dd>
4245
4313
 
4246
- **request:** `Webflow.collections.FieldUpdate`
4247
-
4248
- </dd>
4249
- </dl>
4250
-
4251
- <dl>
4252
- <dd>
4253
-
4254
4314
  **requestOptions:** `Fields.RequestOptions`
4255
4315
 
4256
4316
  </dd>
@@ -4262,9 +4322,7 @@ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
4262
4322
  </dl>
4263
4323
  </details>
4264
4324
 
4265
- ## Collections Items
4266
-
4267
- <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">listItems</a>(collectionId, { ...params }) -> Webflow.CollectionItemList</code></summary>
4325
+ <details><summary><code>client.collections.fields.<a href="/src/api/resources/collections/resources/fields/client/Client.ts">update</a>(collectionId, fieldId, { ...params }) -> Webflow.Field</code></summary>
4268
4326
  <dl>
4269
4327
  <dd>
4270
4328
 
@@ -4276,7 +4334,9 @@ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a
4276
4334
  <dl>
4277
4335
  <dd>
4278
4336
 
4279
- List of all Items within a Collection. </br></br> Required scope | `CMS:read`
4337
+ Update a custom field in a collection.
4338
+
4339
+ Required scope | `cms:write`
4280
4340
 
4281
4341
  </dd>
4282
4342
  </dl>
@@ -4292,7 +4352,11 @@ List of all Items within a Collection. </br></br> Required scope | `CMS:read`
4292
4352
  <dd>
4293
4353
 
4294
4354
  ```typescript
4295
- await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
4355
+ await client.collections.fields.update("580e63fc8c9a982ac9b8b745", "580e63fc8c9a982ac9b8b745", {
4356
+ isRequired: false,
4357
+ displayName: "Post Body",
4358
+ helpText: "Add the body of your post here",
4359
+ });
4296
4360
  ```
4297
4361
 
4298
4362
  </dd>
@@ -4316,7 +4380,7 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
4316
4380
  <dl>
4317
4381
  <dd>
4318
4382
 
4319
- **request:** `Webflow.collections.ItemsListItemsRequest`
4383
+ **fieldId:** `string` — Unique identifier for a Field in a collection
4320
4384
 
4321
4385
  </dd>
4322
4386
  </dl>
@@ -4324,7 +4388,15 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
4324
4388
  <dl>
4325
4389
  <dd>
4326
4390
 
4327
- **requestOptions:** `Items.RequestOptions`
4391
+ **request:** `Webflow.collections.FieldUpdate`
4392
+
4393
+ </dd>
4394
+ </dl>
4395
+
4396
+ <dl>
4397
+ <dd>
4398
+
4399
+ **requestOptions:** `Fields.RequestOptions`
4328
4400
 
4329
4401
  </dd>
4330
4402
  </dl>
@@ -4335,7 +4407,9 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
4335
4407
  </dl>
4336
4408
  </details>
4337
4409
 
4338
- <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItem</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
4410
+ ## Collections Items
4411
+
4412
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">listItems</a>(collectionId, { ...params }) -> Webflow.CollectionItemList</code></summary>
4339
4413
  <dl>
4340
4414
  <dd>
4341
4415
 
@@ -4347,7 +4421,10 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
4347
4421
  <dl>
4348
4422
  <dd>
4349
4423
 
4350
- <style>.rm-Markdown.markdown-body a{color: #146EF5 !important;}</style> Create Item in a Collection.</br></br> To create items across multiple locales, <a href="https://developers.webflow.com/data/reference/create-item-for-multiple-locales"> please use the bulk item endpoint.</a> </br></br> Required scope | <code>CMS:write</code>
4424
+ List of all Items within a Collection.
4425
+
4426
+ Required scope | `CMS:read`
4427
+
4351
4428
  </dd>
4352
4429
  </dl>
4353
4430
  </dd>
@@ -4362,19 +4439,7 @@ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
4362
4439
  <dd>
4363
4440
 
4364
4441
  ```typescript
4365
- await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
4366
- id: "42b720ef280c7a7a3be8cabe",
4367
- cmsLocaleId: "653ad57de882f528b32e810e",
4368
- lastPublished: "2022-11-29T16:22:43.159Z",
4369
- lastUpdated: "2022-11-17T17:19:43.282Z",
4370
- createdOn: "2022-11-17T17:11:57.148Z",
4371
- isArchived: false,
4372
- isDraft: false,
4373
- fieldData: {
4374
- name: "Pan Galactic Gargle Blaster Recipe",
4375
- slug: "pan-galactic-gargle-blaster",
4376
- },
4377
- });
4442
+ await client.collections.items.listItems("580e63fc8c9a982ac9b8b745");
4378
4443
  ```
4379
4444
 
4380
4445
  </dd>
@@ -4398,7 +4463,7 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
4398
4463
  <dl>
4399
4464
  <dd>
4400
4465
 
4401
- **request:** `Webflow.CollectionItem`
4466
+ **request:** `Webflow.collections.ItemsListItemsRequest`
4402
4467
 
4403
4468
  </dd>
4404
4469
  </dl>
@@ -4417,7 +4482,7 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
4417
4482
  </dl>
4418
4483
  </details>
4419
4484
 
4420
- <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">listItemsLive</a>(collectionId, { ...params }) -> Webflow.CollectionItemList</code></summary>
4485
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItem</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
4421
4486
  <dl>
4422
4487
  <dd>
4423
4488
 
@@ -4429,7 +4494,11 @@ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
4429
4494
  <dl>
4430
4495
  <dd>
4431
4496
 
4432
- List of all live Items within a Collection. </br></br> Required scope | `CMS:read`
4497
+ Create Item(s) in a Collection.
4498
+
4499
+ To create items across multiple locales, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/bulk-items/create-items)
4500
+
4501
+ Required scope | `CMS:write`
4433
4502
 
4434
4503
  </dd>
4435
4504
  </dl>
@@ -4445,7 +4514,14 @@ List of all live Items within a Collection. </br></br> Required scope | `CMS:rea
4445
4514
  <dd>
4446
4515
 
4447
4516
  ```typescript
4448
- await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
4517
+ await client.collections.items.createItem("580e63fc8c9a982ac9b8b745", {
4518
+ isArchived: false,
4519
+ isDraft: false,
4520
+ fieldData: {
4521
+ name: "Pan Galactic Gargle Blaster Recipe",
4522
+ slug: "pan-galactic-gargle-blaster",
4523
+ },
4524
+ });
4449
4525
  ```
4450
4526
 
4451
4527
  </dd>
@@ -4469,7 +4545,7 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
4469
4545
  <dl>
4470
4546
  <dd>
4471
4547
 
4472
- **request:** `Webflow.collections.ItemsListItemsLiveRequest`
4548
+ **request:** `Webflow.ItemsCreateItemRequest`
4473
4549
 
4474
4550
  </dd>
4475
4551
  </dl>
@@ -4488,7 +4564,7 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
4488
4564
  </dl>
4489
4565
  </details>
4490
4566
 
4491
- <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItemLive</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
4567
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItems</a>(collectionId, { ...params }) -> void</code></summary>
4492
4568
  <dl>
4493
4569
  <dd>
4494
4570
 
@@ -4500,7 +4576,11 @@ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
4500
4576
  <dl>
4501
4577
  <dd>
4502
4578
 
4503
- Create live Item in a Collection. This Item will be published to the live site. </br></br> To create items across multiple locales, <a href="https://developers.webflow.com/data/reference/create-item-for-multiple-locales"> please use this endpoint.</a> </br></br> Required scope | `CMS:write`
4579
+ Delete Items from a Collection.
4580
+
4581
+ **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be deleted only in the primary locale.
4582
+
4583
+ Required scope | `CMS:write`
4504
4584
 
4505
4585
  </dd>
4506
4586
  </dl>
@@ -4516,19 +4596,7 @@ Create live Item in a Collection. This Item will be published to the live site.
4516
4596
  <dd>
4517
4597
 
4518
4598
  ```typescript
4519
- await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
4520
- id: "42b720ef280c7a7a3be8cabe",
4521
- cmsLocaleId: "653ad57de882f528b32e810e",
4522
- lastPublished: "2022-11-29T16:22:43.159Z",
4523
- lastUpdated: "2022-11-17T17:19:43.282Z",
4524
- createdOn: "2022-11-17T17:11:57.148Z",
4525
- isArchived: false,
4526
- isDraft: false,
4527
- fieldData: {
4528
- name: "Pan Galactic Gargle Blaster Recipe",
4529
- slug: "pan-galactic-gargle-blaster",
4530
- },
4531
- });
4599
+ await client.collections.items.deleteItems("580e63fc8c9a982ac9b8b745");
4532
4600
  ```
4533
4601
 
4534
4602
  </dd>
@@ -4552,7 +4620,7 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
4552
4620
  <dl>
4553
4621
  <dd>
4554
4622
 
4555
- **request:** `Webflow.CollectionItem`
4623
+ **request:** `Webflow.collections.ItemsDeleteItemsRequest`
4556
4624
 
4557
4625
  </dd>
4558
4626
  </dl>
@@ -4571,7 +4639,7 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
4571
4639
  </dl>
4572
4640
  </details>
4573
4641
 
4574
- <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItemForMultipleLocales</a>(collectionId, { ...params }) -> Webflow.BulkCollectionItem</code></summary>
4642
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">updateItems</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
4575
4643
  <dl>
4576
4644
  <dd>
4577
4645
 
@@ -4583,7 +4651,11 @@ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
4583
4651
  <dl>
4584
4652
  <dd>
4585
4653
 
4586
- Create single Item in a Collection with multiple corresponding locales. </br></br> Required scope | `CMS:write`
4654
+ Update a single item or multiple items (up to 100) in a Collection.
4655
+
4656
+ **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.
4657
+
4658
+ Required scope | `CMS:write`
4587
4659
 
4588
4660
  </dd>
4589
4661
  </dl>
@@ -4599,8 +4671,41 @@ Create single Item in a Collection with multiple corresponding locales. </br></b
4599
4671
  <dd>
4600
4672
 
4601
4673
  ```typescript
4602
- await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b8b745", {
4603
- id: "580e64008c9a982ac9b8b754",
4674
+ await client.collections.items.updateItems("580e63fc8c9a982ac9b8b745", {
4675
+ items: [
4676
+ {
4677
+ id: "66f6ed9576ddacf3149d5ea6",
4678
+ cmsLocaleId: "66f6e966c9e1dc700a857ca5",
4679
+ fieldData: {
4680
+ name: "Ne Paniquez Pas",
4681
+ slug: "ne-paniquez-pas",
4682
+ },
4683
+ },
4684
+ {
4685
+ id: "66f6ed9576ddacf3149d5ea6",
4686
+ cmsLocaleId: "66f6e966c9e1dc700a857ca4",
4687
+ fieldData: {
4688
+ name: "No Entrar en P\u00E1nico",
4689
+ slug: "no-entrar-en-panico",
4690
+ },
4691
+ },
4692
+ {
4693
+ id: "66f6ed9576ddacf3149d5eaa",
4694
+ cmsLocaleId: "66f6e966c9e1dc700a857ca5",
4695
+ fieldData: {
4696
+ name: "Au Revoir et Merci pour Tous les Poissons",
4697
+ slug: "au-revoir-et-merci",
4698
+ },
4699
+ },
4700
+ {
4701
+ id: "66f6ed9576ddacf3149d5eaa",
4702
+ cmsLocaleId: "66f6e966c9e1dc700a857ca4",
4703
+ fieldData: {
4704
+ name: "Hasta Luego y Gracias por Todo el Pescado",
4705
+ slug: "hasta-luego-y-gracias",
4706
+ },
4707
+ },
4708
+ ],
4604
4709
  });
4605
4710
  ```
4606
4711
 
@@ -4625,7 +4730,7 @@ await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b
4625
4730
  <dl>
4626
4731
  <dd>
4627
4732
 
4628
- **request:** `Webflow.BulkCollectionItem`
4733
+ **request:** `Webflow.collections.ItemsUpdateItemsRequest`
4629
4734
 
4630
4735
  </dd>
4631
4736
  </dl>
@@ -4644,7 +4749,7 @@ await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b
4644
4749
  </dl>
4645
4750
  </details>
4646
4751
 
4647
- <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">getItem</a>(collectionId, itemId, { ...params }) -> Webflow.CollectionItem</code></summary>
4752
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">listItemsLive</a>(collectionId, { ...params }) -> Webflow.CollectionItemList</code></summary>
4648
4753
  <dl>
4649
4754
  <dd>
4650
4755
 
@@ -4656,7 +4761,9 @@ await client.collections.items.createItemForMultipleLocales("580e63fc8c9a982ac9b
4656
4761
  <dl>
4657
4762
  <dd>
4658
4763
 
4659
- Get details of a selected Collection Item. </br></br> Required scope | `CMS:read`
4764
+ List of all live Items within a Collection.
4765
+
4766
+ Required scope | `CMS:read`
4660
4767
 
4661
4768
  </dd>
4662
4769
  </dl>
@@ -4672,7 +4779,7 @@ Get details of a selected Collection Item. </br></br> Required scope | `CMS:read
4672
4779
  <dd>
4673
4780
 
4674
4781
  ```typescript
4675
- await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
4782
+ await client.collections.items.listItemsLive("580e63fc8c9a982ac9b8b745");
4676
4783
  ```
4677
4784
 
4678
4785
  </dd>
@@ -4696,15 +4803,7 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
4696
4803
  <dl>
4697
4804
  <dd>
4698
4805
 
4699
- **itemId:** `string` — Unique identifier for an Item
4700
-
4701
- </dd>
4702
- </dl>
4703
-
4704
- <dl>
4705
- <dd>
4706
-
4707
- **request:** `Webflow.collections.ItemsGetItemRequest`
4806
+ **request:** `Webflow.collections.ItemsListItemsLiveRequest`
4708
4807
 
4709
4808
  </dd>
4710
4809
  </dl>
@@ -4723,7 +4822,7 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
4723
4822
  </dl>
4724
4823
  </details>
4725
4824
 
4726
- <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItem</a>(collectionId, itemId, { ...params }) -> void</code></summary>
4825
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItemLive</a>(collectionId, { ...params }) -> Webflow.CollectionItem</code></summary>
4727
4826
  <dl>
4728
4827
  <dd>
4729
4828
 
@@ -4735,7 +4834,11 @@ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a
4735
4834
  <dl>
4736
4835
  <dd>
4737
4836
 
4738
- Delete an Item from a Collection. This endpoint does not currently support bulk deletion. </br></br> Required scope | `CMS:write`
4837
+ Create live Item(s) in a Collection. The Item(s) will be published to the live site.
4838
+
4839
+ To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/bulk-items/create-items)
4840
+
4841
+ Required scope | `CMS:write`
4739
4842
 
4740
4843
  </dd>
4741
4844
  </dl>
@@ -4751,10 +4854,442 @@ Delete an Item from a Collection. This endpoint does not currently support bulk
4751
4854
  <dd>
4752
4855
 
4753
4856
  ```typescript
4754
- await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
4755
- ```
4756
-
4757
- </dd>
4857
+ await client.collections.items.createItemLive("580e63fc8c9a982ac9b8b745", {
4858
+ isArchived: false,
4859
+ isDraft: false,
4860
+ fieldData: {
4861
+ name: "Pan Galactic Gargle Blaster Recipe",
4862
+ slug: "pan-galactic-gargle-blaster",
4863
+ },
4864
+ });
4865
+ ```
4866
+
4867
+ </dd>
4868
+ </dl>
4869
+ </dd>
4870
+ </dl>
4871
+
4872
+ #### ⚙️ Parameters
4873
+
4874
+ <dl>
4875
+ <dd>
4876
+
4877
+ <dl>
4878
+ <dd>
4879
+
4880
+ **collectionId:** `string` — Unique identifier for a Collection
4881
+
4882
+ </dd>
4883
+ </dl>
4884
+
4885
+ <dl>
4886
+ <dd>
4887
+
4888
+ **request:** `Webflow.ItemsCreateItemLiveRequest`
4889
+
4890
+ </dd>
4891
+ </dl>
4892
+
4893
+ <dl>
4894
+ <dd>
4895
+
4896
+ **requestOptions:** `Items.RequestOptions`
4897
+
4898
+ </dd>
4899
+ </dl>
4900
+ </dd>
4901
+ </dl>
4902
+
4903
+ </dd>
4904
+ </dl>
4905
+ </details>
4906
+
4907
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItemsLive</a>(collectionId, { ...params }) -> void</code></summary>
4908
+ <dl>
4909
+ <dd>
4910
+
4911
+ #### 📝 Description
4912
+
4913
+ <dl>
4914
+ <dd>
4915
+
4916
+ <dl>
4917
+ <dd>
4918
+
4919
+ Remove an item or multiple items (up to 100 items) from the live site. Deleting published items will unpublish the items from the live site and set them to draft.
4920
+
4921
+ **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be unpublished only in the primary locale.
4922
+
4923
+ Required scope | `CMS:write`
4924
+
4925
+ </dd>
4926
+ </dl>
4927
+ </dd>
4928
+ </dl>
4929
+
4930
+ #### 🔌 Usage
4931
+
4932
+ <dl>
4933
+ <dd>
4934
+
4935
+ <dl>
4936
+ <dd>
4937
+
4938
+ ```typescript
4939
+ await client.collections.items.deleteItemsLive("580e63fc8c9a982ac9b8b745");
4940
+ ```
4941
+
4942
+ </dd>
4943
+ </dl>
4944
+ </dd>
4945
+ </dl>
4946
+
4947
+ #### ⚙️ Parameters
4948
+
4949
+ <dl>
4950
+ <dd>
4951
+
4952
+ <dl>
4953
+ <dd>
4954
+
4955
+ **collectionId:** `string` — Unique identifier for a Collection
4956
+
4957
+ </dd>
4958
+ </dl>
4959
+
4960
+ <dl>
4961
+ <dd>
4962
+
4963
+ **request:** `Webflow.collections.ItemsDeleteItemsLiveRequest`
4964
+
4965
+ </dd>
4966
+ </dl>
4967
+
4968
+ <dl>
4969
+ <dd>
4970
+
4971
+ **requestOptions:** `Items.RequestOptions`
4972
+
4973
+ </dd>
4974
+ </dl>
4975
+ </dd>
4976
+ </dl>
4977
+
4978
+ </dd>
4979
+ </dl>
4980
+ </details>
4981
+
4982
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">updateItemsLive</a>(collectionId, { ...params }) -> Webflow.CollectionItemListNoPagination</code></summary>
4983
+ <dl>
4984
+ <dd>
4985
+
4986
+ #### 📝 Description
4987
+
4988
+ <dl>
4989
+ <dd>
4990
+
4991
+ <dl>
4992
+ <dd>
4993
+
4994
+ Update a single live item or multiple live items (up to 100) in a Collection
4995
+
4996
+ **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale.
4997
+
4998
+ Required scope | `CMS:write`
4999
+
5000
+ </dd>
5001
+ </dl>
5002
+ </dd>
5003
+ </dl>
5004
+
5005
+ #### 🔌 Usage
5006
+
5007
+ <dl>
5008
+ <dd>
5009
+
5010
+ <dl>
5011
+ <dd>
5012
+
5013
+ ```typescript
5014
+ await client.collections.items.updateItemsLive("580e63fc8c9a982ac9b8b745", {
5015
+ items: [
5016
+ {
5017
+ id: "66f6ed9576ddacf3149d5ea6",
5018
+ cmsLocaleId: "66f6e966c9e1dc700a857ca5",
5019
+ fieldData: {
5020
+ name: "Ne Paniquez Pas",
5021
+ slug: "ne-paniquez-pas",
5022
+ },
5023
+ },
5024
+ {
5025
+ id: "66f6ed9576ddacf3149d5ea6",
5026
+ cmsLocaleId: "66f6e966c9e1dc700a857ca4",
5027
+ fieldData: {
5028
+ name: "No Entrar en P\u00E1nico",
5029
+ slug: "no-entrar-en-panico",
5030
+ },
5031
+ },
5032
+ {
5033
+ id: "66f6ed9576ddacf3149d5eaa",
5034
+ cmsLocaleId: "66f6e966c9e1dc700a857ca5",
5035
+ fieldData: {
5036
+ name: "Au Revoir et Merci pour Tous les Poissons",
5037
+ slug: "au-revoir-et-merci",
5038
+ },
5039
+ },
5040
+ {
5041
+ id: "66f6ed9576ddacf3149d5eaa",
5042
+ cmsLocaleId: "66f6e966c9e1dc700a857ca4",
5043
+ fieldData: {
5044
+ name: "Hasta Luego y Gracias por Todo el Pescado",
5045
+ slug: "hasta-luego-y-gracias",
5046
+ },
5047
+ },
5048
+ ],
5049
+ });
5050
+ ```
5051
+
5052
+ </dd>
5053
+ </dl>
5054
+ </dd>
5055
+ </dl>
5056
+
5057
+ #### ⚙️ Parameters
5058
+
5059
+ <dl>
5060
+ <dd>
5061
+
5062
+ <dl>
5063
+ <dd>
5064
+
5065
+ **collectionId:** `string` — Unique identifier for a Collection
5066
+
5067
+ </dd>
5068
+ </dl>
5069
+
5070
+ <dl>
5071
+ <dd>
5072
+
5073
+ **request:** `Webflow.collections.ItemsUpdateItemsLiveRequest`
5074
+
5075
+ </dd>
5076
+ </dl>
5077
+
5078
+ <dl>
5079
+ <dd>
5080
+
5081
+ **requestOptions:** `Items.RequestOptions`
5082
+
5083
+ </dd>
5084
+ </dl>
5085
+ </dd>
5086
+ </dl>
5087
+
5088
+ </dd>
5089
+ </dl>
5090
+ </details>
5091
+
5092
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">createItems</a>(collectionId, { ...params }) -> Webflow.BulkCollectionItem</code></summary>
5093
+ <dl>
5094
+ <dd>
5095
+
5096
+ #### 📝 Description
5097
+
5098
+ <dl>
5099
+ <dd>
5100
+
5101
+ <dl>
5102
+ <dd>
5103
+
5104
+ Create an item or multiple items in a CMS Collection across multiple corresponding locales.
5105
+
5106
+ **Notes:**
5107
+
5108
+ - This endpoint can create up to 100 items in a request.
5109
+ - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale.
5110
+
5111
+ Required scope | `CMS:write`
5112
+
5113
+ </dd>
5114
+ </dl>
5115
+ </dd>
5116
+ </dl>
5117
+
5118
+ #### 🔌 Usage
5119
+
5120
+ <dl>
5121
+ <dd>
5122
+
5123
+ <dl>
5124
+ <dd>
5125
+
5126
+ ```typescript
5127
+ await client.collections.items.createItems("580e63fc8c9a982ac9b8b745", {
5128
+ cmsLocaleIds: ["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"],
5129
+ isArchived: false,
5130
+ isDraft: false,
5131
+ fieldData: {
5132
+ name: "Don\u2019t Panic",
5133
+ slug: "dont-panic",
5134
+ },
5135
+ });
5136
+ ```
5137
+
5138
+ </dd>
5139
+ </dl>
5140
+ </dd>
5141
+ </dl>
5142
+
5143
+ #### ⚙️ Parameters
5144
+
5145
+ <dl>
5146
+ <dd>
5147
+
5148
+ <dl>
5149
+ <dd>
5150
+
5151
+ **collectionId:** `string` — Unique identifier for a Collection
5152
+
5153
+ </dd>
5154
+ </dl>
5155
+
5156
+ <dl>
5157
+ <dd>
5158
+
5159
+ **request:** `Webflow.collections.CreateBulkCollectionItemRequestBody`
5160
+
5161
+ </dd>
5162
+ </dl>
5163
+
5164
+ <dl>
5165
+ <dd>
5166
+
5167
+ **requestOptions:** `Items.RequestOptions`
5168
+
5169
+ </dd>
5170
+ </dl>
5171
+ </dd>
5172
+ </dl>
5173
+
5174
+ </dd>
5175
+ </dl>
5176
+ </details>
5177
+
5178
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">getItem</a>(collectionId, itemId, { ...params }) -> Webflow.CollectionItem</code></summary>
5179
+ <dl>
5180
+ <dd>
5181
+
5182
+ #### 📝 Description
5183
+
5184
+ <dl>
5185
+ <dd>
5186
+
5187
+ <dl>
5188
+ <dd>
5189
+
5190
+ Get details of a selected Collection Item.
5191
+
5192
+ Required scope | `CMS:read`
5193
+
5194
+ </dd>
5195
+ </dl>
5196
+ </dd>
5197
+ </dl>
5198
+
5199
+ #### 🔌 Usage
5200
+
5201
+ <dl>
5202
+ <dd>
5203
+
5204
+ <dl>
5205
+ <dd>
5206
+
5207
+ ```typescript
5208
+ await client.collections.items.getItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
5209
+ ```
5210
+
5211
+ </dd>
5212
+ </dl>
5213
+ </dd>
5214
+ </dl>
5215
+
5216
+ #### ⚙️ Parameters
5217
+
5218
+ <dl>
5219
+ <dd>
5220
+
5221
+ <dl>
5222
+ <dd>
5223
+
5224
+ **collectionId:** `string` — Unique identifier for a Collection
5225
+
5226
+ </dd>
5227
+ </dl>
5228
+
5229
+ <dl>
5230
+ <dd>
5231
+
5232
+ **itemId:** `string` — Unique identifier for an Item
5233
+
5234
+ </dd>
5235
+ </dl>
5236
+
5237
+ <dl>
5238
+ <dd>
5239
+
5240
+ **request:** `Webflow.collections.ItemsGetItemRequest`
5241
+
5242
+ </dd>
5243
+ </dl>
5244
+
5245
+ <dl>
5246
+ <dd>
5247
+
5248
+ **requestOptions:** `Items.RequestOptions`
5249
+
5250
+ </dd>
5251
+ </dl>
5252
+ </dd>
5253
+ </dl>
5254
+
5255
+ </dd>
5256
+ </dl>
5257
+ </details>
5258
+
5259
+ <details><summary><code>client.collections.items.<a href="/src/api/resources/collections/resources/items/client/Client.ts">deleteItem</a>(collectionId, itemId, { ...params }) -> void</code></summary>
5260
+ <dl>
5261
+ <dd>
5262
+
5263
+ #### 📝 Description
5264
+
5265
+ <dl>
5266
+ <dd>
5267
+
5268
+ <dl>
5269
+ <dd>
5270
+
5271
+ Delete an Item from a Collection. This endpoint does not currently support bulk deletion.
5272
+
5273
+ Required scope | `CMS:write`
5274
+
5275
+ </dd>
5276
+ </dl>
5277
+ </dd>
5278
+ </dl>
5279
+
5280
+ #### 🔌 Usage
5281
+
5282
+ <dl>
5283
+ <dd>
5284
+
5285
+ <dl>
5286
+ <dd>
5287
+
5288
+ ```typescript
5289
+ await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008c9a982ac9b8b754");
5290
+ ```
5291
+
5292
+ </dd>
4758
5293
  </dl>
4759
5294
  </dd>
4760
5295
  </dl>
@@ -4814,7 +5349,9 @@ await client.collections.items.deleteItem("580e63fc8c9a982ac9b8b745", "580e64008
4814
5349
  <dl>
4815
5350
  <dd>
4816
5351
 
4817
- Update a selected Item in a Collection. </br></br> Required scope | `CMS:write`
5352
+ Update a selected Item in a Collection.
5353
+
5354
+ Required scope | `CMS:write`
4818
5355
 
4819
5356
  </dd>
4820
5357
  </dl>
@@ -4905,7 +5442,9 @@ await client.collections.items.updateItem("580e63fc8c9a982ac9b8b745", "580e64008
4905
5442
  <dl>
4906
5443
  <dd>
4907
5444
 
4908
- Get details of a selected Collection live Item. </br></br> Required scope | `CMS:read`
5445
+ Get details of a selected Collection live Item.
5446
+
5447
+ Required scope | `CMS:read`
4909
5448
 
4910
5449
  </dd>
4911
5450
  </dl>
@@ -4984,7 +5523,11 @@ await client.collections.items.getItemLive("580e63fc8c9a982ac9b8b745", "580e6400
4984
5523
  <dl>
4985
5524
  <dd>
4986
5525
 
4987
- Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft. This endpoint does not currently support bulk deletion.</br></br> Required scope | `CMS:write`
5526
+ Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft.
5527
+
5528
+ This endpoint does not currently support bulk deletion.
5529
+
5530
+ Required scope | `CMS:write`
4988
5531
 
4989
5532
  </dd>
4990
5533
  </dl>
@@ -5063,7 +5606,9 @@ await client.collections.items.deleteItemLive("580e63fc8c9a982ac9b8b745", "580e6
5063
5606
  <dl>
5064
5607
  <dd>
5065
5608
 
5066
- Update a selected live Item in a Collection. The updates for this Item will be published to the live site. </br></br> Required scope | `CMS:write`
5609
+ Update a selected live Item in a Collection. The updates for this Item will be published to the live site.
5610
+
5611
+ Required scope | `CMS:write`
5067
5612
 
5068
5613
  </dd>
5069
5614
  </dl>
@@ -5154,7 +5699,9 @@ await client.collections.items.updateItemLive("580e63fc8c9a982ac9b8b745", "580e6
5154
5699
  <dl>
5155
5700
  <dd>
5156
5701
 
5157
- Publish an item or multiple items. </br></br> Required scope | `cms:write`
5702
+ Publish an item or multiple items.
5703
+
5704
+ Required scope | `cms:write`
5158
5705
 
5159
5706
  </dd>
5160
5707
  </dl>
@@ -5229,7 +5776,15 @@ await client.collections.items.publishItem("580e63fc8c9a982ac9b8b745", {
5229
5776
  <dl>
5230
5777
  <dd>
5231
5778
 
5232
- Get all registered scripts that have been applied to a specific Page. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:read`
5779
+ Get all registered scripts that have been applied to a specific Page.
5780
+
5781
+ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
5782
+ to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
5783
+ `custom_code` endpoints.
5784
+
5785
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
5786
+
5787
+ Required scope | `custom_code:read`
5233
5788
 
5234
5789
  </dd>
5235
5790
  </dl>
@@ -5292,7 +5847,15 @@ await client.pages.scripts.getCustomCode("63c720f9347c2139b248e552");
5292
5847
  <dl>
5293
5848
  <dd>
5294
5849
 
5295
- Add a registered script to a Page. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:write`
5850
+ Add a registered script to a Page.
5851
+
5852
+ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
5853
+ to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
5854
+ `custom_code` endpoints.
5855
+
5856
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
5857
+
5858
+ Required scope | `custom_code:write`
5296
5859
 
5297
5860
  </dd>
5298
5861
  </dl>
@@ -5379,7 +5942,15 @@ await client.pages.scripts.upsertCustomCode("63c720f9347c2139b248e552", {
5379
5942
  <dl>
5380
5943
  <dd>
5381
5944
 
5382
- Delete the custom code block that an app has created for a page </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:write`
5945
+ Delete the custom code block that an app has created for a page
5946
+
5947
+ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
5948
+ to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
5949
+ `custom_code` endpoints.
5950
+
5951
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
5952
+
5953
+ Required scope | `custom_code:write`
5383
5954
 
5384
5955
  </dd>
5385
5956
  </dl>
@@ -5517,7 +6088,11 @@ await client.sites.activityLogs.list("580e63e98c9a982ac9b8b741");
5517
6088
  <dl>
5518
6089
  <dd>
5519
6090
 
5520
- Get all registered scripts that have been applied to a specific Site. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:read`
6091
+ Get all registered scripts that have been applied to a specific Site.
6092
+
6093
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
6094
+
6095
+ Required scope | `custom_code:read`
5521
6096
 
5522
6097
  </dd>
5523
6098
  </dl>
@@ -5580,7 +6155,15 @@ await client.sites.scripts.getCustomCode("580e63e98c9a982ac9b8b741");
5580
6155
  <dl>
5581
6156
  <dd>
5582
6157
 
5583
- Add a registered script to a Site. </br></br> In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate `custom_code` endpoints. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:write`
6158
+ Add a registered script to a Site.
6159
+
6160
+ In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
6161
+ to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
6162
+ `custom_code` endpoints.
6163
+
6164
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
6165
+
6166
+ Required scope | `custom_code:write`
5584
6167
 
5585
6168
  </dd>
5586
6169
  </dl>
@@ -5667,7 +6250,11 @@ await client.sites.scripts.upsertCustomCode("580e63e98c9a982ac9b8b741", {
5667
6250
  <dl>
5668
6251
  <dd>
5669
6252
 
5670
- Delete the custom code block that an app created for a Site </br></br> <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:write`
6253
+ Delete the custom code block that an app created for a Site
6254
+
6255
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
6256
+
6257
+ Required scope | `custom_code:write`
5671
6258
 
5672
6259
  </dd>
5673
6260
  </dl>
@@ -5730,7 +6317,11 @@ await client.sites.scripts.deleteCustomCode("580e63e98c9a982ac9b8b741");
5730
6317
  <dl>
5731
6318
  <dd>
5732
6319
 
5733
- Get all instances of Custom Code applied to a Site or Pages. <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote> Required scope | `custom_code:read`
6320
+ Get all instances of Custom Code applied to a Site or Pages.
6321
+
6322
+ <blockquote class="callout callout_info" theme="📘">Access to this endpoint requires a bearer token from a <a href="https://developers.webflow.com/data/docs/getting-started-data-clients">Data Client App</a>.</blockquote>
6323
+
6324
+ Required scope | `custom_code:read`
5734
6325
 
5735
6326
  </dd>
5736
6327
  </dl>