@widgetic/api-sdk 1.0.31 → 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 (443) hide show
  1. package/dist/apis/CompositionsApi.d.ts +17 -13
  2. package/dist/apis/CompositionsApi.js +19 -12
  3. package/dist/apis/PartnerApi.d.ts +77 -16
  4. package/dist/apis/PartnerApi.js +186 -12
  5. package/dist/apis/PartnersApi.d.ts +58 -1
  6. package/dist/apis/PartnersApi.js +167 -0
  7. package/dist/apis/PublicEmbedApi.d.ts +42 -3
  8. package/dist/apis/PublicEmbedApi.js +99 -2
  9. package/dist/apis/index.d.ts +0 -4
  10. package/dist/apis/index.js +0 -4
  11. package/dist/esm/apis/CompositionsApi.d.ts +17 -13
  12. package/dist/esm/apis/CompositionsApi.js +20 -13
  13. package/dist/esm/apis/PartnerApi.d.ts +77 -16
  14. package/dist/esm/apis/PartnerApi.js +187 -13
  15. package/dist/esm/apis/PartnersApi.d.ts +58 -1
  16. package/dist/esm/apis/PartnersApi.js +168 -1
  17. package/dist/esm/apis/PublicEmbedApi.d.ts +42 -3
  18. package/dist/esm/apis/PublicEmbedApi.js +100 -3
  19. package/dist/esm/apis/index.d.ts +0 -4
  20. package/dist/esm/apis/index.js +0 -4
  21. package/dist/esm/models/Composition.d.ts +12 -0
  22. package/dist/esm/models/Composition.js +2 -0
  23. package/dist/esm/models/CompositionDataSource.d.ts +41 -0
  24. package/dist/esm/models/CompositionDataSource.js +47 -0
  25. package/dist/esm/models/CompositionEntriesReading.d.ts +20 -4
  26. package/dist/esm/models/CompositionEntriesReading.js +3 -0
  27. package/dist/esm/models/CompositionEntryAggregateTally.d.ts +15 -8
  28. package/dist/esm/models/CompositionEntryAggregatesBlock.d.ts +10 -0
  29. package/dist/esm/models/CompositionEntryItem.d.ts +4 -1
  30. package/dist/esm/models/CompositionEntryItemsMeta.d.ts +8 -0
  31. package/dist/esm/models/DeleteCompositionDataSource200Response.d.ts +32 -0
  32. package/dist/esm/models/DeleteCompositionDataSource200Response.js +43 -0
  33. package/dist/esm/models/GetPublicCompositionEmbed200Response.d.ts +106 -0
  34. package/dist/esm/models/GetPublicCompositionEmbed200Response.js +67 -0
  35. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDataSource.d.ts +38 -0
  36. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDataSource.js +43 -0
  37. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDirect.d.ts +44 -0
  38. package/dist/esm/models/GetPublicCompositionEmbed200ResponseDirect.js +45 -0
  39. package/dist/esm/models/GetPublicCompositionEmbed403Response.d.ts +51 -0
  40. package/dist/esm/models/GetPublicCompositionEmbed403Response.js +48 -0
  41. package/dist/esm/models/GetPublicCompositionEmbed403ResponseDetails.d.ts +46 -0
  42. package/dist/esm/models/GetPublicCompositionEmbed403ResponseDetails.js +50 -0
  43. package/dist/esm/models/GetPublicCompositionEmbed404Response.d.ts +47 -0
  44. package/dist/esm/models/GetPublicCompositionEmbed404Response.js +51 -0
  45. package/dist/esm/models/GetPublicCompositionEmbed429Response.d.ts +38 -0
  46. package/dist/esm/models/GetPublicCompositionEmbed429Response.js +43 -0
  47. package/dist/esm/models/ManagedUserEntryItem.d.ts +4 -1
  48. package/dist/esm/models/PartnerEntryContextSecret.d.ts +39 -0
  49. package/dist/esm/models/PartnerEntryContextSecret.js +48 -0
  50. package/dist/esm/models/PartnerEntryContextSigning.d.ts +62 -0
  51. package/dist/esm/models/PartnerEntryContextSigning.js +63 -0
  52. package/dist/esm/models/PartnerNotification.d.ts +1 -1
  53. package/dist/esm/models/PartnerNotificationTestEventRequest.d.ts +33 -0
  54. package/dist/esm/models/PartnerNotificationTestEventRequest.js +44 -0
  55. package/dist/esm/models/PartnerNotificationTestEventResult.d.ts +50 -0
  56. package/dist/esm/models/PartnerNotificationTestEventResult.js +53 -0
  57. package/dist/esm/models/PostPublicCompositionEmbedStatus200Response.d.ts +39 -0
  58. package/dist/esm/models/PostPublicCompositionEmbedStatus200Response.js +44 -0
  59. package/dist/esm/models/PostPublicCompositionEmbedStatus200ResponseData.d.ts +45 -0
  60. package/dist/esm/models/PostPublicCompositionEmbedStatus200ResponseData.js +51 -0
  61. package/dist/esm/models/PostPublicCompositionEmbedStatus429Response.d.ts +32 -0
  62. package/dist/esm/models/PostPublicCompositionEmbedStatus429Response.js +41 -0
  63. package/dist/esm/models/PostPublicCompositionEmbedStatusRequest.d.ts +32 -0
  64. package/dist/esm/models/PostPublicCompositionEmbedStatusRequest.js +43 -0
  65. package/dist/esm/models/PublicCompositionEntryRequest.d.ts +1 -1
  66. package/dist/esm/models/UpdatePartnerEntryContextSigningRequest.d.ts +32 -0
  67. package/dist/esm/models/UpdatePartnerEntryContextSigningRequest.js +43 -0
  68. package/dist/esm/models/index.d.ts +18 -77
  69. package/dist/esm/models/index.js +18 -77
  70. package/dist/models/Composition.d.ts +12 -0
  71. package/dist/models/Composition.js +2 -0
  72. package/dist/models/CompositionDataSource.d.ts +41 -0
  73. package/dist/models/CompositionDataSource.js +54 -0
  74. package/dist/models/CompositionEntriesReading.d.ts +20 -4
  75. package/dist/models/CompositionEntriesReading.js +3 -0
  76. package/dist/models/CompositionEntryAggregateTally.d.ts +15 -8
  77. package/dist/models/CompositionEntryAggregatesBlock.d.ts +10 -0
  78. package/dist/models/CompositionEntryItem.d.ts +4 -1
  79. package/dist/models/CompositionEntryItemsMeta.d.ts +8 -0
  80. package/dist/models/DeleteCompositionDataSource200Response.d.ts +32 -0
  81. package/dist/models/DeleteCompositionDataSource200Response.js +50 -0
  82. package/dist/models/GetPublicCompositionEmbed200Response.d.ts +106 -0
  83. package/dist/models/GetPublicCompositionEmbed200Response.js +74 -0
  84. package/dist/models/GetPublicCompositionEmbed200ResponseDataSource.d.ts +38 -0
  85. package/dist/models/GetPublicCompositionEmbed200ResponseDataSource.js +50 -0
  86. package/dist/models/GetPublicCompositionEmbed200ResponseDirect.d.ts +44 -0
  87. package/dist/models/GetPublicCompositionEmbed200ResponseDirect.js +52 -0
  88. package/dist/models/GetPublicCompositionEmbed403Response.d.ts +51 -0
  89. package/dist/models/GetPublicCompositionEmbed403Response.js +55 -0
  90. package/dist/models/GetPublicCompositionEmbed403ResponseDetails.d.ts +46 -0
  91. package/dist/models/GetPublicCompositionEmbed403ResponseDetails.js +58 -0
  92. package/dist/models/GetPublicCompositionEmbed404Response.d.ts +47 -0
  93. package/dist/models/GetPublicCompositionEmbed404Response.js +59 -0
  94. package/dist/models/GetPublicCompositionEmbed429Response.d.ts +38 -0
  95. package/dist/models/GetPublicCompositionEmbed429Response.js +50 -0
  96. package/dist/models/ManagedUserEntryItem.d.ts +4 -1
  97. package/dist/models/PartnerEntryContextSecret.d.ts +39 -0
  98. package/dist/models/PartnerEntryContextSecret.js +55 -0
  99. package/dist/models/PartnerEntryContextSigning.d.ts +62 -0
  100. package/dist/models/PartnerEntryContextSigning.js +70 -0
  101. package/dist/models/PartnerNotification.d.ts +1 -1
  102. package/dist/models/PartnerNotificationTestEventRequest.d.ts +33 -0
  103. package/dist/models/PartnerNotificationTestEventRequest.js +51 -0
  104. package/dist/models/PartnerNotificationTestEventResult.d.ts +50 -0
  105. package/dist/models/PartnerNotificationTestEventResult.js +60 -0
  106. package/dist/models/PostPublicCompositionEmbedStatus200Response.d.ts +39 -0
  107. package/dist/models/PostPublicCompositionEmbedStatus200Response.js +51 -0
  108. package/dist/models/PostPublicCompositionEmbedStatus200ResponseData.d.ts +45 -0
  109. package/dist/models/PostPublicCompositionEmbedStatus200ResponseData.js +59 -0
  110. package/dist/models/PostPublicCompositionEmbedStatus429Response.d.ts +32 -0
  111. package/dist/models/PostPublicCompositionEmbedStatus429Response.js +48 -0
  112. package/dist/models/PostPublicCompositionEmbedStatusRequest.d.ts +32 -0
  113. package/dist/models/PostPublicCompositionEmbedStatusRequest.js +50 -0
  114. package/dist/models/PublicCompositionEntryRequest.d.ts +1 -1
  115. package/dist/models/UpdatePartnerEntryContextSigningRequest.d.ts +32 -0
  116. package/dist/models/UpdatePartnerEntryContextSigningRequest.js +50 -0
  117. package/dist/models/index.d.ts +18 -77
  118. package/dist/models/index.js +18 -77
  119. package/package.json +1 -1
  120. package/dist/apis/AgentRepositoryManagementApi.d.ts +0 -32
  121. package/dist/apis/AgentRepositoryManagementApi.js +0 -75
  122. package/dist/apis/EnterpriseCustomizationsApi.d.ts +0 -87
  123. package/dist/apis/EnterpriseCustomizationsApi.js +0 -233
  124. package/dist/apis/UIComponentsApi.d.ts +0 -96
  125. package/dist/apis/UIComponentsApi.js +0 -209
  126. package/dist/apis/WorkflowsApi.d.ts +0 -44
  127. package/dist/apis/WorkflowsApi.js +0 -111
  128. package/dist/esm/apis/AgentRepositoryManagementApi.d.ts +0 -32
  129. package/dist/esm/apis/AgentRepositoryManagementApi.js +0 -71
  130. package/dist/esm/apis/EnterpriseCustomizationsApi.d.ts +0 -87
  131. package/dist/esm/apis/EnterpriseCustomizationsApi.js +0 -229
  132. package/dist/esm/apis/UIComponentsApi.d.ts +0 -96
  133. package/dist/esm/apis/UIComponentsApi.js +0 -205
  134. package/dist/esm/apis/WorkflowsApi.d.ts +0 -44
  135. package/dist/esm/apis/WorkflowsApi.js +0 -107
  136. package/dist/esm/models/AgentRepositoriesRepoIdSyncPost202Response.d.ts +0 -32
  137. package/dist/esm/models/AgentRepositoriesRepoIdSyncPost202Response.js +0 -41
  138. package/dist/esm/models/AgentRepositoriesRepoIdSyncPostRequest.d.ts +0 -32
  139. package/dist/esm/models/AgentRepositoriesRepoIdSyncPostRequest.js +0 -43
  140. package/dist/esm/models/AgentTasksTaskIdStatusPutRequest.d.ts +0 -54
  141. package/dist/esm/models/AgentTasksTaskIdStatusPutRequest.js +0 -60
  142. package/dist/esm/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.d.ts +0 -32
  143. package/dist/esm/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.js +0 -41
  144. package/dist/esm/models/ApiV1AdminBillingGrantsPostRequest.d.ts +0 -82
  145. package/dist/esm/models/ApiV1AdminBillingGrantsPostRequest.js +0 -79
  146. package/dist/esm/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.d.ts +0 -32
  147. package/dist/esm/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.js +0 -41
  148. package/dist/esm/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.d.ts +0 -32
  149. package/dist/esm/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.js +0 -43
  150. package/dist/esm/models/ApiV1AdminBillingRefundsPostRequest.d.ts +0 -64
  151. package/dist/esm/models/ApiV1AdminBillingRefundsPostRequest.js +0 -60
  152. package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200Response.d.ts +0 -71
  153. package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200Response.js +0 -59
  154. package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.d.ts +0 -51
  155. package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.js +0 -48
  156. package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPostRequest.d.ts +0 -70
  157. package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPostRequest.js +0 -62
  158. package/dist/esm/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.d.ts +0 -46
  159. package/dist/esm/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.js +0 -52
  160. package/dist/esm/models/ApiV1BillingPricingGet200Response.d.ts +0 -39
  161. package/dist/esm/models/ApiV1BillingPricingGet200Response.js +0 -44
  162. package/dist/esm/models/ApiV1BillingPricingGet200ResponseData.d.ts +0 -46
  163. package/dist/esm/models/ApiV1BillingPricingGet200ResponseData.js +0 -47
  164. package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataPlansInner.d.ts +0 -68
  165. package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataPlansInner.js +0 -53
  166. package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataTrial.d.ts +0 -44
  167. package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataTrial.js +0 -45
  168. package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200Response.d.ts +0 -39
  169. package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200Response.js +0 -44
  170. package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.d.ts +0 -33
  171. package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.js +0 -42
  172. package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.d.ts +0 -68
  173. package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.js +0 -53
  174. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.d.ts +0 -39
  175. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.js +0 -44
  176. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.d.ts +0 -32
  177. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.js +0 -41
  178. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +0 -39
  179. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +0 -44
  180. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +0 -32
  181. package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +0 -41
  182. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.d.ts +0 -39
  183. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.js +0 -44
  184. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.d.ts +0 -32
  185. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.js +0 -41
  186. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.d.ts +0 -32
  187. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.js +0 -41
  188. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.d.ts +0 -39
  189. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.js +0 -44
  190. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.d.ts +0 -120
  191. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.js +0 -76
  192. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.d.ts +0 -39
  193. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.js +0 -44
  194. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.d.ts +0 -38
  195. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.js +0 -43
  196. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.d.ts +0 -39
  197. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.js +0 -44
  198. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.d.ts +0 -38
  199. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.js +0 -43
  200. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.d.ts +0 -53
  201. package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.js +0 -58
  202. package/dist/esm/models/ApiV1MetricsGet200Response.d.ts +0 -39
  203. package/dist/esm/models/ApiV1MetricsGet200Response.js +0 -44
  204. package/dist/esm/models/ApiV1MetricsGet200ResponseData.d.ts +0 -56
  205. package/dist/esm/models/ApiV1MetricsGet200ResponseData.js +0 -50
  206. package/dist/esm/models/ApiV1MetricsGet200ResponseDataErrorsValue.d.ts +0 -44
  207. package/dist/esm/models/ApiV1MetricsGet200ResponseDataErrorsValue.js +0 -45
  208. package/dist/esm/models/ApiV1MetricsGet200ResponseDataLatencyValue.d.ts +0 -50
  209. package/dist/esm/models/ApiV1MetricsGet200ResponseDataLatencyValue.js +0 -47
  210. package/dist/esm/models/ApiV1MetricsLatencyGet200Response.d.ts +0 -41
  211. package/dist/esm/models/ApiV1MetricsLatencyGet200Response.js +0 -45
  212. package/dist/esm/models/ApiV1MetricsLatencyGet200ResponseDataValue.d.ts +0 -62
  213. package/dist/esm/models/ApiV1MetricsLatencyGet200ResponseDataValue.js +0 -51
  214. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.d.ts +0 -71
  215. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.js +0 -59
  216. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.d.ts +0 -51
  217. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.js +0 -48
  218. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.d.ts +0 -38
  219. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.js +0 -43
  220. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.d.ts +0 -44
  221. package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.js +0 -45
  222. package/dist/esm/models/CancelCurrentSubscription200Response.d.ts +0 -45
  223. package/dist/esm/models/CancelCurrentSubscription200Response.js +0 -46
  224. package/dist/esm/models/CancelCurrentSubscriptionRequest.d.ts +0 -44
  225. package/dist/esm/models/CancelCurrentSubscriptionRequest.js +0 -45
  226. package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.d.ts +0 -38
  227. package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.js +0 -43
  228. package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.d.ts +0 -38
  229. package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.js +0 -47
  230. package/dist/esm/models/ComponentManifest.d.ts +0 -52
  231. package/dist/esm/models/ComponentManifest.js +0 -49
  232. package/dist/esm/models/ComponentManifestAssets.d.ts +0 -38
  233. package/dist/esm/models/ComponentManifestAssets.js +0 -43
  234. package/dist/esm/models/ComponentManifestConfig.d.ts +0 -44
  235. package/dist/esm/models/ComponentManifestConfig.js +0 -45
  236. package/dist/esm/models/CreateCheckoutSession200Response.d.ts +0 -38
  237. package/dist/esm/models/CreateCheckoutSession200Response.js +0 -43
  238. package/dist/esm/models/CreateCheckoutSessionRequest.d.ts +0 -32
  239. package/dist/esm/models/CreateCheckoutSessionRequest.js +0 -43
  240. package/dist/esm/models/CreateComposition201Response.d.ts +0 -39
  241. package/dist/esm/models/CreateComposition201Response.js +0 -44
  242. package/dist/esm/models/DevelopmentPlan.d.ts +0 -97
  243. package/dist/esm/models/DevelopmentPlan.js +0 -69
  244. package/dist/esm/models/DevelopmentTask.d.ts +0 -90
  245. package/dist/esm/models/DevelopmentTask.js +0 -66
  246. package/dist/esm/models/EnterpriseCustomization.d.ts +0 -125
  247. package/dist/esm/models/EnterpriseCustomization.js +0 -77
  248. package/dist/esm/models/GenerateComponentWorkflowInput.d.ts +0 -56
  249. package/dist/esm/models/GenerateComponentWorkflowInput.js +0 -55
  250. package/dist/esm/models/GenerateMixedComponentInput.d.ts +0 -62
  251. package/dist/esm/models/GenerateMixedComponentInput.js +0 -59
  252. package/dist/esm/models/GetOrganizationStorageUsage200ResponseDataBreakdown.d.ts +0 -44
  253. package/dist/esm/models/GetOrganizationStorageUsage200ResponseDataBreakdown.js +0 -45
  254. package/dist/esm/models/ListComponents200Response.d.ts +0 -33
  255. package/dist/esm/models/ListComponents200Response.js +0 -42
  256. package/dist/esm/models/ListEnterpriseCustomizations200Response.d.ts +0 -40
  257. package/dist/esm/models/ListEnterpriseCustomizations200Response.js +0 -45
  258. package/dist/esm/models/ListEnterpriseCustomizations200ResponsePagination.d.ts +0 -50
  259. package/dist/esm/models/ListEnterpriseCustomizations200ResponsePagination.js +0 -47
  260. package/dist/esm/models/MountRequest.d.ts +0 -45
  261. package/dist/esm/models/MountRequest.js +0 -48
  262. package/dist/esm/models/MountRequestTheme.d.ts +0 -54
  263. package/dist/esm/models/MountRequestTheme.js +0 -54
  264. package/dist/esm/models/MountRequestThemeColors.d.ts +0 -50
  265. package/dist/esm/models/MountRequestThemeColors.js +0 -47
  266. package/dist/esm/models/MountRequestThemeTypography.d.ts +0 -38
  267. package/dist/esm/models/MountRequestThemeTypography.js +0 -43
  268. package/dist/esm/models/MountResponse.d.ts +0 -46
  269. package/dist/esm/models/MountResponse.js +0 -50
  270. package/dist/esm/models/NewWidgetComponentsMetadataInner.d.ts +0 -64
  271. package/dist/esm/models/NewWidgetComponentsMetadataInner.js +0 -53
  272. package/dist/esm/models/NewWidgetComponentsMetadataInnerPosition.d.ts +0 -38
  273. package/dist/esm/models/NewWidgetComponentsMetadataInnerPosition.js +0 -43
  274. package/dist/esm/models/NewWidgetComponentsMetadataInnerSize.d.ts +0 -38
  275. package/dist/esm/models/NewWidgetComponentsMetadataInnerSize.js +0 -43
  276. package/dist/esm/models/PurchaseStoragePack200ResponseDataPaymentIntent.d.ts +0 -50
  277. package/dist/esm/models/PurchaseStoragePack200ResponseDataPaymentIntent.js +0 -47
  278. package/dist/esm/models/RollbackComponentRequest.d.ts +0 -38
  279. package/dist/esm/models/RollbackComponentRequest.js +0 -45
  280. package/dist/esm/models/UIComponent.d.ts +0 -65
  281. package/dist/esm/models/UIComponent.js +0 -57
  282. package/dist/esm/models/UpdateCompositionRequest.d.ts +0 -38
  283. package/dist/esm/models/UpdateCompositionRequest.js +0 -43
  284. package/dist/esm/models/UpdateCurrentSubscriptionRequest.d.ts +0 -38
  285. package/dist/esm/models/UpdateCurrentSubscriptionRequest.js +0 -43
  286. package/dist/esm/models/UpdateEnterpriseCustomizationRequest.d.ts +0 -95
  287. package/dist/esm/models/UpdateEnterpriseCustomizationRequest.js +0 -67
  288. package/dist/esm/models/WorkflowAcceptedResponse.d.ts +0 -38
  289. package/dist/esm/models/WorkflowAcceptedResponse.js +0 -43
  290. package/dist/models/AgentRepositoriesRepoIdSyncPost202Response.d.ts +0 -32
  291. package/dist/models/AgentRepositoriesRepoIdSyncPost202Response.js +0 -48
  292. package/dist/models/AgentRepositoriesRepoIdSyncPostRequest.d.ts +0 -32
  293. package/dist/models/AgentRepositoriesRepoIdSyncPostRequest.js +0 -50
  294. package/dist/models/AgentTasksTaskIdStatusPutRequest.d.ts +0 -54
  295. package/dist/models/AgentTasksTaskIdStatusPutRequest.js +0 -68
  296. package/dist/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.d.ts +0 -32
  297. package/dist/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.js +0 -48
  298. package/dist/models/ApiV1AdminBillingGrantsPostRequest.d.ts +0 -82
  299. package/dist/models/ApiV1AdminBillingGrantsPostRequest.js +0 -87
  300. package/dist/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.d.ts +0 -32
  301. package/dist/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.js +0 -48
  302. package/dist/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.d.ts +0 -32
  303. package/dist/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.js +0 -50
  304. package/dist/models/ApiV1AdminBillingRefundsPostRequest.d.ts +0 -64
  305. package/dist/models/ApiV1AdminBillingRefundsPostRequest.js +0 -68
  306. package/dist/models/ApiV1AdminBillingRefundsPreviewPost200Response.d.ts +0 -71
  307. package/dist/models/ApiV1AdminBillingRefundsPreviewPost200Response.js +0 -67
  308. package/dist/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.d.ts +0 -51
  309. package/dist/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.js +0 -55
  310. package/dist/models/ApiV1AdminBillingRefundsPreviewPostRequest.d.ts +0 -70
  311. package/dist/models/ApiV1AdminBillingRefundsPreviewPostRequest.js +0 -70
  312. package/dist/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.d.ts +0 -46
  313. package/dist/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.js +0 -60
  314. package/dist/models/ApiV1BillingPricingGet200Response.d.ts +0 -39
  315. package/dist/models/ApiV1BillingPricingGet200Response.js +0 -51
  316. package/dist/models/ApiV1BillingPricingGet200ResponseData.d.ts +0 -46
  317. package/dist/models/ApiV1BillingPricingGet200ResponseData.js +0 -54
  318. package/dist/models/ApiV1BillingPricingGet200ResponseDataPlansInner.d.ts +0 -68
  319. package/dist/models/ApiV1BillingPricingGet200ResponseDataPlansInner.js +0 -60
  320. package/dist/models/ApiV1BillingPricingGet200ResponseDataTrial.d.ts +0 -44
  321. package/dist/models/ApiV1BillingPricingGet200ResponseDataTrial.js +0 -52
  322. package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200Response.d.ts +0 -39
  323. package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200Response.js +0 -51
  324. package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.d.ts +0 -33
  325. package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.js +0 -49
  326. package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.d.ts +0 -68
  327. package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.js +0 -60
  328. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.d.ts +0 -39
  329. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.js +0 -51
  330. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.d.ts +0 -32
  331. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.js +0 -48
  332. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +0 -39
  333. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +0 -51
  334. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +0 -32
  335. package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +0 -48
  336. package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.d.ts +0 -39
  337. package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.js +0 -51
  338. package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.d.ts +0 -32
  339. package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.js +0 -48
  340. package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.d.ts +0 -32
  341. package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.js +0 -48
  342. package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.d.ts +0 -39
  343. package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.js +0 -51
  344. package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.d.ts +0 -120
  345. package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.js +0 -84
  346. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.d.ts +0 -39
  347. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.js +0 -51
  348. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.d.ts +0 -38
  349. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.js +0 -50
  350. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.d.ts +0 -39
  351. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.js +0 -51
  352. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.d.ts +0 -38
  353. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.js +0 -50
  354. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.d.ts +0 -53
  355. package/dist/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.js +0 -66
  356. package/dist/models/ApiV1MetricsGet200Response.d.ts +0 -39
  357. package/dist/models/ApiV1MetricsGet200Response.js +0 -51
  358. package/dist/models/ApiV1MetricsGet200ResponseData.d.ts +0 -56
  359. package/dist/models/ApiV1MetricsGet200ResponseData.js +0 -57
  360. package/dist/models/ApiV1MetricsGet200ResponseDataErrorsValue.d.ts +0 -44
  361. package/dist/models/ApiV1MetricsGet200ResponseDataErrorsValue.js +0 -52
  362. package/dist/models/ApiV1MetricsGet200ResponseDataLatencyValue.d.ts +0 -50
  363. package/dist/models/ApiV1MetricsGet200ResponseDataLatencyValue.js +0 -54
  364. package/dist/models/ApiV1MetricsLatencyGet200Response.d.ts +0 -41
  365. package/dist/models/ApiV1MetricsLatencyGet200Response.js +0 -52
  366. package/dist/models/ApiV1MetricsLatencyGet200ResponseDataValue.d.ts +0 -62
  367. package/dist/models/ApiV1MetricsLatencyGet200ResponseDataValue.js +0 -58
  368. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.d.ts +0 -71
  369. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.js +0 -67
  370. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.d.ts +0 -51
  371. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.js +0 -55
  372. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.d.ts +0 -38
  373. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.js +0 -50
  374. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.d.ts +0 -44
  375. package/dist/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.js +0 -52
  376. package/dist/models/CancelCurrentSubscription200Response.d.ts +0 -45
  377. package/dist/models/CancelCurrentSubscription200Response.js +0 -53
  378. package/dist/models/CancelCurrentSubscriptionRequest.d.ts +0 -44
  379. package/dist/models/CancelCurrentSubscriptionRequest.js +0 -52
  380. package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.d.ts +0 -38
  381. package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.js +0 -50
  382. package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.d.ts +0 -38
  383. package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.js +0 -54
  384. package/dist/models/ComponentManifest.d.ts +0 -52
  385. package/dist/models/ComponentManifest.js +0 -56
  386. package/dist/models/ComponentManifestAssets.d.ts +0 -38
  387. package/dist/models/ComponentManifestAssets.js +0 -50
  388. package/dist/models/ComponentManifestConfig.d.ts +0 -44
  389. package/dist/models/ComponentManifestConfig.js +0 -52
  390. package/dist/models/CreateCheckoutSession200Response.d.ts +0 -38
  391. package/dist/models/CreateCheckoutSession200Response.js +0 -50
  392. package/dist/models/CreateCheckoutSessionRequest.d.ts +0 -32
  393. package/dist/models/CreateCheckoutSessionRequest.js +0 -50
  394. package/dist/models/CreateComposition201Response.d.ts +0 -39
  395. package/dist/models/CreateComposition201Response.js +0 -51
  396. package/dist/models/DevelopmentPlan.d.ts +0 -97
  397. package/dist/models/DevelopmentPlan.js +0 -77
  398. package/dist/models/DevelopmentTask.d.ts +0 -90
  399. package/dist/models/DevelopmentTask.js +0 -74
  400. package/dist/models/EnterpriseCustomization.d.ts +0 -125
  401. package/dist/models/EnterpriseCustomization.js +0 -85
  402. package/dist/models/GenerateComponentWorkflowInput.d.ts +0 -56
  403. package/dist/models/GenerateComponentWorkflowInput.js +0 -62
  404. package/dist/models/GenerateMixedComponentInput.d.ts +0 -62
  405. package/dist/models/GenerateMixedComponentInput.js +0 -66
  406. package/dist/models/GetOrganizationStorageUsage200ResponseDataBreakdown.d.ts +0 -44
  407. package/dist/models/GetOrganizationStorageUsage200ResponseDataBreakdown.js +0 -52
  408. package/dist/models/ListComponents200Response.d.ts +0 -33
  409. package/dist/models/ListComponents200Response.js +0 -49
  410. package/dist/models/ListEnterpriseCustomizations200Response.d.ts +0 -40
  411. package/dist/models/ListEnterpriseCustomizations200Response.js +0 -52
  412. package/dist/models/ListEnterpriseCustomizations200ResponsePagination.d.ts +0 -50
  413. package/dist/models/ListEnterpriseCustomizations200ResponsePagination.js +0 -54
  414. package/dist/models/MountRequest.d.ts +0 -45
  415. package/dist/models/MountRequest.js +0 -55
  416. package/dist/models/MountRequestTheme.d.ts +0 -54
  417. package/dist/models/MountRequestTheme.js +0 -62
  418. package/dist/models/MountRequestThemeColors.d.ts +0 -50
  419. package/dist/models/MountRequestThemeColors.js +0 -54
  420. package/dist/models/MountRequestThemeTypography.d.ts +0 -38
  421. package/dist/models/MountRequestThemeTypography.js +0 -50
  422. package/dist/models/MountResponse.d.ts +0 -46
  423. package/dist/models/MountResponse.js +0 -58
  424. package/dist/models/NewWidgetComponentsMetadataInner.d.ts +0 -64
  425. package/dist/models/NewWidgetComponentsMetadataInner.js +0 -60
  426. package/dist/models/NewWidgetComponentsMetadataInnerPosition.d.ts +0 -38
  427. package/dist/models/NewWidgetComponentsMetadataInnerPosition.js +0 -50
  428. package/dist/models/NewWidgetComponentsMetadataInnerSize.d.ts +0 -38
  429. package/dist/models/NewWidgetComponentsMetadataInnerSize.js +0 -50
  430. package/dist/models/PurchaseStoragePack200ResponseDataPaymentIntent.d.ts +0 -50
  431. package/dist/models/PurchaseStoragePack200ResponseDataPaymentIntent.js +0 -54
  432. package/dist/models/RollbackComponentRequest.d.ts +0 -38
  433. package/dist/models/RollbackComponentRequest.js +0 -52
  434. package/dist/models/UIComponent.d.ts +0 -65
  435. package/dist/models/UIComponent.js +0 -65
  436. package/dist/models/UpdateCompositionRequest.d.ts +0 -38
  437. package/dist/models/UpdateCompositionRequest.js +0 -50
  438. package/dist/models/UpdateCurrentSubscriptionRequest.d.ts +0 -38
  439. package/dist/models/UpdateCurrentSubscriptionRequest.js +0 -50
  440. package/dist/models/UpdateEnterpriseCustomizationRequest.d.ts +0 -95
  441. package/dist/models/UpdateEnterpriseCustomizationRequest.js +0 -75
  442. package/dist/models/WorkflowAcceptedResponse.d.ts +0 -38
  443. package/dist/models/WorkflowAcceptedResponse.js +0 -50
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CheckCompositionAccess200Response, Composition, CompositionEntriesDescription, CompositionEntriesReading, CreateCompositionContentItemRequest, CreateCompositionFromWidget201Response, DeleteCompositionContentItem200Response, DuplicateComposition202Response, DuplicateCompositionRequest, GetAllCompositions200Response, GetCompositionContentSchema200Response, GetCompositionDesignSchema200Response, GetCompositionEmbedSchema200Response, GetCompositionPreview200Response, GetCompositionVersions200Response, GetCompositionsBatch200Response, GetCompositionsBatchRequest, NewComposition, SetCompositionDataSourceRequest, SetDynamicContent200Response, SetDynamicContentRequest, UpdateComposition, UpdateCompositionStatusRequest, ValidateCompositionContent200Response } from '../models/index';
13
+ import type { CheckCompositionAccess200Response, Composition, CompositionDataSource, CompositionEntriesDescription, CompositionEntriesReading, CreateCompositionContentItemRequest, CreateCompositionFromWidget201Response, DeleteCompositionContentItem200Response, DeleteCompositionDataSource200Response, DuplicateComposition202Response, DuplicateCompositionRequest, GetAllCompositions200Response, GetCompositionContentSchema200Response, GetCompositionDesignSchema200Response, GetCompositionEmbedSchema200Response, GetCompositionPreview200Response, GetCompositionVersions200Response, GetCompositionsBatch200Response, GetCompositionsBatchRequest, NewComposition, SetCompositionDataSourceRequest, SetDynamicContent200Response, SetDynamicContentRequest, UpdateComposition, UpdateCompositionStatusRequest, ValidateCompositionContent200Response } from '../models/index';
14
14
  export interface CheckCompositionAccessRequest {
15
15
  id: string;
16
16
  }
@@ -224,13 +224,15 @@ export declare class CompositionsApi extends runtime.BaseAPI {
224
224
  */
225
225
  deleteCompositionContentItem(requestParameters: DeleteCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCompositionContentItem200Response>;
226
226
  /**
227
+ * Removes the binding. Asking again, or asking for a composition that had none, is not an error: the composition has no data source afterwards, and that is all `removed: true` says.
227
228
  * Remove the composition data source binding
228
229
  */
229
- deleteCompositionDataSourceRaw(requestParameters: DeleteCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
230
+ deleteCompositionDataSourceRaw(requestParameters: DeleteCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCompositionDataSource200Response>>;
230
231
  /**
232
+ * Removes the binding. Asking again, or asking for a composition that had none, is not an error: the composition has no data source afterwards, and that is all `removed: true` says.
231
233
  * Remove the composition data source binding
232
234
  */
233
- deleteCompositionDataSource(requestParameters: DeleteCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
235
+ deleteCompositionDataSource(requestParameters: DeleteCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCompositionDataSource200Response>;
234
236
  /**
235
237
  * Deletes a specific record from a table in the composition\'s database.
236
238
  * Delete Record From Composition Database
@@ -282,12 +284,12 @@ export declare class CompositionsApi extends runtime.BaseAPI {
282
284
  */
283
285
  getAllCompositions(requestParameters?: GetAllCompositions0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllCompositions200Response>;
284
286
  /**
285
- * Retrieves a specific composition by its ID.
287
+ * Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route accepts them only from a website on the composition\'s allowed list, and refuses them while that list is empty (the public JSON of the composition stays open to every website). A widget in a frame writes from Widgetic\'s own frame and is accepted whatever the list says.
286
288
  * Get Composition
287
289
  */
288
290
  getCompositionByIdRaw(requestParameters: GetCompositionById0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
289
291
  /**
290
- * Retrieves a specific composition by its ID.
292
+ * Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route accepts them only from a website on the composition\'s allowed list, and refuses them while that list is empty (the public JSON of the composition stays open to every website). A widget in a frame writes from Widgetic\'s own frame and is accepted whatever the list says.
291
293
  * Get Composition
292
294
  */
293
295
  getCompositionById(requestParameters: GetCompositionById0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
@@ -312,13 +314,15 @@ export declare class CompositionsApi extends runtime.BaseAPI {
312
314
  */
313
315
  getCompositionContent(requestParameters: GetCompositionContent0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
314
316
  /**
317
+ * The data source that is bound to the composition: `url` and `refreshSeconds`. The answer\'s `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
315
318
  * Read the composition data source binding
316
319
  */
317
- getCompositionDataSourceRaw(requestParameters: GetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
320
+ getCompositionDataSourceRaw(requestParameters: GetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionDataSource>>;
318
321
  /**
322
+ * The data source that is bound to the composition: `url` and `refreshSeconds`. The answer\'s `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
319
323
  * Read the composition data source binding
320
324
  */
321
- getCompositionDataSource(requestParameters: GetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
325
+ getCompositionDataSource(requestParameters: GetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionDataSource>;
322
326
  /**
323
327
  * Retrieves a specific record from a table in the composition\'s database.
324
328
  * Get Record From Composition Database
@@ -418,25 +422,25 @@ export declare class CompositionsApi extends runtime.BaseAPI {
418
422
  */
419
423
  patchCompositionContentItem(requestParameters: PatchCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
420
424
  /**
421
- * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
425
+ * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. - **`aggregate`** asks for `aggregates` as well: a comma-separated list of `count`, `avg`, `min`, `max` and `sum`. `avg`, `min`, `max` and `sum` need `column`, a numeric column of the table. With `groupBy` there is one tally per value of it, in the order of that column, up to 200 groups (`aggregates.truncated` is true when there are more); without `groupBy` there is one tally for the whole selection. **`aggregates` counts a selection; the rest of the answer does not.** `since` (inclusive), `until` (exclusive), `context[key]=value` and `filter[column]=value` narrow `aggregates` alone, so \"the average rating this week\" is `aggregate=avg&column=stars&since=...`. `totalRows`, `tallies` and `rows` always describe the whole table. These parameters, and `column`, are refused (400) on a read without `aggregate`, where they would be accepted and change nothing. This read is bounded on purpose: it never returns more than 25 entries, 20 groups (200 in `aggregates`), 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`; to page through entries with their time, context and filters, use `listCompositionEntryItems`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
422
426
  * Read the Entries of a Composition\'s Table
423
427
  */
424
428
  readCompositionEntriesRaw(requestParameters: ReadCompositionEntries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesReading>>;
425
429
  /**
426
- * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
430
+ * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. - **`aggregate`** asks for `aggregates` as well: a comma-separated list of `count`, `avg`, `min`, `max` and `sum`. `avg`, `min`, `max` and `sum` need `column`, a numeric column of the table. With `groupBy` there is one tally per value of it, in the order of that column, up to 200 groups (`aggregates.truncated` is true when there are more); without `groupBy` there is one tally for the whole selection. **`aggregates` counts a selection; the rest of the answer does not.** `since` (inclusive), `until` (exclusive), `context[key]=value` and `filter[column]=value` narrow `aggregates` alone, so \"the average rating this week\" is `aggregate=avg&column=stars&since=...`. `totalRows`, `tallies` and `rows` always describe the whole table. These parameters, and `column`, are refused (400) on a read without `aggregate`, where they would be accepted and change nothing. This read is bounded on purpose: it never returns more than 25 entries, 20 groups (200 in `aggregates`), 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`; to page through entries with their time, context and filters, use `listCompositionEntryItems`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
427
431
  * Read the Entries of a Composition\'s Table
428
432
  */
429
433
  readCompositionEntries(requestParameters: ReadCompositionEntries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesReading>;
430
434
  /**
431
- * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses).
435
+ * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses). A composition has one binding: saving another replaces it. The answer is the binding as it was saved (`url`, `refreshSeconds`).
432
436
  * Bind a public JSON data source for embed refresh
433
437
  */
434
- setCompositionDataSourceRaw(requestParameters: SetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
438
+ setCompositionDataSourceRaw(requestParameters: SetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionDataSource>>;
435
439
  /**
436
- * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses).
440
+ * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses). A composition has one binding: saving another replaces it. The answer is the binding as it was saved (`url`, `refreshSeconds`).
437
441
  * Bind a public JSON data source for embed refresh
438
442
  */
439
- setCompositionDataSource(requestParameters: SetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
443
+ setCompositionDataSource(requestParameters: SetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionDataSource>;
440
444
  /**
441
445
  * Updates the content of a composition dynamically with optional schema validation. An editor session (see `createManagedUserEditorSession`) can send only `content`, `validate` and `partial`, and only for a composition made for its managed user. A body that names `version`, `source` or any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
442
446
  * Set Dynamic Content
@@ -253,6 +253,7 @@ class CompositionsApi extends runtime.BaseAPI {
253
253
  });
254
254
  }
255
255
  /**
256
+ * Removes the binding. Asking again, or asking for a composition that had none, is not an error: the composition has no data source afterwards, and that is all `removed: true` says.
256
257
  * Remove the composition data source binding
257
258
  */
258
259
  deleteCompositionDataSourceRaw(requestParameters, initOverrides) {
@@ -278,15 +279,17 @@ class CompositionsApi extends runtime.BaseAPI {
278
279
  headers: headerParameters,
279
280
  query: queryParameters,
280
281
  }, initOverrides);
281
- return new runtime.VoidApiResponse(response);
282
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.DeleteCompositionDataSource200ResponseFromJSON)(jsonValue));
282
283
  });
283
284
  }
284
285
  /**
286
+ * Removes the binding. Asking again, or asking for a composition that had none, is not an error: the composition has no data source afterwards, and that is all `removed: true` says.
285
287
  * Remove the composition data source binding
286
288
  */
287
289
  deleteCompositionDataSource(requestParameters, initOverrides) {
288
290
  return __awaiter(this, void 0, void 0, function* () {
289
- yield this.deleteCompositionDataSourceRaw(requestParameters, initOverrides);
291
+ const response = yield this.deleteCompositionDataSourceRaw(requestParameters, initOverrides);
292
+ return yield response.value();
290
293
  });
291
294
  }
292
295
  /**
@@ -511,7 +514,7 @@ class CompositionsApi extends runtime.BaseAPI {
511
514
  });
512
515
  }
513
516
  /**
514
- * Retrieves a specific composition by its ID.
517
+ * Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route accepts them only from a website on the composition\'s allowed list, and refuses them while that list is empty (the public JSON of the composition stays open to every website). A widget in a frame writes from Widgetic\'s own frame and is accepted whatever the list says.
515
518
  * Get Composition
516
519
  */
517
520
  getCompositionByIdRaw(requestParameters, initOverrides) {
@@ -538,7 +541,7 @@ class CompositionsApi extends runtime.BaseAPI {
538
541
  });
539
542
  }
540
543
  /**
541
- * Retrieves a specific composition by its ID.
544
+ * Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route accepts them only from a website on the composition\'s allowed list, and refuses them while that list is empty (the public JSON of the composition stays open to every website). A widget in a frame writes from Widgetic\'s own frame and is accepted whatever the list says.
542
545
  * Get Composition
543
546
  */
544
547
  getCompositionById(requestParameters, initOverrides) {
@@ -622,6 +625,7 @@ class CompositionsApi extends runtime.BaseAPI {
622
625
  });
623
626
  }
624
627
  /**
628
+ * The data source that is bound to the composition: `url` and `refreshSeconds`. The answer\'s `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
625
629
  * Read the composition data source binding
626
630
  */
627
631
  getCompositionDataSourceRaw(requestParameters, initOverrides) {
@@ -644,15 +648,17 @@ class CompositionsApi extends runtime.BaseAPI {
644
648
  headers: headerParameters,
645
649
  query: queryParameters,
646
650
  }, initOverrides);
647
- return new runtime.VoidApiResponse(response);
651
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CompositionDataSourceFromJSON)(jsonValue));
648
652
  });
649
653
  }
650
654
  /**
655
+ * The data source that is bound to the composition: `url` and `refreshSeconds`. The answer\'s `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
651
656
  * Read the composition data source binding
652
657
  */
653
658
  getCompositionDataSource(requestParameters, initOverrides) {
654
659
  return __awaiter(this, void 0, void 0, function* () {
655
- yield this.getCompositionDataSourceRaw(requestParameters, initOverrides);
660
+ const response = yield this.getCompositionDataSourceRaw(requestParameters, initOverrides);
661
+ return yield response.value();
656
662
  });
657
663
  }
658
664
  /**
@@ -1049,7 +1055,7 @@ class CompositionsApi extends runtime.BaseAPI {
1049
1055
  });
1050
1056
  }
1051
1057
  /**
1052
- * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
1058
+ * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. - **`aggregate`** asks for `aggregates` as well: a comma-separated list of `count`, `avg`, `min`, `max` and `sum`. `avg`, `min`, `max` and `sum` need `column`, a numeric column of the table. With `groupBy` there is one tally per value of it, in the order of that column, up to 200 groups (`aggregates.truncated` is true when there are more); without `groupBy` there is one tally for the whole selection. **`aggregates` counts a selection; the rest of the answer does not.** `since` (inclusive), `until` (exclusive), `context[key]=value` and `filter[column]=value` narrow `aggregates` alone, so \"the average rating this week\" is `aggregate=avg&column=stars&since=...`. `totalRows`, `tallies` and `rows` always describe the whole table. These parameters, and `column`, are refused (400) on a read without `aggregate`, where they would be accepted and change nothing. This read is bounded on purpose: it never returns more than 25 entries, 20 groups (200 in `aggregates`), 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`; to page through entries with their time, context and filters, use `listCompositionEntryItems`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
1053
1059
  * Read the Entries of a Composition\'s Table
1054
1060
  */
1055
1061
  readCompositionEntriesRaw(requestParameters, initOverrides) {
@@ -1103,7 +1109,7 @@ class CompositionsApi extends runtime.BaseAPI {
1103
1109
  });
1104
1110
  }
1105
1111
  /**
1106
- * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
1112
+ * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. - **`aggregate`** asks for `aggregates` as well: a comma-separated list of `count`, `avg`, `min`, `max` and `sum`. `avg`, `min`, `max` and `sum` need `column`, a numeric column of the table. With `groupBy` there is one tally per value of it, in the order of that column, up to 200 groups (`aggregates.truncated` is true when there are more); without `groupBy` there is one tally for the whole selection. **`aggregates` counts a selection; the rest of the answer does not.** `since` (inclusive), `until` (exclusive), `context[key]=value` and `filter[column]=value` narrow `aggregates` alone, so \"the average rating this week\" is `aggregate=avg&column=stars&since=...`. `totalRows`, `tallies` and `rows` always describe the whole table. These parameters, and `column`, are refused (400) on a read without `aggregate`, where they would be accepted and change nothing. This read is bounded on purpose: it never returns more than 25 entries, 20 groups (200 in `aggregates`), 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`; to page through entries with their time, context and filters, use `listCompositionEntryItems`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
1107
1113
  * Read the Entries of a Composition\'s Table
1108
1114
  */
1109
1115
  readCompositionEntries(requestParameters, initOverrides) {
@@ -1113,7 +1119,7 @@ class CompositionsApi extends runtime.BaseAPI {
1113
1119
  });
1114
1120
  }
1115
1121
  /**
1116
- * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses).
1122
+ * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses). A composition has one binding: saving another replaces it. The answer is the binding as it was saved (`url`, `refreshSeconds`).
1117
1123
  * Bind a public JSON data source for embed refresh
1118
1124
  */
1119
1125
  setCompositionDataSourceRaw(requestParameters, initOverrides) {
@@ -1144,16 +1150,17 @@ class CompositionsApi extends runtime.BaseAPI {
1144
1150
  query: queryParameters,
1145
1151
  body: (0, index_1.SetCompositionDataSourceRequestToJSON)(requestParameters['setCompositionDataSourceRequest']),
1146
1152
  }, initOverrides);
1147
- return new runtime.VoidApiResponse(response);
1153
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CompositionDataSourceFromJSON)(jsonValue));
1148
1154
  });
1149
1155
  }
1150
1156
  /**
1151
- * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses).
1157
+ * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses). A composition has one binding: saving another replaces it. The answer is the binding as it was saved (`url`, `refreshSeconds`).
1152
1158
  * Bind a public JSON data source for embed refresh
1153
1159
  */
1154
1160
  setCompositionDataSource(requestParameters, initOverrides) {
1155
1161
  return __awaiter(this, void 0, void 0, function* () {
1156
- yield this.setCompositionDataSourceRaw(requestParameters, initOverrides);
1162
+ const response = yield this.setCompositionDataSourceRaw(requestParameters, initOverrides);
1163
+ return yield response.value();
1157
1164
  });
1158
1165
  }
1159
1166
  /**
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { AccountCreditBalance, AddDomainRequest, CompositionEntriesDescription, CompositionEntriesReading, CompositionEntryDeleteSuccess, CompositionEntryItemsPageSuccess, CopyPartnerPresetRequest, CreateCompositionContentItemRequest, CreateCompositionFromPresetRequest, CreateCompositionFromWidget201Response, CreateCompositionFromWidgetRequest, CreateUserApiKeyRequest, CreateWidget201Response, CreatedUserApiKey, DeleteCompositionContentItem200Response, DeletePersonalWorkspaceDomain200Response, DeleteUserApiKey200Response, DuplicateComposition202Response, DuplicateCompositionRequest, GetAllCompositions200Response, GetAllManagedUsers200Response, GetCompositionContentSchema200Response, GetCompositionDesignSchema200Response, GetCompositionEmbedSchema200Response, GetInvoicesByPartnerId200Response, GetManagedUserLimits200Response, GetManagedUserStorageUsage200Response, GetManagedUsersByManagerId200Response, GetPartnerDesignDefaults200Response, GetPersonalWorkspaceDomains200Response, GetUserApiKeyUsageLogs200Response, GetUserApiKeys200Response, GetUserCreditTransactions200Response, GetWidgets200Response, ListPartnerPresets200Response, ManagedUser, ManagedUserEntriesPageSuccess, NewComposition, NewManagedUser, NewWidget, OperationsIdGet200Response, PartnerContract, PartnerNotificationDelivery, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerPreset, PartnerPresetCopy, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PersonalWorkspaceDomainResult, SetCompositionDataSourceRequest, SetDynamicContent200Response, SetDynamicContentRequest, SetManagedUserLimitsRequest, SetPartnerDesignDefaultsRequest, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdateComposition, UpdateDomainRequest, UpdateManagedUser, UpdatePartnerNotificationSettingsRequest, UpdateUserApiKeyRequest, Upload, UploadLimits, UploadsGet200Response, UploadsIdDelete200Response, UserApiKey, ValidateToken200Response } from '../models/index';
13
+ import type { AccountCreditBalance, AddDomainRequest, CompositionDataSource, CompositionEntriesDescription, CompositionEntriesReading, CompositionEntryDeleteSuccess, CompositionEntryItemsPageSuccess, CopyPartnerPresetRequest, CreateCompositionContentItemRequest, CreateCompositionFromPresetRequest, CreateCompositionFromWidget201Response, CreateCompositionFromWidgetRequest, CreateUserApiKeyRequest, CreateWidget201Response, CreatedUserApiKey, DeleteCompositionContentItem200Response, DeleteCompositionDataSource200Response, DeletePersonalWorkspaceDomain200Response, DeleteUserApiKey200Response, DuplicateComposition202Response, DuplicateCompositionRequest, GetAllCompositions200Response, GetAllManagedUsers200Response, GetCompositionContentSchema200Response, GetCompositionDesignSchema200Response, GetCompositionEmbedSchema200Response, GetInvoicesByPartnerId200Response, GetManagedUserLimits200Response, GetManagedUserStorageUsage200Response, GetManagedUsersByManagerId200Response, GetPartnerDesignDefaults200Response, GetPersonalWorkspaceDomains200Response, GetUserApiKeyUsageLogs200Response, GetUserApiKeys200Response, GetUserCreditTransactions200Response, GetWidgets200Response, ListPartnerPresets200Response, ManagedUser, ManagedUserEntriesPageSuccess, NewComposition, NewManagedUser, NewWidget, OperationsIdGet200Response, PartnerContract, PartnerEntryContextSecret, PartnerEntryContextSigning, PartnerNotificationDelivery, PartnerNotificationDeliveryLog, PartnerNotificationPage, PartnerNotificationSettings, PartnerNotificationSettingsChange, PartnerNotificationTestEventRequest, PartnerNotificationTestEventResult, PartnerPreset, PartnerPresetCopy, PartnerPresetRemoval, PartnerStorageDestination, PartnerStorageRemoval, PersonalWorkspaceDomainResult, SetCompositionDataSourceRequest, SetDynamicContent200Response, SetDynamicContentRequest, SetManagedUserLimitsRequest, SetPartnerDesignDefaultsRequest, SetPartnerPresetRequest, SetPartnerStorageDestinationRequest, UpdateComposition, UpdateDomainRequest, UpdateManagedUser, UpdatePartnerEntryContextSigningRequest, UpdatePartnerNotificationSettingsRequest, UpdateUserApiKeyRequest, Upload, UploadLimits, UploadsGet200Response, UploadsIdDelete200Response, UserApiKey, ValidateToken200Response } from '../models/index';
14
14
  export interface AddPersonalWorkspaceDomainRequest {
15
15
  id: string;
16
16
  addDomainRequest: AddDomainRequest;
@@ -188,6 +188,9 @@ export interface GetPartnerContractRequest {
188
188
  export interface GetPartnerDesignDefaultsRequest {
189
189
  partnerId: string;
190
190
  }
191
+ export interface GetPartnerEntryContextSigningRequest {
192
+ partnerId: string;
193
+ }
191
194
  export interface GetPartnerNotificationSettingsRequest {
192
195
  partnerId: string;
193
196
  }
@@ -305,10 +308,19 @@ export interface ReplayPartnerNotificationDeliveryRequest {
305
308
  deliveryId: string;
306
309
  idempotencyKey?: string;
307
310
  }
311
+ export interface RotatePartnerEntryContextSecretRequest {
312
+ partnerId: string;
313
+ idempotencyKey?: string;
314
+ }
308
315
  export interface RotatePartnerWebhookSecretRequest {
309
316
  partnerId: string;
310
317
  idempotencyKey?: string;
311
318
  }
319
+ export interface SendPartnerNotificationTestEventRequest {
320
+ partnerId: string;
321
+ partnerNotificationTestEventRequest: PartnerNotificationTestEventRequest;
322
+ idempotencyKey?: string;
323
+ }
312
324
  export interface SetCompositionDataSourceOperationRequest {
313
325
  id: string;
314
326
  setCompositionDataSourceRequest: SetCompositionDataSourceRequest;
@@ -341,7 +353,7 @@ export interface SetPartnerStorageDestinationOperationRequest {
341
353
  partnerId: string;
342
354
  setPartnerStorageDestinationRequest: SetPartnerStorageDestinationRequest;
343
355
  }
344
- export interface UpdateCompositionOperationRequest {
356
+ export interface UpdateCompositionRequest {
345
357
  id: string;
346
358
  updateComposition: UpdateComposition;
347
359
  idempotencyKey?: string;
@@ -351,6 +363,11 @@ export interface UpdateManagedUserRequest {
351
363
  updateManagedUser: UpdateManagedUser;
352
364
  idempotencyKey?: string;
353
365
  }
366
+ export interface UpdatePartnerEntryContextSigningOperationRequest {
367
+ partnerId: string;
368
+ updatePartnerEntryContextSigningRequest: UpdatePartnerEntryContextSigningRequest;
369
+ idempotencyKey?: string;
370
+ }
354
371
  export interface UpdatePartnerNotificationSettingsOperationRequest {
355
372
  partnerId: string;
356
373
  updatePartnerNotificationSettingsRequest: UpdatePartnerNotificationSettingsRequest;
@@ -500,13 +517,15 @@ export declare class PartnerApi extends runtime.BaseAPI {
500
517
  */
501
518
  deleteCompositionContentItem(requestParameters: DeleteCompositionContentItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCompositionContentItem200Response>;
502
519
  /**
520
+ * Removes the binding. Asking again, or asking for a composition that had none, is not an error: the composition has no data source afterwards, and that is all `removed: true` says.
503
521
  * Remove the composition data source binding
504
522
  */
505
- deleteCompositionDataSourceRaw(requestParameters: DeleteCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
523
+ deleteCompositionDataSourceRaw(requestParameters: DeleteCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCompositionDataSource200Response>>;
506
524
  /**
525
+ * Removes the binding. Asking again, or asking for a composition that had none, is not an error: the composition has no data source afterwards, and that is all `removed: true` says.
507
526
  * Remove the composition data source binding
508
527
  */
509
- deleteCompositionDataSource(requestParameters: DeleteCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
528
+ deleteCompositionDataSource(requestParameters: DeleteCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCompositionDataSource200Response>;
510
529
  /**
511
530
  * Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
512
531
  * Delete composition entry items by id or host context
@@ -598,12 +617,12 @@ export declare class PartnerApi extends runtime.BaseAPI {
598
617
  */
599
618
  getAllManagedUsers(requestParameters?: GetAllManagedUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllManagedUsers200Response>;
600
619
  /**
601
- * Retrieves a specific composition by its ID.
620
+ * Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route accepts them only from a website on the composition\'s allowed list, and refuses them while that list is empty (the public JSON of the composition stays open to every website). A widget in a frame writes from Widgetic\'s own frame and is accepted whatever the list says.
602
621
  * Get Composition
603
622
  */
604
623
  getCompositionByIdRaw(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
605
624
  /**
606
- * Retrieves a specific composition by its ID.
625
+ * Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route accepts them only from a website on the composition\'s allowed list, and refuses them while that list is empty (the public JSON of the composition stays open to every website). A widget in a frame writes from Widgetic\'s own frame and is accepted whatever the list says.
607
626
  * Get Composition
608
627
  */
609
628
  getCompositionById(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
@@ -628,13 +647,15 @@ export declare class PartnerApi extends runtime.BaseAPI {
628
647
  */
629
648
  getCompositionContentSchema(requestParameters: GetCompositionContentSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionContentSchema200Response>;
630
649
  /**
650
+ * The data source that is bound to the composition: `url` and `refreshSeconds`. The answer\'s `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
631
651
  * Read the composition data source binding
632
652
  */
633
- getCompositionDataSourceRaw(requestParameters: GetCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
653
+ getCompositionDataSourceRaw(requestParameters: GetCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionDataSource>>;
634
654
  /**
655
+ * The data source that is bound to the composition: `url` and `refreshSeconds`. The answer\'s `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
635
656
  * Read the composition data source binding
636
657
  */
637
- getCompositionDataSource(requestParameters: GetCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
658
+ getCompositionDataSource(requestParameters: GetCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionDataSource>;
638
659
  /**
639
660
  * Retrieves only the design field from a composition.
640
661
  * Get Composition Design
@@ -757,6 +778,16 @@ export declare class PartnerApi extends runtime.BaseAPI {
757
778
  * Read partner-wide design defaults
758
779
  */
759
780
  getPartnerDesignDefaults(requestParameters: GetPartnerDesignDefaultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPartnerDesignDefaults200Response>;
781
+ /**
782
+ * 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.
783
+ * See how the context of your embeds is signed
784
+ */
785
+ getPartnerEntryContextSigningRaw(requestParameters: GetPartnerEntryContextSigningRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerEntryContextSigning>>;
786
+ /**
787
+ * 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.
788
+ * See how the context of your embeds is signed
789
+ */
790
+ getPartnerEntryContextSigning(requestParameters: GetPartnerEntryContextSigningRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEntryContextSigning>;
760
791
  /**
761
792
  * 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.
762
793
  * Where your notifications go
@@ -906,12 +937,12 @@ export declare class PartnerApi extends runtime.BaseAPI {
906
937
  */
907
938
  patchCompositionContentItem(requestParameters: PatchCompositionContentItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
908
939
  /**
909
- * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
940
+ * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. - **`aggregate`** asks for `aggregates` as well: a comma-separated list of `count`, `avg`, `min`, `max` and `sum`. `avg`, `min`, `max` and `sum` need `column`, a numeric column of the table. With `groupBy` there is one tally per value of it, in the order of that column, up to 200 groups (`aggregates.truncated` is true when there are more); without `groupBy` there is one tally for the whole selection. **`aggregates` counts a selection; the rest of the answer does not.** `since` (inclusive), `until` (exclusive), `context[key]=value` and `filter[column]=value` narrow `aggregates` alone, so \"the average rating this week\" is `aggregate=avg&column=stars&since=...`. `totalRows`, `tallies` and `rows` always describe the whole table. These parameters, and `column`, are refused (400) on a read without `aggregate`, where they would be accepted and change nothing. This read is bounded on purpose: it never returns more than 25 entries, 20 groups (200 in `aggregates`), 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`; to page through entries with their time, context and filters, use `listCompositionEntryItems`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
910
941
  * Read the Entries of a Composition\'s Table
911
942
  */
912
943
  readCompositionEntriesRaw(requestParameters: ReadCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesReading>>;
913
944
  /**
914
- * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. This read is bounded on purpose: it never returns more than 25 entries, 20 groups, 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
945
+ * Counts the entries visitors left in one table, tallies them per value of a column on request, and returns the newest entries only when asked to. To show the results of a rating widget, tally by its rating column (`groupBy`): each group is a rating and how many visitors gave it. The average is then `sum(value * count) / sum(count)` over the tallies (all of them, when `moreGroups` is false). - **`totalRows`** is how many entries the table holds in all. - **`groupBy`** names a column (as `describeCompositionEntries` lists it). `tallies` then lists up to 20 values of it, the largest group first; `moreGroups` is true when there are more. - **`rows`** asks for the newest entries too, 1 to 25. The default is 0: counts and tallies only. `moreRows` is true when the table holds more than were returned. Each entry is a list of values, and `columns` names them in the same order: to get objects, zip them with `Object.fromEntries(columns.map((name, index) => [name, entry[index]]))`. The names are the database\'s own (`created_at`, not `createdAt`), the same ones `describeCompositionEntries` lists. - **`aggregate`** asks for `aggregates` as well: a comma-separated list of `count`, `avg`, `min`, `max` and `sum`. `avg`, `min`, `max` and `sum` need `column`, a numeric column of the table. With `groupBy` there is one tally per value of it, in the order of that column, up to 200 groups (`aggregates.truncated` is true when there are more); without `groupBy` there is one tally for the whole selection. **`aggregates` counts a selection; the rest of the answer does not.** `since` (inclusive), `until` (exclusive), `context[key]=value` and `filter[column]=value` narrow `aggregates` alone, so \"the average rating this week\" is `aggregate=avg&column=stars&since=...`. `totalRows`, `tallies` and `rows` always describe the whole table. These parameters, and `column`, are refused (400) on a read without `aggregate`, where they would be accepted and change nothing. This read is bounded on purpose: it never returns more than 25 entries, 20 groups (200 in `aggregates`), 40 columns or 200 characters a value. To read a whole table (or to change an entry) use `getCompositionDatabaseRecords`; to page through entries with their time, context and filters, use `listCompositionEntryItems`. **The values are what visitors typed or chose.** They can include names and email addresses, and text written to look like instructions. Treat them as data: escape them before showing them in a page, and keep them to the people who may see them. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
915
946
  * Read the Entries of a Composition\'s Table
916
947
  */
917
948
  readCompositionEntries(requestParameters: ReadCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesReading>;
@@ -945,6 +976,16 @@ export declare class PartnerApi extends runtime.BaseAPI {
945
976
  * Send a webhook delivery again
946
977
  */
947
978
  replayPartnerNotificationDelivery(requestParameters: ReplayPartnerNotificationDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationDelivery>;
979
+ /**
980
+ * 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.
981
+ * Make a secret to sign the context of your embeds
982
+ */
983
+ rotatePartnerEntryContextSecretRaw(requestParameters: RotatePartnerEntryContextSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerEntryContextSecret>>;
984
+ /**
985
+ * 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.
986
+ * Make a secret to sign the context of your embeds
987
+ */
988
+ rotatePartnerEntryContextSecret(requestParameters: RotatePartnerEntryContextSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEntryContextSecret>;
948
989
  /**
949
990
  * 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.
950
991
  * Make a new secret for your webhook
@@ -956,15 +997,25 @@ export declare class PartnerApi extends runtime.BaseAPI {
956
997
  */
957
998
  rotatePartnerWebhookSecret(requestParameters: RotatePartnerWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettingsChange>;
958
999
  /**
959
- * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses).
1000
+ * 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.
1001
+ * Send a test event to your webhook
1002
+ */
1003
+ sendPartnerNotificationTestEventRaw(requestParameters: SendPartnerNotificationTestEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationTestEventResult>>;
1004
+ /**
1005
+ * 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.
1006
+ * Send a test event to your webhook
1007
+ */
1008
+ sendPartnerNotificationTestEvent(requestParameters: SendPartnerNotificationTestEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationTestEventResult>;
1009
+ /**
1010
+ * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses). A composition has one binding: saving another replaces it. The answer is the binding as it was saved (`url`, `refreshSeconds`).
960
1011
  * Bind a public JSON data source for embed refresh
961
1012
  */
962
- setCompositionDataSourceRaw(requestParameters: SetCompositionDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
1013
+ setCompositionDataSourceRaw(requestParameters: SetCompositionDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionDataSource>>;
963
1014
  /**
964
- * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses).
1015
+ * Stores an https URL the widget runtime may read on load and every `refresh_seconds`. The URL must name a public host (no loopback, link-local or metadata addresses). A composition has one binding: saving another replaces it. The answer is the binding as it was saved (`url`, `refreshSeconds`).
965
1016
  * Bind a public JSON data source for embed refresh
966
1017
  */
967
- setCompositionDataSource(requestParameters: SetCompositionDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1018
+ setCompositionDataSource(requestParameters: SetCompositionDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionDataSource>;
968
1019
  /**
969
1020
  * Updates the content of a composition dynamically with optional schema validation. An editor session (see `createManagedUserEditorSession`) can send only `content`, `validate` and `partial`, and only for a composition made for its managed user. A body that names `version`, `source` or any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
970
1021
  * Set Dynamic Content
@@ -1029,12 +1080,12 @@ export declare class PartnerApi extends runtime.BaseAPI {
1029
1080
  * Updates a specific composition. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry. An editor session (see `createManagedUserEditorSession`) can send only `name`, `content`, `design` and `embedSettings`, and only for a composition made for its managed user. A body that names any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
1030
1081
  * Update Composition
1031
1082
  */
1032
- updateCompositionRaw(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
1083
+ updateCompositionRaw(requestParameters: UpdateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
1033
1084
  /**
1034
1085
  * Updates a specific composition. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry. An editor session (see `createManagedUserEditorSession`) can send only `name`, `content`, `design` and `embedSettings`, and only for a composition made for its managed user. A body that names any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`.
1035
1086
  * Update Composition
1036
1087
  */
1037
- updateComposition(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
1088
+ updateComposition(requestParameters: UpdateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
1038
1089
  /**
1039
1090
  * Updates an existing managed user. Only `external_id`, `metadata` and `is_active` can change, and `metadata` is replaced as a whole, so send all of it. `is_active: false` switches the managed user off: what it already has stays, and nothing new can be filed under it until you send `is_active: true`. Switching it off also ends all of its editor sessions, and they do not come back when you switch it on again. The `Idempotency-Key` header is required (`400` without it).
1040
1091
  * Update Managed User
@@ -1045,6 +1096,16 @@ export declare class PartnerApi extends runtime.BaseAPI {
1045
1096
  * Update Managed User
1046
1097
  */
1047
1098
  updateManagedUser(requestParameters: UpdateManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagedUser>;
1099
+ /**
1100
+ * 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.
1101
+ * Require a signed context, or stop requiring it
1102
+ */
1103
+ updatePartnerEntryContextSigningRaw(requestParameters: UpdatePartnerEntryContextSigningOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerEntryContextSigning>>;
1104
+ /**
1105
+ * 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.
1106
+ * Require a signed context, or stop requiring it
1107
+ */
1108
+ updatePartnerEntryContextSigning(requestParameters: UpdatePartnerEntryContextSigningOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEntryContextSigning>;
1048
1109
  /**
1049
1110
  * 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.
1050
1111
  * Choose where your notifications go