@widgetic/api-sdk 1.0.30 → 1.0.32

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 (306) hide show
  1. package/dist/apis/AdminApi.d.ts +3 -2
  2. package/dist/apis/AdminApi.js +3 -2
  3. package/dist/apis/BillingApi.d.ts +3 -3
  4. package/dist/apis/BillingApi.js +1 -1
  5. package/dist/apis/CompositionsApi.d.ts +190 -87
  6. package/dist/apis/CompositionsApi.js +378 -87
  7. package/dist/apis/CreditsApi.d.ts +6 -6
  8. package/dist/apis/InvoicesApi.d.ts +6 -6
  9. package/dist/apis/InvoicesApi.js +2 -2
  10. package/dist/apis/ManagedUsersApi.d.ts +104 -27
  11. package/dist/apis/ManagedUsersApi.js +247 -12
  12. package/dist/apis/OperationsApi.d.ts +3 -3
  13. package/dist/apis/PartnerApi.d.ts +1291 -0
  14. package/dist/apis/PartnerApi.js +3550 -0
  15. package/dist/apis/PartnersApi.d.ts +140 -43
  16. package/dist/apis/PartnersApi.js +286 -0
  17. package/dist/apis/PublicEmbedApi.d.ts +72 -0
  18. package/dist/apis/PublicEmbedApi.js +168 -0
  19. package/dist/apis/UploadsApi.d.ts +29 -16
  20. package/dist/apis/UploadsApi.js +40 -3
  21. package/dist/apis/UsersApi.d.ts +27 -27
  22. package/dist/apis/WidgetsApi.d.ts +33 -18
  23. package/dist/apis/WidgetsApi.js +84 -39
  24. package/dist/apis/index.d.ts +2 -0
  25. package/dist/apis/index.js +2 -0
  26. package/dist/esm/apis/AdminApi.d.ts +3 -2
  27. package/dist/esm/apis/AdminApi.js +3 -2
  28. package/dist/esm/apis/BillingApi.d.ts +3 -3
  29. package/dist/esm/apis/BillingApi.js +2 -2
  30. package/dist/esm/apis/CompositionsApi.d.ts +190 -87
  31. package/dist/esm/apis/CompositionsApi.js +378 -87
  32. package/dist/esm/apis/CreditsApi.d.ts +6 -6
  33. package/dist/esm/apis/InvoicesApi.d.ts +6 -6
  34. package/dist/esm/apis/InvoicesApi.js +1 -1
  35. package/dist/esm/apis/ManagedUsersApi.d.ts +104 -27
  36. package/dist/esm/apis/ManagedUsersApi.js +248 -13
  37. package/dist/esm/apis/OperationsApi.d.ts +3 -3
  38. package/dist/esm/apis/PartnerApi.d.ts +1291 -0
  39. package/dist/esm/apis/PartnerApi.js +3546 -0
  40. package/dist/esm/apis/PartnersApi.d.ts +140 -43
  41. package/dist/esm/apis/PartnersApi.js +287 -1
  42. package/dist/esm/apis/PublicEmbedApi.d.ts +72 -0
  43. package/dist/esm/apis/PublicEmbedApi.js +164 -0
  44. package/dist/esm/apis/UploadsApi.d.ts +29 -16
  45. package/dist/esm/apis/UploadsApi.js +40 -3
  46. package/dist/esm/apis/UsersApi.d.ts +27 -27
  47. package/dist/esm/apis/WidgetsApi.d.ts +33 -18
  48. package/dist/esm/apis/WidgetsApi.js +85 -40
  49. package/dist/esm/apis/index.d.ts +2 -0
  50. package/dist/esm/apis/index.js +2 -0
  51. package/dist/esm/models/Composition.d.ts +18 -0
  52. package/dist/esm/models/Composition.js +4 -0
  53. package/dist/esm/models/CompositionDataSource.d.ts +41 -0
  54. package/dist/esm/models/CompositionDataSource.js +47 -0
  55. package/dist/esm/models/CompositionEntriesReading.d.ts +20 -4
  56. package/dist/esm/models/CompositionEntriesReading.js +3 -0
  57. package/dist/esm/models/CompositionEntryAggregateTally.d.ts +69 -0
  58. package/dist/esm/models/CompositionEntryAggregateTally.js +51 -0
  59. package/dist/esm/models/CompositionEntryAggregatesBlock.d.ts +55 -0
  60. package/dist/esm/models/CompositionEntryAggregatesBlock.js +50 -0
  61. package/dist/esm/models/CompositionEntryDeleteSuccess.d.ts +39 -0
  62. package/dist/esm/models/CompositionEntryDeleteSuccess.js +48 -0
  63. package/dist/esm/models/CompositionEntryDeleteSuccessData.d.ts +32 -0
  64. package/dist/esm/models/CompositionEntryDeleteSuccessData.js +43 -0
  65. package/dist/esm/models/CompositionEntryItem.d.ts +63 -0
  66. package/dist/esm/models/CompositionEntryItem.js +57 -0
  67. package/dist/esm/models/CompositionEntryItemsMeta.d.ts +59 -0
  68. package/dist/esm/models/CompositionEntryItemsMeta.js +55 -0
  69. package/dist/esm/models/CompositionEntryItemsPageSuccess.d.ts +46 -0
  70. package/dist/esm/models/CompositionEntryItemsPageSuccess.js +53 -0
  71. package/dist/esm/models/CreateCanvasRequest.d.ts +6 -0
  72. package/dist/esm/models/CreateCanvasRequest.js +2 -0
  73. package/dist/esm/models/CreateCompositionContentItemRequest.d.ts +33 -0
  74. package/dist/esm/models/CreateCompositionContentItemRequest.js +37 -0
  75. package/dist/esm/models/CreateCompositionFromPresetRequest.d.ts +56 -0
  76. package/dist/esm/models/CreateCompositionFromPresetRequest.js +51 -0
  77. package/dist/esm/models/CreateCompositionFromWidget201Response.d.ts +39 -0
  78. package/dist/esm/models/{CreateComposition201Response.js → CreateCompositionFromWidget201Response.js} +8 -8
  79. package/dist/esm/models/CreateCompositionFromWidgetRequest.d.ts +62 -0
  80. package/dist/esm/models/CreateCompositionFromWidgetRequest.js +53 -0
  81. package/dist/esm/models/DeleteCompositionContentItem200Response.d.ts +38 -0
  82. package/dist/esm/models/DeleteCompositionContentItem200Response.js +43 -0
  83. package/dist/esm/models/DeleteCompositionDataSource200Response.d.ts +32 -0
  84. package/dist/esm/models/DeleteCompositionDataSource200Response.js +43 -0
  85. package/dist/esm/models/ExportCompositionEntryItems200Response.d.ts +46 -0
  86. package/dist/esm/models/ExportCompositionEntryItems200Response.js +53 -0
  87. package/dist/esm/models/ExportCompositionEntryItems200ResponseMeta.d.ts +38 -0
  88. package/dist/esm/models/ExportCompositionEntryItems200ResponseMeta.js +47 -0
  89. package/dist/esm/models/GetCompositionContentSchema200Response.d.ts +2 -2
  90. package/dist/esm/models/GetManagedUserLimits200Response.d.ts +39 -0
  91. package/dist/esm/models/GetManagedUserLimits200Response.js +44 -0
  92. package/dist/esm/models/GetManagedUserLimits200ResponseData.d.ts +50 -0
  93. package/dist/esm/models/GetManagedUserLimits200ResponseData.js +55 -0
  94. package/dist/esm/models/GetManagedUserStorageUsage200Response.d.ts +39 -0
  95. package/dist/esm/models/GetManagedUserStorageUsage200Response.js +44 -0
  96. package/dist/esm/models/GetManagedUserStorageUsage200ResponseData.d.ts +45 -0
  97. package/dist/esm/models/GetManagedUserStorageUsage200ResponseData.js +52 -0
  98. package/dist/esm/models/GetManagedUserStorageUsage200ResponseDataByPurpose.d.ts +51 -0
  99. package/dist/esm/models/GetManagedUserStorageUsage200ResponseDataByPurpose.js +48 -0
  100. package/dist/esm/models/GetPartnerDesignDefaults200Response.d.ts +39 -0
  101. package/dist/esm/models/GetPartnerDesignDefaults200Response.js +44 -0
  102. package/dist/esm/models/GetPartnerDesignDefaults200ResponseData.d.ts +32 -0
  103. package/dist/esm/models/GetPartnerDesignDefaults200ResponseData.js +41 -0
  104. package/dist/esm/models/GetPublicCompositionEmbed200Response.d.ts +106 -0
  105. package/dist/esm/models/GetPublicCompositionEmbed200Response.js +67 -0
  106. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDataSource.d.ts +38 -0
  107. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDataSource.js +43 -0
  108. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDirect.d.ts +44 -0
  109. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDirect.js +45 -0
  110. package/dist/esm/models/GetPublicCompositionEmbed403Response.d.ts +51 -0
  111. package/dist/esm/models/GetPublicCompositionEmbed403Response.js +48 -0
  112. package/dist/esm/models/GetPublicCompositionEmbed403ResponseDetails.d.ts +46 -0
  113. package/dist/esm/models/GetPublicCompositionEmbed403ResponseDetails.js +50 -0
  114. package/dist/esm/models/GetPublicCompositionEmbed404Response.d.ts +47 -0
  115. package/dist/esm/models/GetPublicCompositionEmbed404Response.js +51 -0
  116. package/dist/esm/models/GetPublicCompositionEmbed429Response.d.ts +38 -0
  117. package/dist/esm/models/GetPublicCompositionEmbed429Response.js +43 -0
  118. package/dist/esm/models/ManagedUserEntriesMeta.d.ts +56 -0
  119. package/dist/esm/models/ManagedUserEntriesMeta.js +57 -0
  120. package/dist/esm/models/ManagedUserEntriesPageSuccess.d.ts +46 -0
  121. package/dist/esm/models/ManagedUserEntriesPageSuccess.js +53 -0
  122. package/dist/esm/models/ManagedUserEntryItem.d.ts +75 -0
  123. package/dist/esm/models/ManagedUserEntryItem.js +65 -0
  124. package/dist/esm/models/PartnerEntryContextSecret.d.ts +39 -0
  125. package/dist/esm/models/PartnerEntryContextSecret.js +48 -0
  126. package/dist/esm/models/PartnerEntryContextSigning.d.ts +62 -0
  127. package/dist/esm/models/PartnerEntryContextSigning.js +63 -0
  128. package/dist/esm/models/PartnerNotification.d.ts +1 -1
  129. package/dist/esm/models/PartnerNotificationDelivery.d.ts +6 -0
  130. package/dist/esm/models/PartnerNotificationDelivery.js +4 -0
  131. package/dist/esm/models/PartnerNotificationEvent.d.ts +15 -0
  132. package/dist/esm/models/PartnerNotificationEvent.js +13 -1
  133. package/dist/esm/models/PartnerNotificationEventType.d.ts +4 -0
  134. package/dist/esm/models/PartnerNotificationEventType.js +5 -1
  135. package/dist/esm/models/PartnerNotificationTestEventRequest.d.ts +33 -0
  136. package/dist/esm/models/PartnerNotificationTestEventRequest.js +44 -0
  137. package/dist/esm/models/PartnerNotificationTestEventResult.d.ts +50 -0
  138. package/dist/esm/models/PartnerNotificationTestEventResult.js +53 -0
  139. package/dist/esm/models/PostPublicCompositionEmbedStatus200Response.d.ts +39 -0
  140. package/dist/esm/models/PostPublicCompositionEmbedStatus200Response.js +44 -0
  141. package/dist/esm/models/PostPublicCompositionEmbedStatus200ResponseData.d.ts +45 -0
  142. package/dist/esm/models/PostPublicCompositionEmbedStatus200ResponseData.js +51 -0
  143. package/dist/esm/models/PostPublicCompositionEmbedStatus429Response.d.ts +32 -0
  144. package/dist/esm/models/PostPublicCompositionEmbedStatus429Response.js +41 -0
  145. package/dist/esm/models/PostPublicCompositionEmbedStatusRequest.d.ts +32 -0
  146. package/dist/esm/models/PostPublicCompositionEmbedStatusRequest.js +43 -0
  147. package/dist/esm/models/PublicCompositionEntryCreated.d.ts +39 -0
  148. package/dist/esm/models/PublicCompositionEntryCreated.js +48 -0
  149. package/dist/esm/models/PublicCompositionEntryCreatedData.d.ts +44 -0
  150. package/dist/esm/models/PublicCompositionEntryCreatedData.js +51 -0
  151. package/dist/esm/models/PublicCompositionEntryRequest.d.ts +40 -0
  152. package/dist/esm/models/PublicCompositionEntryRequest.js +45 -0
  153. package/dist/esm/models/PurposeStorageBucket.d.ts +38 -0
  154. package/dist/esm/models/PurposeStorageBucket.js +47 -0
  155. package/dist/esm/models/SetCompositionDataSourceRequest.d.ts +38 -0
  156. package/dist/esm/models/SetCompositionDataSourceRequest.js +47 -0
  157. package/dist/esm/models/SetDynamicContent200Response.d.ts +6 -0
  158. package/dist/esm/models/SetDynamicContent200Response.js +2 -0
  159. package/dist/esm/models/SetManagedUserLimitsRequest.d.ts +32 -0
  160. package/dist/esm/models/SetManagedUserLimitsRequest.js +43 -0
  161. package/dist/esm/models/SetPartnerDesignDefaultsRequest.d.ts +32 -0
  162. package/dist/esm/models/SetPartnerDesignDefaultsRequest.js +43 -0
  163. package/dist/esm/models/UpdatePartnerEntryContextSigningRequest.d.ts +32 -0
  164. package/dist/esm/models/UpdatePartnerEntryContextSigningRequest.js +43 -0
  165. package/dist/esm/models/Upload.d.ts +15 -0
  166. package/dist/esm/models/Upload.js +10 -0
  167. package/dist/esm/models/UploadsIdDelete200Response.d.ts +39 -0
  168. package/dist/esm/models/UploadsIdDelete200Response.js +44 -0
  169. package/dist/esm/models/UploadsIdDelete200ResponseData.d.ts +32 -0
  170. package/dist/esm/models/UploadsIdDelete200ResponseData.js +41 -0
  171. package/dist/esm/models/index.d.ts +51 -3
  172. package/dist/esm/models/index.js +51 -3
  173. package/dist/models/Composition.d.ts +18 -0
  174. package/dist/models/Composition.js +4 -0
  175. package/dist/models/CompositionDataSource.d.ts +41 -0
  176. package/dist/models/CompositionDataSource.js +54 -0
  177. package/dist/models/CompositionEntriesReading.d.ts +20 -4
  178. package/dist/models/CompositionEntriesReading.js +3 -0
  179. package/dist/models/CompositionEntryAggregateTally.d.ts +69 -0
  180. package/dist/models/CompositionEntryAggregateTally.js +58 -0
  181. package/dist/models/CompositionEntryAggregatesBlock.d.ts +55 -0
  182. package/dist/models/CompositionEntryAggregatesBlock.js +57 -0
  183. package/dist/models/CompositionEntryDeleteSuccess.d.ts +39 -0
  184. package/dist/models/CompositionEntryDeleteSuccess.js +55 -0
  185. package/dist/models/CompositionEntryDeleteSuccessData.d.ts +32 -0
  186. package/dist/models/CompositionEntryDeleteSuccessData.js +50 -0
  187. package/dist/models/CompositionEntryItem.d.ts +63 -0
  188. package/dist/models/CompositionEntryItem.js +64 -0
  189. package/dist/models/CompositionEntryItemsMeta.d.ts +59 -0
  190. package/dist/models/CompositionEntryItemsMeta.js +63 -0
  191. package/dist/models/CompositionEntryItemsPageSuccess.d.ts +46 -0
  192. package/dist/models/CompositionEntryItemsPageSuccess.js +60 -0
  193. package/dist/models/CreateCanvasRequest.d.ts +6 -0
  194. package/dist/models/CreateCanvasRequest.js +2 -0
  195. package/dist/models/CreateCompositionContentItemRequest.d.ts +33 -0
  196. package/dist/models/CreateCompositionContentItemRequest.js +44 -0
  197. package/dist/models/CreateCompositionFromPresetRequest.d.ts +56 -0
  198. package/dist/models/CreateCompositionFromPresetRequest.js +58 -0
  199. package/dist/models/CreateCompositionFromWidget201Response.d.ts +39 -0
  200. package/dist/models/CreateCompositionFromWidget201Response.js +51 -0
  201. package/dist/models/CreateCompositionFromWidgetRequest.d.ts +62 -0
  202. package/dist/models/CreateCompositionFromWidgetRequest.js +60 -0
  203. package/dist/models/DeleteCompositionContentItem200Response.d.ts +38 -0
  204. package/dist/models/DeleteCompositionContentItem200Response.js +50 -0
  205. package/dist/models/DeleteCompositionDataSource200Response.d.ts +32 -0
  206. package/dist/models/DeleteCompositionDataSource200Response.js +50 -0
  207. package/dist/models/ExportCompositionEntryItems200Response.d.ts +46 -0
  208. package/dist/models/ExportCompositionEntryItems200Response.js +60 -0
  209. package/dist/models/ExportCompositionEntryItems200ResponseMeta.d.ts +38 -0
  210. package/dist/models/ExportCompositionEntryItems200ResponseMeta.js +54 -0
  211. package/dist/models/GetCompositionContentSchema200Response.d.ts +2 -2
  212. package/dist/models/GetManagedUserLimits200Response.d.ts +39 -0
  213. package/dist/models/GetManagedUserLimits200Response.js +51 -0
  214. package/dist/models/GetManagedUserLimits200ResponseData.d.ts +50 -0
  215. package/dist/models/GetManagedUserLimits200ResponseData.js +62 -0
  216. package/dist/models/GetManagedUserStorageUsage200Response.d.ts +39 -0
  217. package/dist/models/GetManagedUserStorageUsage200Response.js +51 -0
  218. package/dist/models/GetManagedUserStorageUsage200ResponseData.d.ts +45 -0
  219. package/dist/models/GetManagedUserStorageUsage200ResponseData.js +59 -0
  220. package/dist/models/GetManagedUserStorageUsage200ResponseDataByPurpose.d.ts +51 -0
  221. package/dist/models/GetManagedUserStorageUsage200ResponseDataByPurpose.js +55 -0
  222. package/dist/models/GetPartnerDesignDefaults200Response.d.ts +39 -0
  223. package/dist/models/GetPartnerDesignDefaults200Response.js +51 -0
  224. package/dist/models/GetPartnerDesignDefaults200ResponseData.d.ts +32 -0
  225. package/dist/models/GetPartnerDesignDefaults200ResponseData.js +48 -0
  226. package/dist/models/GetPublicCompositionEmbed200Response.d.ts +106 -0
  227. package/dist/models/GetPublicCompositionEmbed200Response.js +74 -0
  228. package/dist/models/GetPublicCompositionEmbed200ResponseDataSource.d.ts +38 -0
  229. package/dist/models/GetPublicCompositionEmbed200ResponseDataSource.js +50 -0
  230. package/dist/models/GetPublicCompositionEmbed200ResponseDirect.d.ts +44 -0
  231. package/dist/models/GetPublicCompositionEmbed200ResponseDirect.js +52 -0
  232. package/dist/models/GetPublicCompositionEmbed403Response.d.ts +51 -0
  233. package/dist/models/GetPublicCompositionEmbed403Response.js +55 -0
  234. package/dist/models/GetPublicCompositionEmbed403ResponseDetails.d.ts +46 -0
  235. package/dist/models/GetPublicCompositionEmbed403ResponseDetails.js +58 -0
  236. package/dist/models/GetPublicCompositionEmbed404Response.d.ts +47 -0
  237. package/dist/models/GetPublicCompositionEmbed404Response.js +59 -0
  238. package/dist/models/GetPublicCompositionEmbed429Response.d.ts +38 -0
  239. package/dist/models/GetPublicCompositionEmbed429Response.js +50 -0
  240. package/dist/models/ManagedUserEntriesMeta.d.ts +56 -0
  241. package/dist/models/ManagedUserEntriesMeta.js +64 -0
  242. package/dist/models/ManagedUserEntriesPageSuccess.d.ts +46 -0
  243. package/dist/models/ManagedUserEntriesPageSuccess.js +60 -0
  244. package/dist/models/ManagedUserEntryItem.d.ts +75 -0
  245. package/dist/models/ManagedUserEntryItem.js +72 -0
  246. package/dist/models/PartnerEntryContextSecret.d.ts +39 -0
  247. package/dist/models/PartnerEntryContextSecret.js +55 -0
  248. package/dist/models/PartnerEntryContextSigning.d.ts +62 -0
  249. package/dist/models/PartnerEntryContextSigning.js +70 -0
  250. package/dist/models/PartnerNotification.d.ts +1 -1
  251. package/dist/models/PartnerNotificationDelivery.d.ts +6 -0
  252. package/dist/models/PartnerNotificationDelivery.js +4 -0
  253. package/dist/models/PartnerNotificationEvent.d.ts +15 -0
  254. package/dist/models/PartnerNotificationEvent.js +14 -2
  255. package/dist/models/PartnerNotificationEventType.d.ts +4 -0
  256. package/dist/models/PartnerNotificationEventType.js +5 -1
  257. package/dist/models/PartnerNotificationTestEventRequest.d.ts +33 -0
  258. package/dist/models/PartnerNotificationTestEventRequest.js +51 -0
  259. package/dist/models/PartnerNotificationTestEventResult.d.ts +50 -0
  260. package/dist/models/PartnerNotificationTestEventResult.js +60 -0
  261. package/dist/models/PostPublicCompositionEmbedStatus200Response.d.ts +39 -0
  262. package/dist/models/PostPublicCompositionEmbedStatus200Response.js +51 -0
  263. package/dist/models/PostPublicCompositionEmbedStatus200ResponseData.d.ts +45 -0
  264. package/dist/models/PostPublicCompositionEmbedStatus200ResponseData.js +59 -0
  265. package/dist/models/PostPublicCompositionEmbedStatus429Response.d.ts +32 -0
  266. package/dist/models/PostPublicCompositionEmbedStatus429Response.js +48 -0
  267. package/dist/models/PostPublicCompositionEmbedStatusRequest.d.ts +32 -0
  268. package/dist/models/PostPublicCompositionEmbedStatusRequest.js +50 -0
  269. package/dist/models/PublicCompositionEntryCreated.d.ts +39 -0
  270. package/dist/models/PublicCompositionEntryCreated.js +55 -0
  271. package/dist/models/PublicCompositionEntryCreatedData.d.ts +44 -0
  272. package/dist/models/PublicCompositionEntryCreatedData.js +58 -0
  273. package/dist/models/PublicCompositionEntryRequest.d.ts +40 -0
  274. package/dist/models/PublicCompositionEntryRequest.js +52 -0
  275. package/dist/models/PurposeStorageBucket.d.ts +38 -0
  276. package/dist/models/PurposeStorageBucket.js +54 -0
  277. package/dist/models/SetCompositionDataSourceRequest.d.ts +38 -0
  278. package/dist/models/SetCompositionDataSourceRequest.js +54 -0
  279. package/dist/models/SetDynamicContent200Response.d.ts +6 -0
  280. package/dist/models/SetDynamicContent200Response.js +2 -0
  281. package/dist/models/SetManagedUserLimitsRequest.d.ts +32 -0
  282. package/dist/models/SetManagedUserLimitsRequest.js +50 -0
  283. package/dist/models/SetPartnerDesignDefaultsRequest.d.ts +32 -0
  284. package/dist/models/SetPartnerDesignDefaultsRequest.js +50 -0
  285. package/dist/models/UpdatePartnerEntryContextSigningRequest.d.ts +32 -0
  286. package/dist/models/UpdatePartnerEntryContextSigningRequest.js +50 -0
  287. package/dist/models/Upload.d.ts +15 -0
  288. package/dist/models/Upload.js +11 -1
  289. package/dist/models/UploadsIdDelete200Response.d.ts +39 -0
  290. package/dist/models/UploadsIdDelete200Response.js +51 -0
  291. package/dist/models/UploadsIdDelete200ResponseData.d.ts +32 -0
  292. package/dist/models/UploadsIdDelete200ResponseData.js +48 -0
  293. package/dist/models/index.d.ts +51 -3
  294. package/dist/models/index.js +51 -3
  295. package/package.json +1 -1
  296. package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +0 -39
  297. package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +0 -44
  298. package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +0 -32
  299. package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +0 -41
  300. package/dist/esm/models/CreateComposition201Response.d.ts +0 -39
  301. package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +0 -39
  302. package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +0 -51
  303. package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +0 -32
  304. package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +0 -48
  305. package/dist/models/CreateComposition201Response.d.ts +0 -39
  306. package/dist/models/CreateComposition201Response.js +0 -51
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AddPartnerCreditsRequest, ConfigureAutoReloadRequest, GetPartnerCreditBalance200Response, ListPartnerPresets200Response, MyPartners, PartnerAnalyticsByManagedUser, PartnerAnalyticsSummary, PartnerAnalyticsTimeline, PartnerAnalyticsTopWidgets, PartnerContract, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerPreset, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PartnerStorageUsage, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdatePartnerNotificationSettingsRequest } from '../models/index';
13
+ import type { AddPartnerCreditsRequest, ConfigureAutoReloadRequest, GetPartnerCreditBalance200Response, GetPartnerDesignDefaults200Response, ListPartnerPresets200Response, MyPartners, PartnerAnalyticsByManagedUser, PartnerAnalyticsSummary, PartnerAnalyticsTimeline, PartnerAnalyticsTopWidgets, PartnerContract, PartnerEntryContextSecret, PartnerEntryContextSigning, PartnerNotificationDelivery, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerNotificationTestEventRequest, PartnerNotificationTestEventResult, PartnerPreset, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PartnerStorageUsage, SetPartnerDesignDefaultsRequest, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdatePartnerEntryContextSigningRequest, UpdatePartnerNotificationSettingsRequest } from '../models/index';
14
14
  export interface AddPartnerCreditsOperationRequest {
15
15
  partnerId: string;
16
16
  addPartnerCreditsRequest: AddPartnerCreditsRequest;
@@ -53,10 +53,10 @@ export interface GetPartnerAnalyticsTopWidgetsRequest {
53
53
  managedUserExternalId?: string;
54
54
  limit?: number;
55
55
  }
56
- export interface GetPartnerBillingOverviewRequest {
56
+ export interface GetPartnerBillingOverview0Request {
57
57
  partnerId: string;
58
58
  }
59
- export interface GetPartnerContractRequest {
59
+ export interface GetPartnerContract0Request {
60
60
  partnerId: string;
61
61
  }
62
62
  export interface GetPartnerCreditBalanceRequest {
@@ -68,10 +68,16 @@ export interface GetPartnerCreditTransactionsRequest {
68
68
  offset?: number;
69
69
  type?: GetPartnerCreditTransactionsTypeEnum;
70
70
  }
71
- export interface GetPartnerNotificationSettingsRequest {
71
+ export interface GetPartnerDesignDefaults0Request {
72
72
  partnerId: string;
73
73
  }
74
- export interface GetPartnerStorageDestinationRequest {
74
+ export interface GetPartnerEntryContextSigning0Request {
75
+ partnerId: string;
76
+ }
77
+ export interface GetPartnerNotificationSettings0Request {
78
+ partnerId: string;
79
+ }
80
+ export interface GetPartnerStorageDestination0Request {
75
81
  partnerId: string;
76
82
  }
77
83
  export interface GetPartnerStorageUsageRequest {
@@ -79,44 +85,67 @@ export interface GetPartnerStorageUsageRequest {
79
85
  limit?: number;
80
86
  offset?: number;
81
87
  }
82
- export interface ListPartnerNotificationDeliveriesRequest {
88
+ export interface ListPartnerNotificationDeliveries0Request {
83
89
  partnerId: string;
84
90
  limit?: number;
85
91
  }
86
- export interface ListPartnerNotificationsRequest {
92
+ export interface ListPartnerNotifications0Request {
87
93
  partnerId: string;
88
94
  limit?: number;
89
95
  before?: Date;
90
96
  }
91
- export interface ListPartnerPresetsRequest {
97
+ export interface ListPartnerPresets0Request {
92
98
  partnerId: string;
93
99
  }
94
- export interface RemovePartnerPresetRequest {
100
+ export interface RemovePartnerPreset0Request {
95
101
  partnerId: string;
96
102
  key: string;
97
103
  }
98
- export interface RemovePartnerStorageDestinationRequest {
104
+ export interface RemovePartnerStorageDestination0Request {
105
+ partnerId: string;
106
+ }
107
+ export interface ReplayPartnerNotificationDelivery0Request {
99
108
  partnerId: string;
109
+ deliveryId: string;
110
+ idempotencyKey?: string;
111
+ }
112
+ export interface RotatePartnerEntryContextSecret0Request {
113
+ partnerId: string;
114
+ idempotencyKey?: string;
100
115
  }
101
- export interface RotatePartnerWebhookSecretRequest {
116
+ export interface RotatePartnerWebhookSecret0Request {
102
117
  partnerId: string;
103
118
  idempotencyKey?: string;
104
119
  }
105
- export interface SetPartnerPresetOperationRequest {
120
+ export interface SendPartnerNotificationTestEvent0Request {
121
+ partnerId: string;
122
+ partnerNotificationTestEventRequest: PartnerNotificationTestEventRequest;
123
+ idempotencyKey?: string;
124
+ }
125
+ export interface SetPartnerDesignDefaults0Request {
126
+ partnerId: string;
127
+ setPartnerDesignDefaultsRequest: SetPartnerDesignDefaultsRequest;
128
+ }
129
+ export interface SetPartnerPreset0Request {
106
130
  partnerId: string;
107
131
  key: string;
108
132
  setPartnerPresetRequest: SetPartnerPresetRequest;
109
133
  }
110
- export interface SetPartnerStorageDestinationOperationRequest {
134
+ export interface SetPartnerStorageDestination0Request {
111
135
  partnerId: string;
112
136
  setPartnerStorageDestinationRequest: SetPartnerStorageDestinationRequest;
113
137
  }
114
- export interface UpdatePartnerNotificationSettingsOperationRequest {
138
+ export interface UpdatePartnerEntryContextSigning0Request {
139
+ partnerId: string;
140
+ updatePartnerEntryContextSigningRequest: UpdatePartnerEntryContextSigningRequest;
141
+ idempotencyKey?: string;
142
+ }
143
+ export interface UpdatePartnerNotificationSettings0Request {
115
144
  partnerId: string;
116
145
  updatePartnerNotificationSettingsRequest: UpdatePartnerNotificationSettingsRequest;
117
146
  idempotencyKey?: string;
118
147
  }
119
- export interface VerifyPartnerStorageDestinationRequest {
148
+ export interface VerifyPartnerStorageDestination0Request {
120
149
  partnerId: string;
121
150
  }
122
151
  /**
@@ -207,22 +236,22 @@ export declare class PartnersApi extends runtime.BaseAPI {
207
236
  * Retrieves operational credits, the partner\'s contract terms (`partnerCustomization`, the same fields as `getPartnerContract`) and billing integration status. Internal negotiation notes are not part of it.
208
237
  * Get comprehensive partner billing overview
209
238
  */
210
- getPartnerBillingOverviewRaw(requestParameters: GetPartnerBillingOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
239
+ getPartnerBillingOverviewRaw(requestParameters: GetPartnerBillingOverview0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
211
240
  /**
212
241
  * Retrieves operational credits, the partner\'s contract terms (`partnerCustomization`, the same fields as `getPartnerContract`) and billing integration status. Internal negotiation notes are not part of it.
213
242
  * Get comprehensive partner billing overview
214
243
  */
215
- getPartnerBillingOverview(requestParameters: GetPartnerBillingOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
244
+ getPartnerBillingOverview(requestParameters: GetPartnerBillingOverview0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
216
245
  /**
217
246
  * Returns the commercial terms agreed with the partner: price, included credits and storage, billing cycle, commitment, support level, and the dates the contract runs between. A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s. Responds 404 while no contract has been recorded for the partner, which is the case until Widgetic sets its terms.
218
247
  * Get a partner\'s contract
219
248
  */
220
- getPartnerContractRaw(requestParameters: GetPartnerContractRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerContract>>;
249
+ getPartnerContractRaw(requestParameters: GetPartnerContract0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerContract>>;
221
250
  /**
222
251
  * Returns the commercial terms agreed with the partner: price, included credits and storage, billing cycle, commitment, support level, and the dates the contract runs between. A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s. Responds 404 while no contract has been recorded for the partner, which is the case until Widgetic sets its terms.
223
252
  * Get a partner\'s contract
224
253
  */
225
- getPartnerContract(requestParameters: GetPartnerContractRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerContract>;
254
+ getPartnerContract(requestParameters: GetPartnerContract0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerContract>;
226
255
  /**
227
256
  * Retrieves the current credit balance for a partner
228
257
  * Get partner credit balance
@@ -243,26 +272,44 @@ export declare class PartnersApi extends runtime.BaseAPI {
243
272
  * Get partner credit transaction history
244
273
  */
245
274
  getPartnerCreditTransactions(requestParameters: GetPartnerCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
275
+ /**
276
+ * Read partner-wide design defaults
277
+ */
278
+ getPartnerDesignDefaultsRaw(requestParameters: GetPartnerDesignDefaults0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPartnerDesignDefaults200Response>>;
279
+ /**
280
+ * Read partner-wide design defaults
281
+ */
282
+ getPartnerDesignDefaults(requestParameters: GetPartnerDesignDefaults0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPartnerDesignDefaults200Response>;
283
+ /**
284
+ * Says whether you have a secret to sign the `context` of your embeds with, when it was made, whether the secret it replaced is still accepted, and whether an entry without a valid signature is refused (`required`). The secret itself is never part of the answer: it is shown once, when it is made (`rotatePartnerEntryContextSecret`, which also explains what signing is for and how to sign). Signing covers the entries written through the gateway into the compositions of your managed users and into those of your own account. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
285
+ * See how the context of your embeds is signed
286
+ */
287
+ getPartnerEntryContextSigningRaw(requestParameters: GetPartnerEntryContextSigning0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerEntryContextSigning>>;
288
+ /**
289
+ * Says whether you have a secret to sign the `context` of your embeds with, when it was made, whether the secret it replaced is still accepted, and whether an entry without a valid signature is refused (`required`). The secret itself is never part of the answer: it is shown once, when it is made (`rotatePartnerEntryContextSecret`, which also explains what signing is for and how to sign). Signing covers the entries written through the gateway into the compositions of your managed users and into those of your own account. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
290
+ * See how the context of your embeds is signed
291
+ */
292
+ getPartnerEntryContextSigning(requestParameters: GetPartnerEntryContextSigning0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEntryContextSigning>;
246
293
  /**
247
294
  * Returns who gets the emails, which events you want by email and by webhook, the address of your webhook, and whether it has a secret to sign with. The secret itself is never returned: it is shown once, when it is made. `events` lists every kind of event there is, for a settings screen. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
248
295
  * Where your notifications go
249
296
  */
250
- getPartnerNotificationSettingsRaw(requestParameters: GetPartnerNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettings>>;
297
+ getPartnerNotificationSettingsRaw(requestParameters: GetPartnerNotificationSettings0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettings>>;
251
298
  /**
252
299
  * Returns who gets the emails, which events you want by email and by webhook, the address of your webhook, and whether it has a secret to sign with. The secret itself is never returned: it is shown once, when it is made. `events` lists every kind of event there is, for a settings screen. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
253
300
  * Where your notifications go
254
301
  */
255
- getPartnerNotificationSettings(requestParameters: GetPartnerNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettings>;
302
+ getPartnerNotificationSettings(requestParameters: GetPartnerNotificationSettings0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettings>;
256
303
  /**
257
304
  * Returns the partner\'s storage destination without its secret: the endpoint, bucket, folder and public address, the last four characters of the access key id, when the destination last passed the check, and why the latest re-check failed if it did. Responds 404 while the partner has no destination, which means the partner cannot be activated, its uploads are refused, and no editor session is made for its customers until a destination is set. The caller must be the person who administers the partner, or a Widgetic administrator.
258
305
  * Get where a partner\'s uploaded files are stored
259
306
  */
260
- getPartnerStorageDestinationRaw(requestParameters: GetPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
307
+ getPartnerStorageDestinationRaw(requestParameters: GetPartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
261
308
  /**
262
309
  * Returns the partner\'s storage destination without its secret: the endpoint, bucket, folder and public address, the last four characters of the access key id, when the destination last passed the check, and why the latest re-check failed if it did. Responds 404 while the partner has no destination, which means the partner cannot be activated, its uploads are refused, and no editor session is made for its customers until a destination is set. The caller must be the person who administers the partner, or a Widgetic administrator.
263
310
  * Get where a partner\'s uploaded files are stored
264
311
  */
265
- getPartnerStorageDestination(requestParameters: GetPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
312
+ getPartnerStorageDestination(requestParameters: GetPartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
266
313
  /**
267
314
  * Says how many files, and how many bytes, your account keeps, in total and for each of your managed users, and how much of it is in Widgetic\'s storage and how much in your own storage destination (`setPartnerStorageDestination`). Use it to see which customers store the most, or to charge them for it. A file is counted for a managed user when it was filed under that user: by naming `managed_user_id` or `managed_user_external_id` when you upload it (`uploadsPost`, or the metadata of a resumable upload), or because it was uploaded through that user\'s editor session, which files everything under its user. The files that are not filed under anyone (your own, and the ones uploaded without naming a managed user) are the row whose `managedUserId` is null. Deleted files are not counted. To list the files of one managed user, use the `managed_user_id` filter of `uploadsGet`. The answer is counted when you ask, so it is always current. The groups are ordered by size, the heaviest first, and `page.hasMore` says whether more follow. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
268
315
  * What a partner\'s customers store
@@ -277,102 +324,152 @@ export declare class PartnersApi extends runtime.BaseAPI {
277
324
  * Lists the sends of your notifications, the newest first: each email to one address and each call to your webhook, with whether it was delivered, when it is tried again if not, how many attempts it had, and why the last one failed. Use it to find out why a webhook of yours did not receive an event. An email counts as delivered when it was handed to the mail service; a call to your webhook counts as delivered when your endpoint answered with a 2xx status. Anything else is tried again, after 1 minute, then 5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and a day, eight attempts in all, because your address is read again at each attempt and you may have mended it. Two answers end the delivery at once: `410 Gone` and `413 Payload Too Large`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
278
325
  * How your notifications reached you
279
326
  */
280
- listPartnerNotificationDeliveriesRaw(requestParameters: ListPartnerNotificationDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationDeliveryLog>>;
327
+ listPartnerNotificationDeliveriesRaw(requestParameters: ListPartnerNotificationDeliveries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationDeliveryLog>>;
281
328
  /**
282
329
  * Lists the sends of your notifications, the newest first: each email to one address and each call to your webhook, with whether it was delivered, when it is tried again if not, how many attempts it had, and why the last one failed. Use it to find out why a webhook of yours did not receive an event. An email counts as delivered when it was handed to the mail service; a call to your webhook counts as delivered when your endpoint answered with a 2xx status. Anything else is tried again, after 1 minute, then 5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and a day, eight attempts in all, because your address is read again at each attempt and you may have mended it. Two answers end the delivery at once: `410 Gone` and `413 Payload Too Large`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
283
330
  * How your notifications reached you
284
331
  */
285
- listPartnerNotificationDeliveries(requestParameters: ListPartnerNotificationDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationDeliveryLog>;
332
+ listPartnerNotificationDeliveries(requestParameters: ListPartnerNotificationDeliveries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationDeliveryLog>;
286
333
  /**
287
334
  * Lists the notifications of a partner, the newest first: the invoices Widgetic issued and their payments, the reminders to pay them, a warning when your credits run low, and the changes to the standing of the account (activated, paused, resumed). It is the same list your dashboard shows, and each entry is what your webhook receives as `data` when you have one (`updatePartnerNotificationSettings`). A page holds `limit` notifications (20 by default, at most 100). When there are older ones `nextBefore` is set: ask again with it as `before` to get the next page. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
288
335
  * What your partner account was told
289
336
  */
290
- listPartnerNotificationsRaw(requestParameters: ListPartnerNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationPage>>;
337
+ listPartnerNotificationsRaw(requestParameters: ListPartnerNotifications0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationPage>>;
291
338
  /**
292
339
  * Lists the notifications of a partner, the newest first: the invoices Widgetic issued and their payments, the reminders to pay them, a warning when your credits run low, and the changes to the standing of the account (activated, paused, resumed). It is the same list your dashboard shows, and each entry is what your webhook receives as `data` when you have one (`updatePartnerNotificationSettings`). A page holds `limit` notifications (20 by default, at most 100). When there are older ones `nextBefore` is set: ask again with it as `before` to get the next page. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
293
340
  * What your partner account was told
294
341
  */
295
- listPartnerNotifications(requestParameters: ListPartnerNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationPage>;
342
+ listPartnerNotifications(requestParameters: ListPartnerNotifications0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationPage>;
296
343
  /**
297
344
  * Returns the partner\'s presets, ordered by `position` and then by `key`: the widgets it offers its managed users as starting points. The list is the same for every managed user. Use a preset in one of two ways: - **Make a composition of it** (the content and design editor): call `createComposition` with the preset\'s `widgetId` and the managed user. The widget itself stays yours; a composition is the user\'s own content. - **Give the user a copy to build on** (the widget creator): call `copyPresetForManagedUser`. The user gets a widget and a canvas of their own. Presets are not the same as the widgets Widgetic puts on every new Widgetic account. Those are chosen by Widgetic and are copied at sign-up. A preset here is yours, and is copied only when you ask. The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator.
298
345
  * List the widgets a partner offers as presets
299
346
  */
300
- listPartnerPresetsRaw(requestParameters: ListPartnerPresetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPartnerPresets200Response>>;
347
+ listPartnerPresetsRaw(requestParameters: ListPartnerPresets0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPartnerPresets200Response>>;
301
348
  /**
302
349
  * Returns the partner\'s presets, ordered by `position` and then by `key`: the widgets it offers its managed users as starting points. The list is the same for every managed user. Use a preset in one of two ways: - **Make a composition of it** (the content and design editor): call `createComposition` with the preset\'s `widgetId` and the managed user. The widget itself stays yours; a composition is the user\'s own content. - **Give the user a copy to build on** (the widget creator): call `copyPresetForManagedUser`. The user gets a widget and a canvas of their own. Presets are not the same as the widgets Widgetic puts on every new Widgetic account. Those are chosen by Widgetic and are copied at sign-up. A preset here is yours, and is copied only when you ask. The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator.
303
350
  * List the widgets a partner offers as presets
304
351
  */
305
- listPartnerPresets(requestParameters: ListPartnerPresetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPartnerPresets200Response>;
352
+ listPartnerPresets(requestParameters: ListPartnerPresets0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPartnerPresets200Response>;
306
353
  /**
307
354
  * Removes the preset under `key`. The widget itself is not touched, and neither are the copies and the compositions already made from it. Removing a preset the partner does not have is not an error: the answer is `removed: false`.
308
355
  * Take a widget off the partner\'s presets
309
356
  */
310
- removePartnerPresetRaw(requestParameters: RemovePartnerPresetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerPresetRemoval>>;
357
+ removePartnerPresetRaw(requestParameters: RemovePartnerPreset0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerPresetRemoval>>;
311
358
  /**
312
359
  * Removes the preset under `key`. The widget itself is not touched, and neither are the copies and the compositions already made from it. Removing a preset the partner does not have is not an error: the answer is `removed: false`.
313
360
  * Take a widget off the partner\'s presets
314
361
  */
315
- removePartnerPreset(requestParameters: RemovePartnerPresetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerPresetRemoval>;
362
+ removePartnerPreset(requestParameters: RemovePartnerPreset0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerPresetRemoval>;
316
363
  /**
317
364
  * Removes the partner\'s storage destination. Partner storage is not optional, so after this the account\'s own uploads with its API key and the uploads of your customers\' editor sessions are refused (409 `PARTNER_STORAGE_REQUIRED`) until a destination is set again, and no editor session can be made. Files already in the partner\'s bucket are not touched and are not moved: they stay where they are, at the addresses they were given. Removing a destination the partner does not have is not an error: the answer is `removed: false`. The caller must be the person who administers the partner, or a Widgetic administrator.
318
365
  * Stop storing a partner\'s uploaded files in its own bucket
319
366
  */
320
- removePartnerStorageDestinationRaw(requestParameters: RemovePartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageRemoval>>;
367
+ removePartnerStorageDestinationRaw(requestParameters: RemovePartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageRemoval>>;
321
368
  /**
322
369
  * Removes the partner\'s storage destination. Partner storage is not optional, so after this the account\'s own uploads with its API key and the uploads of your customers\' editor sessions are refused (409 `PARTNER_STORAGE_REQUIRED`) until a destination is set again, and no editor session can be made. Files already in the partner\'s bucket are not touched and are not moved: they stay where they are, at the addresses they were given. Removing a destination the partner does not have is not an error: the answer is `removed: false`. The caller must be the person who administers the partner, or a Widgetic administrator.
323
370
  * Stop storing a partner\'s uploaded files in its own bucket
324
371
  */
325
- removePartnerStorageDestination(requestParameters: RemovePartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageRemoval>;
372
+ removePartnerStorageDestination(requestParameters: RemovePartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageRemoval>;
373
+ /**
374
+ * Sends one earlier **webhook** delivery again to your **current** webhook address, with the same event `id` (`webhook-id`) as the original notification so a receiver that remembers ids can ignore a duplicate, and a new `createdAt` and signature made with your current secret. The attempt is recorded in the delivery log as a new row that points at the delivery you replayed. Set a webhook address (and secret) under notification settings before you replay. Changing the settings needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
375
+ * Send a webhook delivery again
376
+ */
377
+ replayPartnerNotificationDeliveryRaw(requestParameters: ReplayPartnerNotificationDelivery0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationDelivery>>;
378
+ /**
379
+ * Sends one earlier **webhook** delivery again to your **current** webhook address, with the same event `id` (`webhook-id`) as the original notification so a receiver that remembers ids can ignore a duplicate, and a new `createdAt` and signature made with your current secret. The attempt is recorded in the delivery log as a new row that points at the delivery you replayed. Set a webhook address (and secret) under notification settings before you replay. Changing the settings needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
380
+ * Send a webhook delivery again
381
+ */
382
+ replayPartnerNotificationDelivery(requestParameters: ReplayPartnerNotificationDelivery0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationDelivery>;
383
+ /**
384
+ * Makes a secret to sign the `context` of your embeds with, and returns it in `secret`: **keep it now, it is shown once** and cannot be read again. Keep it on your server only: whoever holds it can write contexts your compositions accept. Call this again to make a new secret; the one it replaces is still accepted for a day, so that your server can switch without an entry being refused (making another within that day ends the overlap with the first). **What signing is for.** `<widgetic composition-id=\"...\" context=\'{\"customerId\":\"c_42\"}\'>` hands attribution to a widget, which sends it with every entry it saves. The page is yours but the browser is the visitor\'s: anybody can change that attribute and file an entry under another customer\'s id. When your server signs the context, the gateway refuses an entry whose context was changed, and the entries you keep hold attribution your server wrote. **How to sign** (on your server, for each page you render): 1. Take the context to give the widget. It may hold text and whole numbers only (within ±2^53, written without a fraction or an exponent). 2. Choose when the signature stops being good: `widgetic_exp`, in seconds since 1970 (UTC), no more than seven days from now. A minute of difference between clocks is forgiven. 3. Write the text to sign, with no spaces except those inside values: `widgetic-context.v1.<compositionId>.<widgetic_exp>.<json>`. `<compositionId>` is the id of the composition in lower case. `<json>` is the context as JSON with the keys in character-code order (so `Z` comes before `a`, and `10` before `9`), no spaces, strings escaped as JSON escapes them, and the two keys of the signature left out. 4. Sign that text: HMAC-SHA256 with the 32 bytes the secret stands for (the base64 text after `ctxsec_`), and write the result as base64url without padding. 5. Give the widget the context with two keys added: `widgetic_exp` and `widgetic_sig` (the signature). The whole attribute, the two keys included, stays within the limits of any context: at most 20 keys, 2048 bytes of JSON, strings up to 500 characters. The two keys take two of the 20 keys and 87 bytes of the 2048. A test vector, to check your code against before you rely on it. Secret `ctxsec_AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8=` (the bytes 0 to 31), composition `7c9e6679-7425-40de-944b-e07fc1f90ae7`, `widgetic_exp` 1792000000 and context `{\"customerId\":\"c_42\",\"plan\":\"pro\",\"seats\":3}` sign the text `widgetic-context.v1.7c9e6679-7425-40de-944b-e07fc1f90ae7.1792000000.{\"customerId\":\"c_42\",\"plan\":\"pro\",\"seats\":3}` and give the signature `j6g7151F54tl9C8oEY9levaYSppHME4fAPZ7WPwL8C8`. (The secret is the example\'s, not a real one.) **What the gateway does with an entry.** When you have a secret, an entry whose context carries a signature is checked: a signature that does not match is refused with 403 `CONTEXT_SIGNATURE_INVALID`, and one that is past `widgetic_exp` with 403 `CONTEXT_SIGNATURE_EXPIRED`. When you also require signatures (`updatePartnerEntryContextSigning`) an entry whose context carries none is refused with 403 `CONTEXT_SIGNATURE_REQUIRED`. The two keys are taken out before the entry is stored or announced: your entries and your `entry.created` events hold the context you wrote. A change you make reaches every part of the gateway within a minute. **What it does not do.** A signed context that has been seen (a page\'s source is public) can be sent again by anyone until `widgetic_exp`; when you must not accept the same context twice, put a value that is new for each page view in it (a `submissionId` you made up) and keep the ones you have seen. The signature covers the entries that reach Widgetic\'s gateway: a widget that writes straight into its own database does not pass through it. Retry this call with the same `Idempotency-Key` if its answer was lost: the answer, secret included, is then given again, and no second secret is made. This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
385
+ * Make a secret to sign the context of your embeds
386
+ */
387
+ rotatePartnerEntryContextSecretRaw(requestParameters: RotatePartnerEntryContextSecret0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerEntryContextSecret>>;
388
+ /**
389
+ * Makes a secret to sign the `context` of your embeds with, and returns it in `secret`: **keep it now, it is shown once** and cannot be read again. Keep it on your server only: whoever holds it can write contexts your compositions accept. Call this again to make a new secret; the one it replaces is still accepted for a day, so that your server can switch without an entry being refused (making another within that day ends the overlap with the first). **What signing is for.** `<widgetic composition-id=\"...\" context=\'{\"customerId\":\"c_42\"}\'>` hands attribution to a widget, which sends it with every entry it saves. The page is yours but the browser is the visitor\'s: anybody can change that attribute and file an entry under another customer\'s id. When your server signs the context, the gateway refuses an entry whose context was changed, and the entries you keep hold attribution your server wrote. **How to sign** (on your server, for each page you render): 1. Take the context to give the widget. It may hold text and whole numbers only (within ±2^53, written without a fraction or an exponent). 2. Choose when the signature stops being good: `widgetic_exp`, in seconds since 1970 (UTC), no more than seven days from now. A minute of difference between clocks is forgiven. 3. Write the text to sign, with no spaces except those inside values: `widgetic-context.v1.<compositionId>.<widgetic_exp>.<json>`. `<compositionId>` is the id of the composition in lower case. `<json>` is the context as JSON with the keys in character-code order (so `Z` comes before `a`, and `10` before `9`), no spaces, strings escaped as JSON escapes them, and the two keys of the signature left out. 4. Sign that text: HMAC-SHA256 with the 32 bytes the secret stands for (the base64 text after `ctxsec_`), and write the result as base64url without padding. 5. Give the widget the context with two keys added: `widgetic_exp` and `widgetic_sig` (the signature). The whole attribute, the two keys included, stays within the limits of any context: at most 20 keys, 2048 bytes of JSON, strings up to 500 characters. The two keys take two of the 20 keys and 87 bytes of the 2048. A test vector, to check your code against before you rely on it. Secret `ctxsec_AAECAwQFBgcICQoLDA0ODxAREhMUFRYXGBkaGxwdHh8=` (the bytes 0 to 31), composition `7c9e6679-7425-40de-944b-e07fc1f90ae7`, `widgetic_exp` 1792000000 and context `{\"customerId\":\"c_42\",\"plan\":\"pro\",\"seats\":3}` sign the text `widgetic-context.v1.7c9e6679-7425-40de-944b-e07fc1f90ae7.1792000000.{\"customerId\":\"c_42\",\"plan\":\"pro\",\"seats\":3}` and give the signature `j6g7151F54tl9C8oEY9levaYSppHME4fAPZ7WPwL8C8`. (The secret is the example\'s, not a real one.) **What the gateway does with an entry.** When you have a secret, an entry whose context carries a signature is checked: a signature that does not match is refused with 403 `CONTEXT_SIGNATURE_INVALID`, and one that is past `widgetic_exp` with 403 `CONTEXT_SIGNATURE_EXPIRED`. When you also require signatures (`updatePartnerEntryContextSigning`) an entry whose context carries none is refused with 403 `CONTEXT_SIGNATURE_REQUIRED`. The two keys are taken out before the entry is stored or announced: your entries and your `entry.created` events hold the context you wrote. A change you make reaches every part of the gateway within a minute. **What it does not do.** A signed context that has been seen (a page\'s source is public) can be sent again by anyone until `widgetic_exp`; when you must not accept the same context twice, put a value that is new for each page view in it (a `submissionId` you made up) and keep the ones you have seen. The signature covers the entries that reach Widgetic\'s gateway: a widget that writes straight into its own database does not pass through it. Retry this call with the same `Idempotency-Key` if its answer was lost: the answer, secret included, is then given again, and no second secret is made. This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
390
+ * Make a secret to sign the context of your embeds
391
+ */
392
+ rotatePartnerEntryContextSecret(requestParameters: RotatePartnerEntryContextSecret0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEntryContextSecret>;
326
393
  /**
327
394
  * Makes a new secret to sign your webhook with, and returns it in `webhookSecret`: **keep it now, it is shown once** and cannot be read again. Use it when the secret was lost, or may have leaked. The secret you had keeps signing beside the new one for a day, so that your receiver can switch without a call being rejected: during that day each call carries two signatures (see `updatePartnerNotificationSettings` for how they are verified). Rotating again within the day ends the overlap with the first secret. Retry this call with the same `Idempotency-Key` if its answer was lost: the answer, secret included, is then given again, and no second secret is made. This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
328
395
  * Make a new secret for your webhook
329
396
  */
330
- rotatePartnerWebhookSecretRaw(requestParameters: RotatePartnerWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettingsChange>>;
397
+ rotatePartnerWebhookSecretRaw(requestParameters: RotatePartnerWebhookSecret0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettingsChange>>;
331
398
  /**
332
399
  * Makes a new secret to sign your webhook with, and returns it in `webhookSecret`: **keep it now, it is shown once** and cannot be read again. Use it when the secret was lost, or may have leaked. The secret you had keeps signing beside the new one for a day, so that your receiver can switch without a call being rejected: during that day each call carries two signatures (see `updatePartnerNotificationSettings` for how they are verified). Rotating again within the day ends the overlap with the first secret. Retry this call with the same `Idempotency-Key` if its answer was lost: the answer, secret included, is then given again, and no second secret is made. This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
333
400
  * Make a new secret for your webhook
334
401
  */
335
- rotatePartnerWebhookSecret(requestParameters: RotatePartnerWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettingsChange>;
402
+ rotatePartnerWebhookSecret(requestParameters: RotatePartnerWebhookSecret0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettingsChange>;
403
+ /**
404
+ * Sends ONE signed call, right now, to the webhook address you saved under notification settings, with a sample of what an event of the type you name carries, and answers how it went: whether your receiver answered with a 2xx status, which status, how long it took, and why not when it did not arrive. Use it to write and try your receiver (above all the signature check) before a real event happens. The call is made like every other: it is signed with your current secret (and the previous one while a rotation overlaps), it carries the headers `webhook-id`, `webhook-timestamp`, `webhook-signature` and `x-widgetic-event` (the event type), and its body is `{ \"id\", \"type\", \"createdAt\", \"partnerId\", \"data\" }`. Three things differ. `id` starts with `evt_test_` and is new every time, so a receiver that remembers ids can tell a test from an event and drop it. `data` holds made-up values of the shape a real event of that type carries (`PartnerNotification` describes each), never anything about your account. And the call is made once: it is not tried again, nothing is stored, and it appears neither in the delivery log nor in the notification list. It is sent whatever `webhookEvents` says: a test is not filtered by what you subscribed to. The answer is 200 whether or not your receiver took the call (read `delivered`); a call that gets no answer within ten seconds is given up and reported as a `timeout`. A webhook address and a signing secret must be saved first (`updatePartnerNotificationSettings`); until then the answer is 409. This needs an API key with full access, and `Idempotency-Key` is required: a retry with the same key gets the first answer back and no second call is made. The caller must be the person who administers the partner, or a Widgetic administrator. Five tests a minute.
405
+ * Send a test event to your webhook
406
+ */
407
+ sendPartnerNotificationTestEventRaw(requestParameters: SendPartnerNotificationTestEvent0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationTestEventResult>>;
408
+ /**
409
+ * Sends ONE signed call, right now, to the webhook address you saved under notification settings, with a sample of what an event of the type you name carries, and answers how it went: whether your receiver answered with a 2xx status, which status, how long it took, and why not when it did not arrive. Use it to write and try your receiver (above all the signature check) before a real event happens. The call is made like every other: it is signed with your current secret (and the previous one while a rotation overlaps), it carries the headers `webhook-id`, `webhook-timestamp`, `webhook-signature` and `x-widgetic-event` (the event type), and its body is `{ \"id\", \"type\", \"createdAt\", \"partnerId\", \"data\" }`. Three things differ. `id` starts with `evt_test_` and is new every time, so a receiver that remembers ids can tell a test from an event and drop it. `data` holds made-up values of the shape a real event of that type carries (`PartnerNotification` describes each), never anything about your account. And the call is made once: it is not tried again, nothing is stored, and it appears neither in the delivery log nor in the notification list. It is sent whatever `webhookEvents` says: a test is not filtered by what you subscribed to. The answer is 200 whether or not your receiver took the call (read `delivered`); a call that gets no answer within ten seconds is given up and reported as a `timeout`. A webhook address and a signing secret must be saved first (`updatePartnerNotificationSettings`); until then the answer is 409. This needs an API key with full access, and `Idempotency-Key` is required: a retry with the same key gets the first answer back and no second call is made. The caller must be the person who administers the partner, or a Widgetic administrator. Five tests a minute.
410
+ * Send a test event to your webhook
411
+ */
412
+ sendPartnerNotificationTestEvent(requestParameters: SendPartnerNotificationTestEvent0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationTestEventResult>;
413
+ /**
414
+ * Send `{ \"design\": { ... } }` or `{ \"design\": null }` to remove. New compositions merge this layer over the widget base and under each managed user\'s default and the request body.
415
+ * Set or clear partner-wide design defaults
416
+ */
417
+ setPartnerDesignDefaultsRaw(requestParameters: SetPartnerDesignDefaults0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
418
+ /**
419
+ * Send `{ \"design\": { ... } }` or `{ \"design\": null }` to remove. New compositions merge this layer over the widget base and under each managed user\'s default and the request body.
420
+ * Set or clear partner-wide design defaults
421
+ */
422
+ setPartnerDesignDefaults(requestParameters: SetPartnerDesignDefaults0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
336
423
  /**
337
424
  * Offers one of the partner\'s own widgets as a preset under `key`. If the partner already has a preset under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole preset: a `title`, `description` or `position` you leave out goes back to its default. Keys are 1 to 64 characters: lowercase letters, digits, hyphens and underscores, the first a letter or a digit (`rating`, `quiz-3`). The widget must belong to the partner\'s account; a widget that does not exist and one that belongs to somebody else are refused in the same way (404 `PRESET_WIDGET_NOT_FOUND`). A widget is a preset under at most one key (409 `PRESET_WIDGET_ALREADY_USED`; `details.key` says which), and an account can have at most 100 presets (409 `PRESET_LIMIT_REACHED`). Later changes to the widget reach new copies and new compositions; copies made earlier are not touched. Deleting the widget removes its preset.
338
425
  * Make a widget a preset, or replace a preset
339
426
  */
340
- setPartnerPresetRaw(requestParameters: SetPartnerPresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerPreset>>;
427
+ setPartnerPresetRaw(requestParameters: SetPartnerPreset0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerPreset>>;
341
428
  /**
342
429
  * Offers one of the partner\'s own widgets as a preset under `key`. If the partner already has a preset under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole preset: a `title`, `description` or `position` you leave out goes back to its default. Keys are 1 to 64 characters: lowercase letters, digits, hyphens and underscores, the first a letter or a digit (`rating`, `quiz-3`). The widget must belong to the partner\'s account; a widget that does not exist and one that belongs to somebody else are refused in the same way (404 `PRESET_WIDGET_NOT_FOUND`). A widget is a preset under at most one key (409 `PRESET_WIDGET_ALREADY_USED`; `details.key` says which), and an account can have at most 100 presets (409 `PRESET_LIMIT_REACHED`). Later changes to the widget reach new copies and new compositions; copies made earlier are not touched. Deleting the widget removes its preset.
343
430
  * Make a widget a preset, or replace a preset
344
431
  */
345
- setPartnerPreset(requestParameters: SetPartnerPresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerPreset>;
432
+ setPartnerPreset(requestParameters: SetPartnerPreset0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerPreset>;
346
433
  /**
347
434
  * Points the partner at a bucket of its own on an S3-compatible service (Amazon S3, Backblaze B2, Cloudflare R2, Wasabi, MinIO and the like). From then on, a file uploaded with `uploadsPost` by the account that administers the partner is stored in that bucket instead of with Widgetic. It takes none of the account\'s storage allowance, and its `url` is served from `public_base_url`. Only uploads sent with an API key, an SDK token or an editor session use the destination. Uploads from the Widgetic website, resumable uploads and the media library keep using Widgetic\'s storage. A destination is required. Partner storage is not optional: your customers\' files, and your own uploads with your API key, are kept in this destination and nowhere else. An editor session (`createManagedUserEditorSession`) of any surface cannot be made until a destination is set (409 `PARTNER_STORAGE_REQUIRED`), a destination removed later stops the uploads of the sessions already made (the same 409), and your own upload with no destination is refused in the same way instead of being stored with Widgetic. A partner cannot be activated until it has a destination that works. The destination is checked before it is saved. Widgetic writes a small test file under `<key_prefix>widgetic-check/`, reads it back from `<public_base_url>/<its key>`, and deletes it. If any step fails nothing is saved and the answer is 422 `STORAGE_DESTINATION_UNVERIFIED`: `details.step` says where (`endpoint`, `write` or `public_read`), `details.reason` says why, and `param` names the field most likely to be wrong. What the bucket needs: - an access key that may put objects into it (it may also delete objects, which lets the test file be cleaned up, but that is not required); - its files publicly readable at `public_base_url`, either because the bucket is public or through a CDN. The secret access key is stored encrypted and is never returned or logged; a response shows only the last four characters of the access key id (`accessKeyHint`). Saving replaces the whole destination, so send every field again, including the secret. Files already stored stay where they are, and keep working for as long as that bucket stays publicly readable. Once a destination is set, an upload is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 `STORAGE_DESTINATION_UNAVAILABLE`, and when the bucket rejects the file with 502 `STORAGE_DESTINATION_WRITE_FAILED`. The caller must be the person who administers the partner (an API key of that account works); anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can set any partner\'s.
348
435
  * Set where a partner\'s uploaded files are stored
349
436
  */
350
- setPartnerStorageDestinationRaw(requestParameters: SetPartnerStorageDestinationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
437
+ setPartnerStorageDestinationRaw(requestParameters: SetPartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
351
438
  /**
352
439
  * Points the partner at a bucket of its own on an S3-compatible service (Amazon S3, Backblaze B2, Cloudflare R2, Wasabi, MinIO and the like). From then on, a file uploaded with `uploadsPost` by the account that administers the partner is stored in that bucket instead of with Widgetic. It takes none of the account\'s storage allowance, and its `url` is served from `public_base_url`. Only uploads sent with an API key, an SDK token or an editor session use the destination. Uploads from the Widgetic website, resumable uploads and the media library keep using Widgetic\'s storage. A destination is required. Partner storage is not optional: your customers\' files, and your own uploads with your API key, are kept in this destination and nowhere else. An editor session (`createManagedUserEditorSession`) of any surface cannot be made until a destination is set (409 `PARTNER_STORAGE_REQUIRED`), a destination removed later stops the uploads of the sessions already made (the same 409), and your own upload with no destination is refused in the same way instead of being stored with Widgetic. A partner cannot be activated until it has a destination that works. The destination is checked before it is saved. Widgetic writes a small test file under `<key_prefix>widgetic-check/`, reads it back from `<public_base_url>/<its key>`, and deletes it. If any step fails nothing is saved and the answer is 422 `STORAGE_DESTINATION_UNVERIFIED`: `details.step` says where (`endpoint`, `write` or `public_read`), `details.reason` says why, and `param` names the field most likely to be wrong. What the bucket needs: - an access key that may put objects into it (it may also delete objects, which lets the test file be cleaned up, but that is not required); - its files publicly readable at `public_base_url`, either because the bucket is public or through a CDN. The secret access key is stored encrypted and is never returned or logged; a response shows only the last four characters of the access key id (`accessKeyHint`). Saving replaces the whole destination, so send every field again, including the secret. Files already stored stay where they are, and keep working for as long as that bucket stays publicly readable. Once a destination is set, an upload is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 `STORAGE_DESTINATION_UNAVAILABLE`, and when the bucket rejects the file with 502 `STORAGE_DESTINATION_WRITE_FAILED`. The caller must be the person who administers the partner (an API key of that account works); anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can set any partner\'s.
353
440
  * Set where a partner\'s uploaded files are stored
354
441
  */
355
- setPartnerStorageDestination(requestParameters: SetPartnerStorageDestinationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
442
+ setPartnerStorageDestination(requestParameters: SetPartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
443
+ /**
444
+ * Chooses what the gateway does with an entry whose `context` carries no valid signature. With `required: false` (the default) an entry that carries a signature is checked and refused when the signature is wrong or out of date, and an entry that carries none is accepted, as it always was. With `required: true` an entry without a valid signature is refused with 403 `CONTEXT_SIGNATURE_REQUIRED`: use it once every page of yours that embeds a composition signs its context. Signatures cannot be required before you have made a secret (`rotatePartnerEntryContextSecret`): the answer is 409, so that you cannot lock your own compositions out of taking entries. The change reaches every part of the gateway within a minute. Saving the same choice twice leaves the same state, so a retry is harmless and `Idempotency-Key` is optional. This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
445
+ * Require a signed context, or stop requiring it
446
+ */
447
+ updatePartnerEntryContextSigningRaw(requestParameters: UpdatePartnerEntryContextSigning0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerEntryContextSigning>>;
448
+ /**
449
+ * Chooses what the gateway does with an entry whose `context` carries no valid signature. With `required: false` (the default) an entry that carries a signature is checked and refused when the signature is wrong or out of date, and an entry that carries none is accepted, as it always was. With `required: true` an entry without a valid signature is refused with 403 `CONTEXT_SIGNATURE_REQUIRED`: use it once every page of yours that embeds a composition signs its context. Signatures cannot be required before you have made a secret (`rotatePartnerEntryContextSecret`): the answer is 409, so that you cannot lock your own compositions out of taking entries. The change reaches every part of the gateway within a minute. Saving the same choice twice leaves the same state, so a retry is harmless and `Idempotency-Key` is optional. This needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
450
+ * Require a signed context, or stop requiring it
451
+ */
452
+ updatePartnerEntryContextSigning(requestParameters: UpdatePartnerEntryContextSigning0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEntryContextSigning>;
356
453
  /**
357
454
  * Changes who gets the emails, which events you want by email and by webhook, and the address of your webhook. A key you leave out of the body is left as it was; send only what changes. **Email.** `emailRecipients` is the list of addresses (at most five). While it is empty the emails about invoices go to the billing emails of your billing profile (your contact email when there are none), and the others to your contact email. The events about money and about the standing of your account are always emailed, whatever `emailEvents` says; it narrows the others. **Webhook.** `webhookUrl` is where Widgetic sends a signed `POST` for each event, so that your own system can act on it (mark an invoice paid, warn your team that credits are low). The address must be `https` on the standard port, on a public site, and must not redirect. Setting an address when you have no secret yet makes one, and the answer carries it as `webhookSecret`: **keep it now, it is shown once**. `webhookEvents` narrows what is sent. Each call has a JSON body, `{ \"id\": \"evt_...\", \"type\": \"invoice.paid\", \"createdAt\": \"...\", \"partnerId\": \"...\", \"data\": { ... } }` (`data` is the `data` of `PartnerNotification`), and these headers: `webhook-id` (the same as `id`, and the same on every retry), `webhook-timestamp` (seconds since 1970) and `webhook-signature` (`v1,` and a base64 HMAC-SHA256). It is the Standard Webhooks scheme, so any of its libraries verifies it. By hand: take your secret without the `whsec_` prefix, decode it from base64, and sign the text `<webhook-id>.<webhook-timestamp>.<the raw body>` with it; the header holds `v1,<base64 of the result>` (two signatures separated by a space while a rotated secret overlaps). Reject a `webhook-timestamp` that is more than five minutes old. Answer with a 2xx status within ten seconds. Anything else is tried again, eight attempts in all over about two days (`listPartnerNotificationDeliveries` shows each). Delivery is at least once: if your answer was lost the same event arrives again with the same `id`, so drop what you have already handled by it. Changing the settings needs an API key with full access: they decide where your notifications go. The caller must be the person who administers the partner, or a Widgetic administrator.
358
455
  * Choose where your notifications go
359
456
  */
360
- updatePartnerNotificationSettingsRaw(requestParameters: UpdatePartnerNotificationSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettingsChange>>;
457
+ updatePartnerNotificationSettingsRaw(requestParameters: UpdatePartnerNotificationSettings0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettingsChange>>;
361
458
  /**
362
459
  * Changes who gets the emails, which events you want by email and by webhook, and the address of your webhook. A key you leave out of the body is left as it was; send only what changes. **Email.** `emailRecipients` is the list of addresses (at most five). While it is empty the emails about invoices go to the billing emails of your billing profile (your contact email when there are none), and the others to your contact email. The events about money and about the standing of your account are always emailed, whatever `emailEvents` says; it narrows the others. **Webhook.** `webhookUrl` is where Widgetic sends a signed `POST` for each event, so that your own system can act on it (mark an invoice paid, warn your team that credits are low). The address must be `https` on the standard port, on a public site, and must not redirect. Setting an address when you have no secret yet makes one, and the answer carries it as `webhookSecret`: **keep it now, it is shown once**. `webhookEvents` narrows what is sent. Each call has a JSON body, `{ \"id\": \"evt_...\", \"type\": \"invoice.paid\", \"createdAt\": \"...\", \"partnerId\": \"...\", \"data\": { ... } }` (`data` is the `data` of `PartnerNotification`), and these headers: `webhook-id` (the same as `id`, and the same on every retry), `webhook-timestamp` (seconds since 1970) and `webhook-signature` (`v1,` and a base64 HMAC-SHA256). It is the Standard Webhooks scheme, so any of its libraries verifies it. By hand: take your secret without the `whsec_` prefix, decode it from base64, and sign the text `<webhook-id>.<webhook-timestamp>.<the raw body>` with it; the header holds `v1,<base64 of the result>` (two signatures separated by a space while a rotated secret overlaps). Reject a `webhook-timestamp` that is more than five minutes old. Answer with a 2xx status within ten seconds. Anything else is tried again, eight attempts in all over about two days (`listPartnerNotificationDeliveries` shows each). Delivery is at least once: if your answer was lost the same event arrives again with the same `id`, so drop what you have already handled by it. Changing the settings needs an API key with full access: they decide where your notifications go. The caller must be the person who administers the partner, or a Widgetic administrator.
363
460
  * Choose where your notifications go
364
461
  */
365
- updatePartnerNotificationSettings(requestParameters: UpdatePartnerNotificationSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettingsChange>;
462
+ updatePartnerNotificationSettings(requestParameters: UpdatePartnerNotificationSettings0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettingsChange>;
366
463
  /**
367
464
  * Runs the same check as `setPartnerStorageDestination` against the destination already saved: a test file is written, read back from the public address and deleted. Use it after rotating a key or changing a bucket policy, or when uploads are failing with 502 or 503. The result is recorded either way. A pass refreshes `verifiedAt` and clears `lastVerificationError`; a failure answers 422 `STORAGE_DESTINATION_UNVERIFIED` and is recorded in `lastVerificationError` and `lastVerificationFailedAt`, so the destination shows what went wrong the next time it is read. A failed check does not remove the destination or stop uploads from using it. The caller must be the person who administers the partner, or a Widgetic administrator.
368
465
  * Check that a partner\'s storage destination still works
369
466
  */
370
- verifyPartnerStorageDestinationRaw(requestParameters: VerifyPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
467
+ verifyPartnerStorageDestinationRaw(requestParameters: VerifyPartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
371
468
  /**
372
469
  * Runs the same check as `setPartnerStorageDestination` against the destination already saved: a test file is written, read back from the public address and deleted. Use it after rotating a key or changing a bucket policy, or when uploads are failing with 502 or 503. The result is recorded either way. A pass refreshes `verifiedAt` and clears `lastVerificationError`; a failure answers 422 `STORAGE_DESTINATION_UNVERIFIED` and is recorded in `lastVerificationError` and `lastVerificationFailedAt`, so the destination shows what went wrong the next time it is read. A failed check does not remove the destination or stop uploads from using it. The caller must be the person who administers the partner, or a Widgetic administrator.
373
470
  * Check that a partner\'s storage destination still works
374
471
  */
375
- verifyPartnerStorageDestination(requestParameters: VerifyPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
472
+ verifyPartnerStorageDestination(requestParameters: VerifyPartnerStorageDestination0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
376
473
  }
377
474
  /**
378
475
  * @export