webflow-api 2.4.2 → 3.0.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 (462) 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/MIGRATION.md +37 -0
  25. package/README.md +23 -30
  26. package/api/errors/InternalServerError.d.ts +2 -1
  27. package/api/errors/NotFoundError.d.ts +2 -1
  28. package/api/errors/TooManyRequestsError.d.ts +1 -1
  29. package/api/errors/UnauthorizedError.d.ts +2 -1
  30. package/api/resources/accessGroups/client/Client.d.ts +5 -1
  31. package/api/resources/accessGroups/client/Client.js +27 -15
  32. package/api/resources/assets/client/Client.d.ts +31 -11
  33. package/api/resources/assets/client/Client.js +236 -126
  34. package/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
  35. package/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
  36. package/api/resources/collections/client/Client.d.ts +15 -22
  37. package/api/resources/collections/client/Client.js +109 -137
  38. package/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
  39. package/api/resources/collections/resources/fields/client/Client.js +163 -32
  40. package/api/resources/collections/resources/items/client/Client.d.ts +302 -30
  41. package/api/resources/collections/resources/items/client/Client.js +959 -221
  42. package/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
  43. package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
  44. package/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
  45. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
  46. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
  47. package/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
  48. package/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  49. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
  50. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
  51. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  52. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
  53. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  54. package/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
  55. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
  56. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
  57. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
  58. package/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
  59. package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
  60. package/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
  61. package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
  62. package/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
  63. package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
  64. package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
  65. package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
  66. package/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
  67. package/api/resources/collections/resources/items/types/index.d.ts +9 -0
  68. package/api/resources/collections/resources/items/types/index.js +9 -0
  69. package/api/resources/ecommerce/client/Client.d.ts +2 -0
  70. package/api/resources/ecommerce/client/Client.js +24 -14
  71. package/api/resources/forms/client/Client.d.ts +17 -5
  72. package/api/resources/forms/client/Client.js +140 -76
  73. package/api/resources/inventory/client/Client.d.ts +8 -1
  74. package/api/resources/inventory/client/Client.js +59 -30
  75. package/api/resources/orders/client/Client.d.ts +7 -2
  76. package/api/resources/orders/client/Client.js +164 -89
  77. package/api/resources/pages/client/Client.d.ts +25 -14
  78. package/api/resources/pages/client/Client.js +169 -100
  79. package/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
  80. package/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  81. package/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
  82. package/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  83. package/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
  84. package/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
  85. package/api/resources/pages/resources/scripts/client/Client.js +104 -46
  86. package/api/resources/products/client/Client.d.ts +26 -10
  87. package/api/resources/products/client/Client.js +188 -98
  88. package/api/resources/scripts/client/Client.d.ts +31 -3
  89. package/api/resources/scripts/client/Client.js +111 -47
  90. package/api/resources/sites/client/Client.d.ts +16 -4
  91. package/api/resources/sites/client/Client.js +101 -59
  92. package/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
  93. package/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
  94. package/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
  95. package/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
  96. package/api/resources/sites/resources/scripts/client/Client.js +125 -61
  97. package/api/resources/token/client/Client.d.ts +7 -2
  98. package/api/resources/token/client/Client.js +23 -24
  99. package/api/resources/users/client/Client.d.ts +21 -6
  100. package/api/resources/users/client/Client.js +149 -78
  101. package/api/resources/webhooks/client/Client.d.ts +15 -2
  102. package/api/resources/webhooks/client/Client.js +114 -59
  103. package/api/types/AssetFolder.d.ts +1 -1
  104. package/api/types/AuthorizationAuthorization.d.ts +1 -1
  105. package/api/types/AuthorizedUser.d.ts +1 -1
  106. package/api/types/BulkCollectionItemFieldData.d.ts +1 -1
  107. package/api/types/CollectionItem.d.ts +1 -1
  108. package/api/types/CollectionItemFieldData.d.ts +1 -1
  109. package/api/types/CollectionItemListNoPagination.d.ts +11 -0
  110. package/api/types/CollectionItemListNoPagination.js +5 -0
  111. package/api/types/CollectionItemWithIdInput.d.ts +24 -0
  112. package/api/types/CollectionItemWithIdInput.js +5 -0
  113. package/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
  114. package/api/types/CollectionItemWithIdInputFieldData.js +5 -0
  115. package/api/types/ConflictErrorBody.d.ts +1 -10
  116. package/api/types/CustomCodeBlock.d.ts +2 -2
  117. package/api/types/DuplicateUserEmail.d.ts +1 -11
  118. package/api/types/ErrorCode.d.ts +38 -0
  119. package/api/types/ErrorCode.js +37 -0
  120. package/api/types/Error_.d.ts +1 -1
  121. package/api/types/ForbiddenErrorBody.d.ts +2 -7
  122. package/api/types/Form.d.ts +8 -8
  123. package/api/types/FormSubmission.d.ts +3 -3
  124. package/api/types/InvalidScopes.d.ts +4 -0
  125. package/api/types/InvalidScopes.js +5 -0
  126. package/api/types/NotEnterprisePlanSite.d.ts +1 -11
  127. package/api/types/Order.d.ts +5 -1
  128. package/api/types/Page.d.ts +2 -0
  129. package/api/types/Site.d.ts +4 -0
  130. package/api/types/SiteActivityLogItem.d.ts +1 -1
  131. package/api/types/SiteActivityLogItemEvent.d.ts +48 -0
  132. package/api/types/SiteActivityLogItemEvent.js +50 -0
  133. package/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
  134. package/api/types/SiteActivityLogItemResourceOperation.js +4 -0
  135. package/api/types/SiteDataCollectionType.d.ts +12 -0
  136. package/api/types/SiteDataCollectionType.js +11 -0
  137. package/api/types/UserLimitReached.d.ts +1 -11
  138. package/api/types/UsersNotEnabled.d.ts +1 -11
  139. package/api/types/index.d.ts +10 -6
  140. package/api/types/index.js +10 -6
  141. package/core/fetcher/Fetcher.d.ts +1 -1
  142. package/core/fetcher/getResponseBody.js +3 -0
  143. package/core/fetcher/requestWithRetries.js +13 -4
  144. package/core/schemas/builders/object/object.js +28 -0
  145. package/core/schemas/builders/object/types.d.ts +5 -0
  146. package/dist/Client.d.ts +2 -0
  147. package/dist/api/errors/InternalServerError.d.ts +2 -1
  148. package/dist/api/errors/NotFoundError.d.ts +2 -1
  149. package/dist/api/errors/TooManyRequestsError.d.ts +1 -1
  150. package/dist/api/errors/UnauthorizedError.d.ts +2 -1
  151. package/dist/api/resources/accessGroups/client/Client.d.ts +5 -1
  152. package/dist/api/resources/accessGroups/client/Client.js +27 -15
  153. package/dist/api/resources/assets/client/Client.d.ts +31 -11
  154. package/dist/api/resources/assets/client/Client.js +236 -126
  155. package/dist/api/resources/assets/client/requests/AssetsCreateRequest.d.ts +2 -2
  156. package/dist/api/resources/assets/client/requests/AssetsUpdateRequest.d.ts +5 -5
  157. package/dist/api/resources/collections/client/Client.d.ts +15 -22
  158. package/dist/api/resources/collections/client/Client.js +109 -137
  159. package/dist/api/resources/collections/resources/fields/client/Client.d.ts +34 -2
  160. package/dist/api/resources/collections/resources/fields/client/Client.js +163 -32
  161. package/dist/api/resources/collections/resources/items/client/Client.d.ts +302 -30
  162. package/dist/api/resources/collections/resources/items/client/Client.js +959 -221
  163. package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +61 -0
  164. package/dist/api/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +5 -0
  165. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +11 -0
  166. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +5 -0
  167. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +11 -0
  168. package/dist/api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +5 -0
  169. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +128 -0
  170. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +5 -0
  171. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +128 -0
  172. package/dist/api/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +5 -0
  173. package/dist/api/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  174. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +5 -0
  175. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +5 -0
  176. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  177. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +5 -0
  178. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  179. package/dist/api/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +5 -0
  180. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +5 -0
  181. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +5 -0
  182. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +8 -0
  183. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +5 -0
  184. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +5 -0
  185. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequest.js +5 -0
  186. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +8 -0
  187. package/dist/api/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +5 -0
  188. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +9 -0
  189. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +5 -0
  190. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +9 -0
  191. package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +5 -0
  192. package/dist/api/resources/collections/resources/items/types/index.d.ts +9 -0
  193. package/dist/api/resources/collections/resources/items/types/index.js +9 -0
  194. package/dist/api/resources/ecommerce/client/Client.d.ts +2 -0
  195. package/dist/api/resources/ecommerce/client/Client.js +24 -14
  196. package/dist/api/resources/forms/client/Client.d.ts +17 -5
  197. package/dist/api/resources/forms/client/Client.js +140 -76
  198. package/dist/api/resources/inventory/client/Client.d.ts +8 -1
  199. package/dist/api/resources/inventory/client/Client.js +59 -30
  200. package/dist/api/resources/orders/client/Client.d.ts +7 -2
  201. package/dist/api/resources/orders/client/Client.js +164 -89
  202. package/dist/api/resources/pages/client/Client.d.ts +25 -14
  203. package/dist/api/resources/pages/client/Client.js +169 -100
  204. package/dist/api/resources/pages/client/requests/DomWrite.d.ts +6 -6
  205. package/dist/api/resources/pages/client/requests/PagesGetContentRequest.d.ts +2 -2
  206. package/dist/api/resources/pages/client/requests/PagesGetMetadataRequest.d.ts +2 -2
  207. package/dist/api/resources/pages/client/requests/PagesListRequest.d.ts +2 -2
  208. package/dist/api/resources/pages/client/requests/UpdatePageSettingsRequest.d.ts +3 -4
  209. package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +29 -3
  210. package/dist/api/resources/pages/resources/scripts/client/Client.js +104 -46
  211. package/dist/api/resources/products/client/Client.d.ts +26 -10
  212. package/dist/api/resources/products/client/Client.js +188 -98
  213. package/dist/api/resources/scripts/client/Client.d.ts +31 -3
  214. package/dist/api/resources/scripts/client/Client.js +111 -47
  215. package/dist/api/resources/sites/client/Client.d.ts +16 -4
  216. package/dist/api/resources/sites/client/Client.js +101 -59
  217. package/dist/api/resources/sites/client/requests/SitesPublishRequest.d.ts +1 -1
  218. package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +2 -0
  219. package/dist/api/resources/sites/resources/activityLogs/client/Client.js +17 -13
  220. package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +26 -4
  221. package/dist/api/resources/sites/resources/scripts/client/Client.js +125 -61
  222. package/dist/api/resources/token/client/Client.d.ts +7 -2
  223. package/dist/api/resources/token/client/Client.js +23 -24
  224. package/dist/api/resources/users/client/Client.d.ts +21 -6
  225. package/dist/api/resources/users/client/Client.js +149 -78
  226. package/dist/api/resources/webhooks/client/Client.d.ts +15 -2
  227. package/dist/api/resources/webhooks/client/Client.js +114 -59
  228. package/dist/api/types/AssetFolder.d.ts +1 -1
  229. package/dist/api/types/AuthorizationAuthorization.d.ts +1 -1
  230. package/dist/api/types/AuthorizedUser.d.ts +1 -1
  231. package/dist/api/types/BulkCollectionItemFieldData.d.ts +1 -1
  232. package/dist/api/types/CollectionItem.d.ts +1 -1
  233. package/dist/api/types/CollectionItemFieldData.d.ts +1 -1
  234. package/dist/api/types/CollectionItemListNoPagination.d.ts +11 -0
  235. package/dist/api/types/CollectionItemListNoPagination.js +5 -0
  236. package/dist/api/types/CollectionItemWithIdInput.d.ts +24 -0
  237. package/dist/api/types/CollectionItemWithIdInput.js +5 -0
  238. package/dist/api/types/CollectionItemWithIdInputFieldData.d.ts +11 -0
  239. package/dist/api/types/CollectionItemWithIdInputFieldData.js +5 -0
  240. package/dist/api/types/ConflictErrorBody.d.ts +1 -10
  241. package/dist/api/types/CustomCodeBlock.d.ts +2 -2
  242. package/dist/api/types/DuplicateUserEmail.d.ts +1 -11
  243. package/dist/api/types/ErrorCode.d.ts +38 -0
  244. package/dist/api/types/ErrorCode.js +37 -0
  245. package/dist/api/types/Error_.d.ts +1 -1
  246. package/dist/api/types/ForbiddenErrorBody.d.ts +2 -7
  247. package/dist/api/types/Form.d.ts +8 -8
  248. package/dist/api/types/FormSubmission.d.ts +3 -3
  249. package/dist/api/types/InvalidScopes.d.ts +4 -0
  250. package/dist/api/types/InvalidScopes.js +5 -0
  251. package/dist/api/types/NotEnterprisePlanSite.d.ts +1 -11
  252. package/dist/api/types/Order.d.ts +5 -1
  253. package/dist/api/types/Page.d.ts +2 -0
  254. package/dist/api/types/Site.d.ts +4 -0
  255. package/dist/api/types/SiteActivityLogItem.d.ts +1 -1
  256. package/dist/api/types/SiteActivityLogItemEvent.d.ts +48 -0
  257. package/dist/api/types/SiteActivityLogItemEvent.js +50 -0
  258. package/dist/api/types/SiteActivityLogItemResourceOperation.d.ts +5 -1
  259. package/dist/api/types/SiteActivityLogItemResourceOperation.js +4 -0
  260. package/dist/api/types/SiteDataCollectionType.d.ts +12 -0
  261. package/dist/api/types/SiteDataCollectionType.js +11 -0
  262. package/dist/api/types/UserLimitReached.d.ts +1 -11
  263. package/dist/api/types/UsersNotEnabled.d.ts +1 -11
  264. package/dist/api/types/index.d.ts +10 -6
  265. package/dist/api/types/index.js +10 -6
  266. package/dist/core/fetcher/Fetcher.d.ts +1 -1
  267. package/dist/core/fetcher/getResponseBody.js +3 -0
  268. package/dist/core/fetcher/requestWithRetries.js +13 -4
  269. package/dist/core/schemas/builders/object/object.js +28 -0
  270. package/dist/core/schemas/builders/object/types.d.ts +5 -0
  271. package/dist/errors/WebflowTimeoutError.d.ts +1 -1
  272. package/dist/errors/WebflowTimeoutError.js +2 -2
  273. package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
  274. package/dist/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
  275. package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
  276. package/dist/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
  277. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
  278. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
  279. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
  280. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
  281. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
  282. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
  283. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
  284. package/dist/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
  285. package/dist/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  286. package/dist/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
  287. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
  288. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
  289. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  290. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
  291. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  292. package/dist/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
  293. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
  294. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
  295. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
  296. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
  297. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
  298. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
  299. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
  300. package/dist/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
  301. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
  302. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
  303. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
  304. package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
  305. package/dist/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
  306. package/dist/serialization/resources/collections/resources/items/types/index.js +9 -0
  307. package/dist/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
  308. package/dist/serialization/types/BulkCollectionItemFieldData.js +4 -2
  309. package/dist/serialization/types/CollectionItem.d.ts +1 -1
  310. package/dist/serialization/types/CollectionItem.js +1 -1
  311. package/dist/serialization/types/CollectionItemFieldData.js +4 -2
  312. package/dist/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
  313. package/dist/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
  314. package/dist/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
  315. package/dist/serialization/types/CollectionItemWithIdInput.js +41 -0
  316. package/dist/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
  317. package/dist/serialization/types/{MissingScopes.js → CollectionItemWithIdInputFieldData.js} +7 -8
  318. package/dist/serialization/types/ConflictErrorBody.d.ts +4 -8
  319. package/dist/serialization/types/ConflictErrorBody.js +3 -7
  320. package/dist/serialization/types/DuplicateUserEmail.d.ts +2 -8
  321. package/dist/serialization/types/DuplicateUserEmail.js +1 -7
  322. package/dist/serialization/types/ErrorCode.d.ts +10 -0
  323. package/dist/serialization/types/ErrorCode.js +61 -0
  324. package/dist/serialization/types/Error_.d.ts +2 -1
  325. package/dist/serialization/types/Error_.js +2 -1
  326. package/dist/serialization/types/ForbiddenErrorBody.d.ts +4 -8
  327. package/dist/serialization/types/ForbiddenErrorBody.js +3 -7
  328. package/dist/serialization/types/Form.d.ts +1 -1
  329. package/dist/serialization/types/Form.js +1 -1
  330. package/dist/serialization/types/InvalidScopes.d.ts +10 -0
  331. package/{serialization/types/MissingScopes.js → dist/serialization/types/InvalidScopes.js} +2 -8
  332. package/dist/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
  333. package/dist/serialization/types/NotEnterprisePlanSite.js +1 -7
  334. package/dist/serialization/types/Page.d.ts +1 -0
  335. package/dist/serialization/types/Page.js +1 -0
  336. package/dist/serialization/types/Site.d.ts +3 -0
  337. package/dist/serialization/types/Site.js +3 -0
  338. package/dist/serialization/types/SiteActivityLogItem.d.ts +2 -1
  339. package/dist/serialization/types/SiteActivityLogItem.js +2 -1
  340. package/dist/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
  341. package/dist/serialization/types/SiteActivityLogItemEvent.js +74 -0
  342. package/dist/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
  343. package/dist/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
  344. package/dist/serialization/types/SiteDataCollectionType.d.ts +10 -0
  345. package/dist/serialization/types/SiteDataCollectionType.js +31 -0
  346. package/dist/serialization/types/UserLimitReached.d.ts +2 -8
  347. package/dist/serialization/types/UserLimitReached.js +1 -7
  348. package/dist/serialization/types/UsersNotEnabled.d.ts +2 -8
  349. package/dist/serialization/types/UsersNotEnabled.js +1 -7
  350. package/dist/serialization/types/index.d.ts +10 -5
  351. package/dist/serialization/types/index.js +10 -5
  352. package/dist/version.d.ts +1 -1
  353. package/dist/version.js +1 -1
  354. package/dist/wrapper/WebflowClient.d.ts +1 -4
  355. package/dist/wrapper/WebflowClient.js +4 -8
  356. package/errors/WebflowTimeoutError.d.ts +1 -1
  357. package/errors/WebflowTimeoutError.js +2 -2
  358. package/package.json +1 -2
  359. package/reference.md +821 -230
  360. package/serialization/resources/assets/client/requests/AssetsUpdateRequest.d.ts +2 -1
  361. package/serialization/resources/assets/client/requests/AssetsUpdateRequest.js +2 -1
  362. package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.d.ts +16 -0
  363. package/serialization/resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js +37 -0
  364. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.d.ts +13 -0
  365. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js +34 -0
  366. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.d.ts +13 -0
  367. package/serialization/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js +34 -0
  368. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.d.ts +13 -0
  369. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js +34 -0
  370. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.d.ts +13 -0
  371. package/serialization/resources/collections/resources/items/client/requests/ItemsUpdateItemsRequest.js +34 -0
  372. package/serialization/resources/collections/resources/items/client/requests/index.d.ts +5 -0
  373. package/serialization/resources/collections/resources/items/client/requests/index.js +11 -1
  374. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.d.ts +12 -0
  375. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldData.js +36 -0
  376. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.d.ts +14 -0
  377. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataItem.js +36 -0
  378. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.d.ts +14 -0
  379. package/serialization/resources/collections/resources/items/types/CreateBulkCollectionItemRequestBodyFieldDataName.js +36 -0
  380. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.d.ts +12 -0
  381. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequest.js +33 -0
  382. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.d.ts +13 -0
  383. package/serialization/resources/collections/resources/items/types/ItemsCreateItemLiveRequestItems.js +34 -0
  384. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.d.ts +12 -0
  385. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequest.js +33 -0
  386. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.d.ts +13 -0
  387. package/serialization/resources/collections/resources/items/types/ItemsCreateItemRequestItems.js +34 -0
  388. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +13 -0
  389. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +34 -0
  390. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.d.ts +13 -0
  391. package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsRequestItemsItem.js +34 -0
  392. package/serialization/resources/collections/resources/items/types/index.d.ts +9 -0
  393. package/serialization/resources/collections/resources/items/types/index.js +9 -0
  394. package/serialization/resources/pages/client/requests/DomWrite.d.ts +1 -1
  395. package/serialization/types/BulkCollectionItemFieldData.js +4 -2
  396. package/serialization/types/CollectionItem.d.ts +1 -1
  397. package/serialization/types/CollectionItem.js +1 -1
  398. package/serialization/types/CollectionItemFieldData.js +4 -2
  399. package/serialization/types/CollectionItemListNoPagination.d.ts +13 -0
  400. package/serialization/types/{TooManyRequestsErrorBody.js → CollectionItemListNoPagination.js} +4 -6
  401. package/serialization/types/CollectionItemWithIdInput.d.ts +20 -0
  402. package/serialization/types/CollectionItemWithIdInput.js +41 -0
  403. package/serialization/types/CollectionItemWithIdInputFieldData.d.ts +14 -0
  404. package/serialization/types/CollectionItemWithIdInputFieldData.js +36 -0
  405. package/serialization/types/ConflictErrorBody.d.ts +4 -8
  406. package/serialization/types/ConflictErrorBody.js +3 -7
  407. package/serialization/types/DuplicateUserEmail.d.ts +2 -8
  408. package/serialization/types/DuplicateUserEmail.js +1 -7
  409. package/serialization/types/ErrorCode.d.ts +10 -0
  410. package/serialization/types/ErrorCode.js +61 -0
  411. package/serialization/types/Error_.d.ts +2 -1
  412. package/serialization/types/Error_.js +2 -1
  413. package/serialization/types/ForbiddenErrorBody.d.ts +4 -8
  414. package/serialization/types/ForbiddenErrorBody.js +3 -7
  415. package/serialization/types/Form.d.ts +1 -1
  416. package/serialization/types/Form.js +1 -1
  417. package/serialization/types/InvalidScopes.d.ts +10 -0
  418. package/serialization/types/InvalidScopes.js +31 -0
  419. package/serialization/types/NotEnterprisePlanSite.d.ts +2 -8
  420. package/serialization/types/NotEnterprisePlanSite.js +1 -7
  421. package/serialization/types/Page.d.ts +1 -0
  422. package/serialization/types/Page.js +1 -0
  423. package/serialization/types/Site.d.ts +3 -0
  424. package/serialization/types/Site.js +3 -0
  425. package/serialization/types/SiteActivityLogItem.d.ts +2 -1
  426. package/serialization/types/SiteActivityLogItem.js +2 -1
  427. package/serialization/types/SiteActivityLogItemEvent.d.ts +10 -0
  428. package/serialization/types/SiteActivityLogItemEvent.js +74 -0
  429. package/serialization/types/SiteActivityLogItemResourceOperation.d.ts +1 -1
  430. package/serialization/types/SiteActivityLogItemResourceOperation.js +11 -1
  431. package/serialization/types/SiteDataCollectionType.d.ts +10 -0
  432. package/serialization/types/SiteDataCollectionType.js +31 -0
  433. package/serialization/types/UserLimitReached.d.ts +2 -8
  434. package/serialization/types/UserLimitReached.js +1 -7
  435. package/serialization/types/UsersNotEnabled.d.ts +2 -8
  436. package/serialization/types/UsersNotEnabled.js +1 -7
  437. package/serialization/types/index.d.ts +10 -5
  438. package/serialization/types/index.js +10 -5
  439. package/version.d.ts +1 -1
  440. package/version.js +1 -1
  441. package/wrapper/WebflowClient.d.ts +1 -4
  442. package/wrapper/WebflowClient.js +4 -8
  443. package/api/types/MissingScopes.d.ts +0 -14
  444. package/api/types/TooManyRequestsErrorBody.d.ts +0 -9
  445. package/dist/api/types/MissingScopes.d.ts +0 -14
  446. package/dist/api/types/TooManyRequestsErrorBody.d.ts +0 -9
  447. package/dist/serialization/types/MissingScopes.d.ts +0 -16
  448. package/dist/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
  449. package/dist/wrapper/CollectionsClient.d.ts +0 -8
  450. package/dist/wrapper/CollectionsClient.js +0 -18
  451. package/dist/wrapper/ItemsClient.d.ts +0 -78
  452. package/dist/wrapper/ItemsClient.js +0 -351
  453. package/serialization/types/MissingScopes.d.ts +0 -16
  454. package/serialization/types/TooManyRequestsErrorBody.d.ts +0 -15
  455. package/wrapper/CollectionsClient.d.ts +0 -8
  456. package/wrapper/CollectionsClient.js +0 -18
  457. package/wrapper/ItemsClient.d.ts +0 -78
  458. package/wrapper/ItemsClient.js +0 -351
  459. /package/api/{types/MissingScopes.js → resources/collections/resources/items/client/requests/CreateBulkCollectionItemRequestBody.js} +0 -0
  460. /package/api/{types/TooManyRequestsErrorBody.js → resources/collections/resources/items/client/requests/ItemsDeleteItemsLiveRequest.js} +0 -0
  461. /package/{dist/api/types/MissingScopes.js → api/resources/collections/resources/items/client/requests/ItemsDeleteItemsRequest.js} +0 -0
  462. /package/{dist/api/types/TooManyRequestsErrorBody.js → api/resources/collections/resources/items/client/requests/ItemsUpdateItemsLiveRequest.js} +0 -0
@@ -16,13 +16,23 @@ export declare namespace Scripts {
16
16
  maxRetries?: number;
17
17
  /** A hook to abort the request. */
18
18
  abortSignal?: AbortSignal;
19
+ /** Additional headers to include in the request. */
20
+ headers?: Record<string, string>;
19
21
  }
20
22
  }
21
23
  export declare class Scripts {
22
24
  protected readonly _options: Scripts.Options;
23
25
  constructor(_options: Scripts.Options);
24
26
  /**
25
- * 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`
27
+ * Get all registered scripts that have been applied to a specific Page.
28
+ *
29
+ * In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
30
+ * to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
31
+ * `custom_code` endpoints.
32
+ *
33
+ * <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>
34
+ *
35
+ * Required scope | `custom_code:read`
26
36
  *
27
37
  * @param {string} pageId - Unique identifier for a Page
28
38
  * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
@@ -38,7 +48,15 @@ export declare class Scripts {
38
48
  */
39
49
  getCustomCode(pageId: string, requestOptions?: Scripts.RequestOptions): Promise<Webflow.ScriptApplyList>;
40
50
  /**
41
- * 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`
51
+ * Add a registered script to a Page.
52
+ *
53
+ * In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
54
+ * to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
55
+ * `custom_code` endpoints.
56
+ *
57
+ * <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>
58
+ *
59
+ * Required scope | `custom_code:write`
42
60
  *
43
61
  * @param {string} pageId - Unique identifier for a Page
44
62
  * @param {Webflow.ScriptApplyList} request
@@ -68,7 +86,15 @@ export declare class Scripts {
68
86
  */
69
87
  upsertCustomCode(pageId: string, request: Webflow.ScriptApplyList, requestOptions?: Scripts.RequestOptions): Promise<Webflow.ScriptApplyList>;
70
88
  /**
71
- * 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`
89
+ * Delete the custom code block that an app has created for a page
90
+ *
91
+ * In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
92
+ * to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
93
+ * `custom_code` endpoints.
94
+ *
95
+ * <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>
96
+ *
97
+ * Required scope | `custom_code:write`
72
98
  *
73
99
  * @param {string} pageId - Unique identifier for a Page
74
100
  * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
@@ -50,7 +50,15 @@ class Scripts {
50
50
  this._options = _options;
51
51
  }
52
52
  /**
53
- * 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`
53
+ * Get all registered scripts that have been applied to a specific Page.
54
+ *
55
+ * In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
56
+ * to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
57
+ * `custom_code` endpoints.
58
+ *
59
+ * <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>
60
+ *
61
+ * Required scope | `custom_code:read`
54
62
  *
55
63
  * @param {string} pageId - Unique identifier for a Page
56
64
  * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
@@ -70,15 +78,7 @@ class Scripts {
70
78
  const _response = yield core.fetcher({
71
79
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `pages/${encodeURIComponent(pageId)}/custom_code`),
72
80
  method: "GET",
73
- headers: {
74
- Authorization: yield this._getAuthorizationHeader(),
75
- "X-Fern-Language": "JavaScript",
76
- "X-Fern-SDK-Name": "webflow-api",
77
- "X-Fern-SDK-Version": "2.4.2",
78
- "User-Agent": "webflow-api/2.4.2",
79
- "X-Fern-Runtime": core.RUNTIME.type,
80
- "X-Fern-Runtime-Version": core.RUNTIME.version,
81
- },
81
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
82
82
  contentType: "application/json",
83
83
  requestType: "json",
84
84
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -99,11 +99,23 @@ class Scripts {
99
99
  case 400:
100
100
  throw new Webflow.BadRequestError(_response.error.body);
101
101
  case 401:
102
- throw new Webflow.UnauthorizedError(_response.error.body);
102
+ throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
103
+ unrecognizedObjectKeys: "passthrough",
104
+ allowUnrecognizedUnionMembers: true,
105
+ allowUnrecognizedEnumValues: true,
106
+ skipValidation: true,
107
+ breadcrumbsPrefix: ["response"],
108
+ }));
103
109
  case 404:
104
- throw new Webflow.NotFoundError(_response.error.body);
110
+ throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
111
+ unrecognizedObjectKeys: "passthrough",
112
+ allowUnrecognizedUnionMembers: true,
113
+ allowUnrecognizedEnumValues: true,
114
+ skipValidation: true,
115
+ breadcrumbsPrefix: ["response"],
116
+ }));
105
117
  case 429:
106
- throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
118
+ throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
107
119
  unrecognizedObjectKeys: "passthrough",
108
120
  allowUnrecognizedUnionMembers: true,
109
121
  allowUnrecognizedEnumValues: true,
@@ -111,7 +123,13 @@ class Scripts {
111
123
  breadcrumbsPrefix: ["response"],
112
124
  }));
113
125
  case 500:
114
- throw new Webflow.InternalServerError(_response.error.body);
126
+ throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
127
+ unrecognizedObjectKeys: "passthrough",
128
+ allowUnrecognizedUnionMembers: true,
129
+ allowUnrecognizedEnumValues: true,
130
+ skipValidation: true,
131
+ breadcrumbsPrefix: ["response"],
132
+ }));
115
133
  default:
116
134
  throw new errors.WebflowError({
117
135
  statusCode: _response.error.statusCode,
@@ -126,7 +144,7 @@ class Scripts {
126
144
  body: _response.error.rawBody,
127
145
  });
128
146
  case "timeout":
129
- throw new errors.WebflowTimeoutError();
147
+ throw new errors.WebflowTimeoutError("Timeout exceeded when calling GET /pages/{page_id}/custom_code.");
130
148
  case "unknown":
131
149
  throw new errors.WebflowError({
132
150
  message: _response.error.errorMessage,
@@ -135,7 +153,15 @@ class Scripts {
135
153
  });
136
154
  }
137
155
  /**
138
- * 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`
156
+ * Add a registered script to a Page.
157
+ *
158
+ * In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
159
+ * to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
160
+ * `custom_code` endpoints.
161
+ *
162
+ * <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>
163
+ *
164
+ * Required scope | `custom_code:write`
139
165
  *
140
166
  * @param {string} pageId - Unique identifier for a Page
141
167
  * @param {Webflow.ScriptApplyList} request
@@ -169,18 +195,14 @@ class Scripts {
169
195
  const _response = yield core.fetcher({
170
196
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `pages/${encodeURIComponent(pageId)}/custom_code`),
171
197
  method: "PUT",
172
- headers: {
173
- Authorization: yield this._getAuthorizationHeader(),
174
- "X-Fern-Language": "JavaScript",
175
- "X-Fern-SDK-Name": "webflow-api",
176
- "X-Fern-SDK-Version": "2.4.2",
177
- "User-Agent": "webflow-api/2.4.2",
178
- "X-Fern-Runtime": core.RUNTIME.type,
179
- "X-Fern-Runtime-Version": core.RUNTIME.version,
180
- },
198
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
181
199
  contentType: "application/json",
182
200
  requestType: "json",
183
- body: serializers.ScriptApplyList.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
201
+ body: serializers.ScriptApplyList.jsonOrThrow(request, {
202
+ unrecognizedObjectKeys: "passthrough",
203
+ allowUnrecognizedUnionMembers: true,
204
+ allowUnrecognizedEnumValues: true,
205
+ }),
184
206
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
185
207
  maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
186
208
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -199,11 +221,23 @@ class Scripts {
199
221
  case 400:
200
222
  throw new Webflow.BadRequestError(_response.error.body);
201
223
  case 401:
202
- throw new Webflow.UnauthorizedError(_response.error.body);
224
+ throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
225
+ unrecognizedObjectKeys: "passthrough",
226
+ allowUnrecognizedUnionMembers: true,
227
+ allowUnrecognizedEnumValues: true,
228
+ skipValidation: true,
229
+ breadcrumbsPrefix: ["response"],
230
+ }));
203
231
  case 404:
204
- throw new Webflow.NotFoundError(_response.error.body);
232
+ throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
233
+ unrecognizedObjectKeys: "passthrough",
234
+ allowUnrecognizedUnionMembers: true,
235
+ allowUnrecognizedEnumValues: true,
236
+ skipValidation: true,
237
+ breadcrumbsPrefix: ["response"],
238
+ }));
205
239
  case 429:
206
- throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
240
+ throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
207
241
  unrecognizedObjectKeys: "passthrough",
208
242
  allowUnrecognizedUnionMembers: true,
209
243
  allowUnrecognizedEnumValues: true,
@@ -211,7 +245,13 @@ class Scripts {
211
245
  breadcrumbsPrefix: ["response"],
212
246
  }));
213
247
  case 500:
214
- throw new Webflow.InternalServerError(_response.error.body);
248
+ throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
249
+ unrecognizedObjectKeys: "passthrough",
250
+ allowUnrecognizedUnionMembers: true,
251
+ allowUnrecognizedEnumValues: true,
252
+ skipValidation: true,
253
+ breadcrumbsPrefix: ["response"],
254
+ }));
215
255
  default:
216
256
  throw new errors.WebflowError({
217
257
  statusCode: _response.error.statusCode,
@@ -226,7 +266,7 @@ class Scripts {
226
266
  body: _response.error.rawBody,
227
267
  });
228
268
  case "timeout":
229
- throw new errors.WebflowTimeoutError();
269
+ throw new errors.WebflowTimeoutError("Timeout exceeded when calling PUT /pages/{page_id}/custom_code.");
230
270
  case "unknown":
231
271
  throw new errors.WebflowError({
232
272
  message: _response.error.errorMessage,
@@ -235,7 +275,15 @@ class Scripts {
235
275
  });
236
276
  }
237
277
  /**
238
- * 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`
278
+ * Delete the custom code block that an app has created for a page
279
+ *
280
+ * In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered
281
+ * to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate
282
+ * `custom_code` endpoints.
283
+ *
284
+ * <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>
285
+ *
286
+ * Required scope | `custom_code:write`
239
287
  *
240
288
  * @param {string} pageId - Unique identifier for a Page
241
289
  * @param {Scripts.RequestOptions} requestOptions - Request-specific configuration.
@@ -255,15 +303,7 @@ class Scripts {
255
303
  const _response = yield core.fetcher({
256
304
  url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `pages/${encodeURIComponent(pageId)}/custom_code`),
257
305
  method: "DELETE",
258
- headers: {
259
- Authorization: yield this._getAuthorizationHeader(),
260
- "X-Fern-Language": "JavaScript",
261
- "X-Fern-SDK-Name": "webflow-api",
262
- "X-Fern-SDK-Version": "2.4.2",
263
- "User-Agent": "webflow-api/2.4.2",
264
- "X-Fern-Runtime": core.RUNTIME.type,
265
- "X-Fern-Runtime-Version": core.RUNTIME.version,
266
- },
306
+ headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.0.0", "User-Agent": "webflow-api/3.0.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
267
307
  contentType: "application/json",
268
308
  requestType: "json",
269
309
  timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -278,11 +318,23 @@ class Scripts {
278
318
  case 400:
279
319
  throw new Webflow.BadRequestError(_response.error.body);
280
320
  case 401:
281
- throw new Webflow.UnauthorizedError(_response.error.body);
321
+ throw new Webflow.UnauthorizedError(serializers.Error_.parseOrThrow(_response.error.body, {
322
+ unrecognizedObjectKeys: "passthrough",
323
+ allowUnrecognizedUnionMembers: true,
324
+ allowUnrecognizedEnumValues: true,
325
+ skipValidation: true,
326
+ breadcrumbsPrefix: ["response"],
327
+ }));
282
328
  case 404:
283
- throw new Webflow.NotFoundError(_response.error.body);
329
+ throw new Webflow.NotFoundError(serializers.Error_.parseOrThrow(_response.error.body, {
330
+ unrecognizedObjectKeys: "passthrough",
331
+ allowUnrecognizedUnionMembers: true,
332
+ allowUnrecognizedEnumValues: true,
333
+ skipValidation: true,
334
+ breadcrumbsPrefix: ["response"],
335
+ }));
284
336
  case 429:
285
- throw new Webflow.TooManyRequestsError(serializers.TooManyRequestsErrorBody.parseOrThrow(_response.error.body, {
337
+ throw new Webflow.TooManyRequestsError(serializers.Error_.parseOrThrow(_response.error.body, {
286
338
  unrecognizedObjectKeys: "passthrough",
287
339
  allowUnrecognizedUnionMembers: true,
288
340
  allowUnrecognizedEnumValues: true,
@@ -290,7 +342,13 @@ class Scripts {
290
342
  breadcrumbsPrefix: ["response"],
291
343
  }));
292
344
  case 500:
293
- throw new Webflow.InternalServerError(_response.error.body);
345
+ throw new Webflow.InternalServerError(serializers.Error_.parseOrThrow(_response.error.body, {
346
+ unrecognizedObjectKeys: "passthrough",
347
+ allowUnrecognizedUnionMembers: true,
348
+ allowUnrecognizedEnumValues: true,
349
+ skipValidation: true,
350
+ breadcrumbsPrefix: ["response"],
351
+ }));
294
352
  default:
295
353
  throw new errors.WebflowError({
296
354
  statusCode: _response.error.statusCode,
@@ -305,7 +363,7 @@ class Scripts {
305
363
  body: _response.error.rawBody,
306
364
  });
307
365
  case "timeout":
308
- throw new errors.WebflowTimeoutError();
366
+ throw new errors.WebflowTimeoutError("Timeout exceeded when calling DELETE /pages/{page_id}/custom_code.");
309
367
  case "unknown":
310
368
  throw new errors.WebflowError({
311
369
  message: _response.error.errorMessage,
@@ -16,13 +16,18 @@ export declare namespace Products {
16
16
  maxRetries?: number;
17
17
  /** A hook to abort the request. */
18
18
  abortSignal?: AbortSignal;
19
+ /** Additional headers to include in the request. */
20
+ headers?: Record<string, string>;
19
21
  }
20
22
  }
21
23
  export declare class Products {
22
24
  protected readonly _options: Products.Options;
23
25
  constructor(_options: Products.Options);
24
26
  /**
25
- * 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.
27
+ * Retrieve all products for a site.
28
+ *
29
+ * Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product
30
+ * will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs.
26
31
  *
27
32
  * Required scope | `ecommerce:read`
28
33
  *
@@ -43,13 +48,19 @@ export declare class Products {
43
48
  */
44
49
  list(siteId: string, request?: Webflow.ProductsListRequest, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUsList>;
45
50
  /**
46
- * Creating a new Product involves creating both a Product and a SKU, since a Product Item has to have, at minimum, a single SKU.
51
+ * Create a new product and SKU.
52
+ *
53
+ * When you create a product, you will always create a SKU, since a Product Item must have, at minimum, a single SKU.
47
54
  *
48
- * 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`.
55
+ * To create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large:
49
56
  *
50
- * 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>
57
+ * - 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).
58
+ * - 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`.
59
+ * - 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.
60
+ * - 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.
61
+ * - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products-sk-us/create-sku)
51
62
  *
52
- * 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.
63
+ * Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer.
53
64
  *
54
65
  * Required scope | `ecommerce:write`
55
66
  *
@@ -70,7 +81,8 @@ export declare class Products {
70
81
  */
71
82
  create(siteId: string, request?: Webflow.ProductSkuCreate, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUs>;
72
83
  /**
73
- * Retrieve a single product by its id. All of its SKUs will also be retrieved.
84
+ * Retrieve a single product by its ID. All of its SKUs will also be
85
+ * retrieved.
74
86
  *
75
87
  * Required scope | `ecommerce:read`
76
88
  *
@@ -91,7 +103,9 @@ export declare class Products {
91
103
  */
92
104
  get(siteId: string, productId: string, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductAndSkUs>;
93
105
  /**
94
- * 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`.
106
+ * Update an existing Product.
107
+ *
108
+ * 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.
95
109
  *
96
110
  * Required scope | `ecommerce:write`
97
111
  *
@@ -113,9 +127,9 @@ export declare class Products {
113
127
  */
114
128
  update(siteId: string, productId: string, request?: Webflow.ProductSkuUpdate, requestOptions?: Products.RequestOptions): Promise<Webflow.Product>;
115
129
  /**
116
- * Create additional SKUs to cover every variant of your Product. The Default SKU already counts as one of the variants.
130
+ * 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)
117
131
  *
118
- * 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`.
132
+ * 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.
119
133
  *
120
134
  * Required scope | `ecommerce:write`
121
135
  *
@@ -139,7 +153,9 @@ export declare class Products {
139
153
  */
140
154
  createSku(siteId: string, productId: string, request: Webflow.ProductsCreateSkuRequest, requestOptions?: Products.RequestOptions): Promise<Webflow.ProductsCreateSkuResponse>;
141
155
  /**
142
- * 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`.
156
+ * Update a specified SKU.
157
+ *
158
+ * 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.
143
159
  *
144
160
  * Required scope | `ecommerce:write`
145
161
  *