@widgetic/api-sdk 1.0.30 → 1.0.32
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/AdminApi.d.ts +3 -2
- package/dist/apis/AdminApi.js +3 -2
- package/dist/apis/BillingApi.d.ts +3 -3
- package/dist/apis/BillingApi.js +1 -1
- package/dist/apis/CompositionsApi.d.ts +190 -87
- package/dist/apis/CompositionsApi.js +378 -87
- package/dist/apis/CreditsApi.d.ts +6 -6
- package/dist/apis/InvoicesApi.d.ts +6 -6
- package/dist/apis/InvoicesApi.js +2 -2
- package/dist/apis/ManagedUsersApi.d.ts +104 -27
- package/dist/apis/ManagedUsersApi.js +247 -12
- package/dist/apis/OperationsApi.d.ts +3 -3
- package/dist/apis/PartnerApi.d.ts +1291 -0
- package/dist/apis/PartnerApi.js +3550 -0
- package/dist/apis/PartnersApi.d.ts +140 -43
- package/dist/apis/PartnersApi.js +286 -0
- package/dist/apis/PublicEmbedApi.d.ts +72 -0
- package/dist/apis/PublicEmbedApi.js +168 -0
- package/dist/apis/UploadsApi.d.ts +29 -16
- package/dist/apis/UploadsApi.js +40 -3
- package/dist/apis/UsersApi.d.ts +27 -27
- package/dist/apis/WidgetsApi.d.ts +33 -18
- package/dist/apis/WidgetsApi.js +84 -39
- package/dist/apis/index.d.ts +2 -0
- package/dist/apis/index.js +2 -0
- package/dist/esm/apis/AdminApi.d.ts +3 -2
- package/dist/esm/apis/AdminApi.js +3 -2
- package/dist/esm/apis/BillingApi.d.ts +3 -3
- package/dist/esm/apis/BillingApi.js +2 -2
- package/dist/esm/apis/CompositionsApi.d.ts +190 -87
- package/dist/esm/apis/CompositionsApi.js +378 -87
- package/dist/esm/apis/CreditsApi.d.ts +6 -6
- package/dist/esm/apis/InvoicesApi.d.ts +6 -6
- package/dist/esm/apis/InvoicesApi.js +1 -1
- package/dist/esm/apis/ManagedUsersApi.d.ts +104 -27
- package/dist/esm/apis/ManagedUsersApi.js +248 -13
- package/dist/esm/apis/OperationsApi.d.ts +3 -3
- package/dist/esm/apis/PartnerApi.d.ts +1291 -0
- package/dist/esm/apis/PartnerApi.js +3546 -0
- package/dist/esm/apis/PartnersApi.d.ts +140 -43
- package/dist/esm/apis/PartnersApi.js +287 -1
- package/dist/esm/apis/PublicEmbedApi.d.ts +72 -0
- package/dist/esm/apis/PublicEmbedApi.js +164 -0
- package/dist/esm/apis/UploadsApi.d.ts +29 -16
- package/dist/esm/apis/UploadsApi.js +40 -3
- package/dist/esm/apis/UsersApi.d.ts +27 -27
- package/dist/esm/apis/WidgetsApi.d.ts +33 -18
- package/dist/esm/apis/WidgetsApi.js +85 -40
- package/dist/esm/apis/index.d.ts +2 -0
- package/dist/esm/apis/index.js +2 -0
- package/dist/esm/models/Composition.d.ts +18 -0
- package/dist/esm/models/Composition.js +4 -0
- package/dist/esm/models/CompositionDataSource.d.ts +41 -0
- package/dist/esm/models/CompositionDataSource.js +47 -0
- package/dist/esm/models/CompositionEntriesReading.d.ts +20 -4
- package/dist/esm/models/CompositionEntriesReading.js +3 -0
- package/dist/esm/models/CompositionEntryAggregateTally.d.ts +69 -0
- package/dist/esm/models/CompositionEntryAggregateTally.js +51 -0
- package/dist/esm/models/CompositionEntryAggregatesBlock.d.ts +55 -0
- package/dist/esm/models/CompositionEntryAggregatesBlock.js +50 -0
- package/dist/esm/models/CompositionEntryDeleteSuccess.d.ts +39 -0
- package/dist/esm/models/CompositionEntryDeleteSuccess.js +48 -0
- package/dist/esm/models/CompositionEntryDeleteSuccessData.d.ts +32 -0
- package/dist/esm/models/CompositionEntryDeleteSuccessData.js +43 -0
- package/dist/esm/models/CompositionEntryItem.d.ts +63 -0
- package/dist/esm/models/CompositionEntryItem.js +57 -0
- package/dist/esm/models/CompositionEntryItemsMeta.d.ts +59 -0
- package/dist/esm/models/CompositionEntryItemsMeta.js +55 -0
- package/dist/esm/models/CompositionEntryItemsPageSuccess.d.ts +46 -0
- package/dist/esm/models/CompositionEntryItemsPageSuccess.js +53 -0
- package/dist/esm/models/CreateCanvasRequest.d.ts +6 -0
- package/dist/esm/models/CreateCanvasRequest.js +2 -0
- package/dist/esm/models/CreateCompositionContentItemRequest.d.ts +33 -0
- package/dist/esm/models/CreateCompositionContentItemRequest.js +37 -0
- package/dist/esm/models/CreateCompositionFromPresetRequest.d.ts +56 -0
- package/dist/esm/models/CreateCompositionFromPresetRequest.js +51 -0
- package/dist/esm/models/CreateCompositionFromWidget201Response.d.ts +39 -0
- package/dist/esm/models/{CreateComposition201Response.js → CreateCompositionFromWidget201Response.js} +8 -8
- package/dist/esm/models/CreateCompositionFromWidgetRequest.d.ts +62 -0
- package/dist/esm/models/CreateCompositionFromWidgetRequest.js +53 -0
- package/dist/esm/models/DeleteCompositionContentItem200Response.d.ts +38 -0
- package/dist/esm/models/DeleteCompositionContentItem200Response.js +43 -0
- package/dist/esm/models/DeleteCompositionDataSource200Response.d.ts +32 -0
- package/dist/esm/models/DeleteCompositionDataSource200Response.js +43 -0
- package/dist/esm/models/ExportCompositionEntryItems200Response.d.ts +46 -0
- package/dist/esm/models/ExportCompositionEntryItems200Response.js +53 -0
- package/dist/esm/models/ExportCompositionEntryItems200ResponseMeta.d.ts +38 -0
- package/dist/esm/models/ExportCompositionEntryItems200ResponseMeta.js +47 -0
- package/dist/esm/models/GetCompositionContentSchema200Response.d.ts +2 -2
- package/dist/esm/models/GetManagedUserLimits200Response.d.ts +39 -0
- package/dist/esm/models/GetManagedUserLimits200Response.js +44 -0
- package/dist/esm/models/GetManagedUserLimits200ResponseData.d.ts +50 -0
- package/dist/esm/models/GetManagedUserLimits200ResponseData.js +55 -0
- package/dist/esm/models/GetManagedUserStorageUsage200Response.d.ts +39 -0
- package/dist/esm/models/GetManagedUserStorageUsage200Response.js +44 -0
- package/dist/esm/models/GetManagedUserStorageUsage200ResponseData.d.ts +45 -0
- package/dist/esm/models/GetManagedUserStorageUsage200ResponseData.js +52 -0
- package/dist/esm/models/GetManagedUserStorageUsage200ResponseDataByPurpose.d.ts +51 -0
- package/dist/esm/models/GetManagedUserStorageUsage200ResponseDataByPurpose.js +48 -0
- package/dist/esm/models/GetPartnerDesignDefaults200Response.d.ts +39 -0
- package/dist/esm/models/GetPartnerDesignDefaults200Response.js +44 -0
- package/dist/esm/models/GetPartnerDesignDefaults200ResponseData.d.ts +32 -0
- package/dist/esm/models/GetPartnerDesignDefaults200ResponseData.js +41 -0
- package/dist/esm/models/GetPublicCompositionEmbed200Response.d.ts +106 -0
- package/dist/esm/models/GetPublicCompositionEmbed200Response.js +67 -0
- package/dist/esm/models/GetPublicCompositionEmbed200ResponseDataSource.d.ts +38 -0
- package/dist/esm/models/GetPublicCompositionEmbed200ResponseDataSource.js +43 -0
- package/dist/esm/models/GetPublicCompositionEmbed200ResponseDirect.d.ts +44 -0
- package/dist/esm/models/GetPublicCompositionEmbed200ResponseDirect.js +45 -0
- package/dist/esm/models/GetPublicCompositionEmbed403Response.d.ts +51 -0
- package/dist/esm/models/GetPublicCompositionEmbed403Response.js +48 -0
- package/dist/esm/models/GetPublicCompositionEmbed403ResponseDetails.d.ts +46 -0
- package/dist/esm/models/GetPublicCompositionEmbed403ResponseDetails.js +50 -0
- package/dist/esm/models/GetPublicCompositionEmbed404Response.d.ts +47 -0
- package/dist/esm/models/GetPublicCompositionEmbed404Response.js +51 -0
- package/dist/esm/models/GetPublicCompositionEmbed429Response.d.ts +38 -0
- package/dist/esm/models/GetPublicCompositionEmbed429Response.js +43 -0
- package/dist/esm/models/ManagedUserEntriesMeta.d.ts +56 -0
- package/dist/esm/models/ManagedUserEntriesMeta.js +57 -0
- package/dist/esm/models/ManagedUserEntriesPageSuccess.d.ts +46 -0
- package/dist/esm/models/ManagedUserEntriesPageSuccess.js +53 -0
- package/dist/esm/models/ManagedUserEntryItem.d.ts +75 -0
- package/dist/esm/models/ManagedUserEntryItem.js +65 -0
- package/dist/esm/models/PartnerEntryContextSecret.d.ts +39 -0
- package/dist/esm/models/PartnerEntryContextSecret.js +48 -0
- package/dist/esm/models/PartnerEntryContextSigning.d.ts +62 -0
- package/dist/esm/models/PartnerEntryContextSigning.js +63 -0
- package/dist/esm/models/PartnerNotification.d.ts +1 -1
- package/dist/esm/models/PartnerNotificationDelivery.d.ts +6 -0
- package/dist/esm/models/PartnerNotificationDelivery.js +4 -0
- package/dist/esm/models/PartnerNotificationEvent.d.ts +15 -0
- package/dist/esm/models/PartnerNotificationEvent.js +13 -1
- package/dist/esm/models/PartnerNotificationEventType.d.ts +4 -0
- package/dist/esm/models/PartnerNotificationEventType.js +5 -1
- package/dist/esm/models/PartnerNotificationTestEventRequest.d.ts +33 -0
- package/dist/esm/models/PartnerNotificationTestEventRequest.js +44 -0
- package/dist/esm/models/PartnerNotificationTestEventResult.d.ts +50 -0
- package/dist/esm/models/PartnerNotificationTestEventResult.js +53 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatus200Response.d.ts +39 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatus200Response.js +44 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatus200ResponseData.d.ts +45 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatus200ResponseData.js +51 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatus429Response.d.ts +32 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatus429Response.js +41 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatusRequest.d.ts +32 -0
- package/dist/esm/models/PostPublicCompositionEmbedStatusRequest.js +43 -0
- package/dist/esm/models/PublicCompositionEntryCreated.d.ts +39 -0
- package/dist/esm/models/PublicCompositionEntryCreated.js +48 -0
- package/dist/esm/models/PublicCompositionEntryCreatedData.d.ts +44 -0
- package/dist/esm/models/PublicCompositionEntryCreatedData.js +51 -0
- package/dist/esm/models/PublicCompositionEntryRequest.d.ts +40 -0
- package/dist/esm/models/PublicCompositionEntryRequest.js +45 -0
- package/dist/esm/models/PurposeStorageBucket.d.ts +38 -0
- package/dist/esm/models/PurposeStorageBucket.js +47 -0
- package/dist/esm/models/SetCompositionDataSourceRequest.d.ts +38 -0
- package/dist/esm/models/SetCompositionDataSourceRequest.js +47 -0
- package/dist/esm/models/SetDynamicContent200Response.d.ts +6 -0
- package/dist/esm/models/SetDynamicContent200Response.js +2 -0
- package/dist/esm/models/SetManagedUserLimitsRequest.d.ts +32 -0
- package/dist/esm/models/SetManagedUserLimitsRequest.js +43 -0
- package/dist/esm/models/SetPartnerDesignDefaultsRequest.d.ts +32 -0
- package/dist/esm/models/SetPartnerDesignDefaultsRequest.js +43 -0
- package/dist/esm/models/UpdatePartnerEntryContextSigningRequest.d.ts +32 -0
- package/dist/esm/models/UpdatePartnerEntryContextSigningRequest.js +43 -0
- package/dist/esm/models/Upload.d.ts +15 -0
- package/dist/esm/models/Upload.js +10 -0
- package/dist/esm/models/UploadsIdDelete200Response.d.ts +39 -0
- package/dist/esm/models/UploadsIdDelete200Response.js +44 -0
- package/dist/esm/models/UploadsIdDelete200ResponseData.d.ts +32 -0
- package/dist/esm/models/UploadsIdDelete200ResponseData.js +41 -0
- package/dist/esm/models/index.d.ts +51 -3
- package/dist/esm/models/index.js +51 -3
- package/dist/models/Composition.d.ts +18 -0
- package/dist/models/Composition.js +4 -0
- package/dist/models/CompositionDataSource.d.ts +41 -0
- package/dist/models/CompositionDataSource.js +54 -0
- package/dist/models/CompositionEntriesReading.d.ts +20 -4
- package/dist/models/CompositionEntriesReading.js +3 -0
- package/dist/models/CompositionEntryAggregateTally.d.ts +69 -0
- package/dist/models/CompositionEntryAggregateTally.js +58 -0
- package/dist/models/CompositionEntryAggregatesBlock.d.ts +55 -0
- package/dist/models/CompositionEntryAggregatesBlock.js +57 -0
- package/dist/models/CompositionEntryDeleteSuccess.d.ts +39 -0
- package/dist/models/CompositionEntryDeleteSuccess.js +55 -0
- package/dist/models/CompositionEntryDeleteSuccessData.d.ts +32 -0
- package/dist/models/CompositionEntryDeleteSuccessData.js +50 -0
- package/dist/models/CompositionEntryItem.d.ts +63 -0
- package/dist/models/CompositionEntryItem.js +64 -0
- package/dist/models/CompositionEntryItemsMeta.d.ts +59 -0
- package/dist/models/CompositionEntryItemsMeta.js +63 -0
- package/dist/models/CompositionEntryItemsPageSuccess.d.ts +46 -0
- package/dist/models/CompositionEntryItemsPageSuccess.js +60 -0
- package/dist/models/CreateCanvasRequest.d.ts +6 -0
- package/dist/models/CreateCanvasRequest.js +2 -0
- package/dist/models/CreateCompositionContentItemRequest.d.ts +33 -0
- package/dist/models/CreateCompositionContentItemRequest.js +44 -0
- package/dist/models/CreateCompositionFromPresetRequest.d.ts +56 -0
- package/dist/models/CreateCompositionFromPresetRequest.js +58 -0
- package/dist/models/CreateCompositionFromWidget201Response.d.ts +39 -0
- package/dist/models/CreateCompositionFromWidget201Response.js +51 -0
- package/dist/models/CreateCompositionFromWidgetRequest.d.ts +62 -0
- package/dist/models/CreateCompositionFromWidgetRequest.js +60 -0
- package/dist/models/DeleteCompositionContentItem200Response.d.ts +38 -0
- package/dist/models/DeleteCompositionContentItem200Response.js +50 -0
- package/dist/models/DeleteCompositionDataSource200Response.d.ts +32 -0
- package/dist/models/DeleteCompositionDataSource200Response.js +50 -0
- package/dist/models/ExportCompositionEntryItems200Response.d.ts +46 -0
- package/dist/models/ExportCompositionEntryItems200Response.js +60 -0
- package/dist/models/ExportCompositionEntryItems200ResponseMeta.d.ts +38 -0
- package/dist/models/ExportCompositionEntryItems200ResponseMeta.js +54 -0
- package/dist/models/GetCompositionContentSchema200Response.d.ts +2 -2
- package/dist/models/GetManagedUserLimits200Response.d.ts +39 -0
- package/dist/models/GetManagedUserLimits200Response.js +51 -0
- package/dist/models/GetManagedUserLimits200ResponseData.d.ts +50 -0
- package/dist/models/GetManagedUserLimits200ResponseData.js +62 -0
- package/dist/models/GetManagedUserStorageUsage200Response.d.ts +39 -0
- package/dist/models/GetManagedUserStorageUsage200Response.js +51 -0
- package/dist/models/GetManagedUserStorageUsage200ResponseData.d.ts +45 -0
- package/dist/models/GetManagedUserStorageUsage200ResponseData.js +59 -0
- package/dist/models/GetManagedUserStorageUsage200ResponseDataByPurpose.d.ts +51 -0
- package/dist/models/GetManagedUserStorageUsage200ResponseDataByPurpose.js +55 -0
- package/dist/models/GetPartnerDesignDefaults200Response.d.ts +39 -0
- package/dist/models/GetPartnerDesignDefaults200Response.js +51 -0
- package/dist/models/GetPartnerDesignDefaults200ResponseData.d.ts +32 -0
- package/dist/models/GetPartnerDesignDefaults200ResponseData.js +48 -0
- package/dist/models/GetPublicCompositionEmbed200Response.d.ts +106 -0
- package/dist/models/GetPublicCompositionEmbed200Response.js +74 -0
- package/dist/models/GetPublicCompositionEmbed200ResponseDataSource.d.ts +38 -0
- package/dist/models/GetPublicCompositionEmbed200ResponseDataSource.js +50 -0
- package/dist/models/GetPublicCompositionEmbed200ResponseDirect.d.ts +44 -0
- package/dist/models/GetPublicCompositionEmbed200ResponseDirect.js +52 -0
- package/dist/models/GetPublicCompositionEmbed403Response.d.ts +51 -0
- package/dist/models/GetPublicCompositionEmbed403Response.js +55 -0
- package/dist/models/GetPublicCompositionEmbed403ResponseDetails.d.ts +46 -0
- package/dist/models/GetPublicCompositionEmbed403ResponseDetails.js +58 -0
- package/dist/models/GetPublicCompositionEmbed404Response.d.ts +47 -0
- package/dist/models/GetPublicCompositionEmbed404Response.js +59 -0
- package/dist/models/GetPublicCompositionEmbed429Response.d.ts +38 -0
- package/dist/models/GetPublicCompositionEmbed429Response.js +50 -0
- package/dist/models/ManagedUserEntriesMeta.d.ts +56 -0
- package/dist/models/ManagedUserEntriesMeta.js +64 -0
- package/dist/models/ManagedUserEntriesPageSuccess.d.ts +46 -0
- package/dist/models/ManagedUserEntriesPageSuccess.js +60 -0
- package/dist/models/ManagedUserEntryItem.d.ts +75 -0
- package/dist/models/ManagedUserEntryItem.js +72 -0
- package/dist/models/PartnerEntryContextSecret.d.ts +39 -0
- package/dist/models/PartnerEntryContextSecret.js +55 -0
- package/dist/models/PartnerEntryContextSigning.d.ts +62 -0
- package/dist/models/PartnerEntryContextSigning.js +70 -0
- package/dist/models/PartnerNotification.d.ts +1 -1
- package/dist/models/PartnerNotificationDelivery.d.ts +6 -0
- package/dist/models/PartnerNotificationDelivery.js +4 -0
- package/dist/models/PartnerNotificationEvent.d.ts +15 -0
- package/dist/models/PartnerNotificationEvent.js +14 -2
- package/dist/models/PartnerNotificationEventType.d.ts +4 -0
- package/dist/models/PartnerNotificationEventType.js +5 -1
- package/dist/models/PartnerNotificationTestEventRequest.d.ts +33 -0
- package/dist/models/PartnerNotificationTestEventRequest.js +51 -0
- package/dist/models/PartnerNotificationTestEventResult.d.ts +50 -0
- package/dist/models/PartnerNotificationTestEventResult.js +60 -0
- package/dist/models/PostPublicCompositionEmbedStatus200Response.d.ts +39 -0
- package/dist/models/PostPublicCompositionEmbedStatus200Response.js +51 -0
- package/dist/models/PostPublicCompositionEmbedStatus200ResponseData.d.ts +45 -0
- package/dist/models/PostPublicCompositionEmbedStatus200ResponseData.js +59 -0
- package/dist/models/PostPublicCompositionEmbedStatus429Response.d.ts +32 -0
- package/dist/models/PostPublicCompositionEmbedStatus429Response.js +48 -0
- package/dist/models/PostPublicCompositionEmbedStatusRequest.d.ts +32 -0
- package/dist/models/PostPublicCompositionEmbedStatusRequest.js +50 -0
- package/dist/models/PublicCompositionEntryCreated.d.ts +39 -0
- package/dist/models/PublicCompositionEntryCreated.js +55 -0
- package/dist/models/PublicCompositionEntryCreatedData.d.ts +44 -0
- package/dist/models/PublicCompositionEntryCreatedData.js +58 -0
- package/dist/models/PublicCompositionEntryRequest.d.ts +40 -0
- package/dist/models/PublicCompositionEntryRequest.js +52 -0
- package/dist/models/PurposeStorageBucket.d.ts +38 -0
- package/dist/models/PurposeStorageBucket.js +54 -0
- package/dist/models/SetCompositionDataSourceRequest.d.ts +38 -0
- package/dist/models/SetCompositionDataSourceRequest.js +54 -0
- package/dist/models/SetDynamicContent200Response.d.ts +6 -0
- package/dist/models/SetDynamicContent200Response.js +2 -0
- package/dist/models/SetManagedUserLimitsRequest.d.ts +32 -0
- package/dist/models/SetManagedUserLimitsRequest.js +50 -0
- package/dist/models/SetPartnerDesignDefaultsRequest.d.ts +32 -0
- package/dist/models/SetPartnerDesignDefaultsRequest.js +50 -0
- package/dist/models/UpdatePartnerEntryContextSigningRequest.d.ts +32 -0
- package/dist/models/UpdatePartnerEntryContextSigningRequest.js +50 -0
- package/dist/models/Upload.d.ts +15 -0
- package/dist/models/Upload.js +11 -1
- package/dist/models/UploadsIdDelete200Response.d.ts +39 -0
- package/dist/models/UploadsIdDelete200Response.js +51 -0
- package/dist/models/UploadsIdDelete200ResponseData.d.ts +32 -0
- package/dist/models/UploadsIdDelete200ResponseData.js +48 -0
- package/dist/models/index.d.ts +51 -3
- package/dist/models/index.js +51 -3
- package/package.json +1 -1
- package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +0 -39
- package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +0 -44
- package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +0 -32
- package/dist/esm/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +0 -41
- package/dist/esm/models/CreateComposition201Response.d.ts +0 -39
- package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +0 -39
- package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +0 -51
- package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +0 -32
- package/dist/models/BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +0 -48
- package/dist/models/CreateComposition201Response.d.ts +0 -39
- package/dist/models/CreateComposition201Response.js +0 -51
|
@@ -10,12 +10,15 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type { CheckCompositionAccess200Response, Composition, CompositionEntriesDescription, CompositionEntriesReading,
|
|
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
|
}
|
|
17
|
-
export interface
|
|
18
|
-
|
|
17
|
+
export interface CreateCompositionContentItem0Request {
|
|
18
|
+
id: string;
|
|
19
|
+
list: string;
|
|
20
|
+
createCompositionContentItemRequest: CreateCompositionContentItemRequest;
|
|
21
|
+
ifMatch?: string;
|
|
19
22
|
idempotencyKey?: string;
|
|
20
23
|
}
|
|
21
24
|
export interface CreateCompositionDatabaseRecordRequest {
|
|
@@ -24,41 +27,59 @@ export interface CreateCompositionDatabaseRecordRequest {
|
|
|
24
27
|
body: object;
|
|
25
28
|
idempotencyKey?: string;
|
|
26
29
|
}
|
|
27
|
-
export interface
|
|
30
|
+
export interface CreateComposition0Request {
|
|
31
|
+
newComposition: NewComposition;
|
|
32
|
+
idempotencyKey?: string;
|
|
33
|
+
}
|
|
34
|
+
export interface DeleteCompositionContentItem0Request {
|
|
28
35
|
id: string;
|
|
36
|
+
list: string;
|
|
37
|
+
itemId: string;
|
|
38
|
+
ifMatch?: string;
|
|
39
|
+
idempotencyKey?: string;
|
|
40
|
+
}
|
|
41
|
+
export interface DeleteCompositionDataSource0Request {
|
|
42
|
+
id: string;
|
|
43
|
+
idempotencyKey?: string;
|
|
29
44
|
}
|
|
30
45
|
export interface DeleteCompositionDatabaseRecordRequest {
|
|
31
46
|
id: string;
|
|
32
47
|
table: string;
|
|
33
48
|
recordId: string;
|
|
34
49
|
}
|
|
35
|
-
export interface
|
|
50
|
+
export interface DeleteComposition0Request {
|
|
51
|
+
id: string;
|
|
52
|
+
}
|
|
53
|
+
export interface DescribeCompositionEntries0Request {
|
|
36
54
|
id: string;
|
|
37
55
|
}
|
|
38
|
-
export interface
|
|
56
|
+
export interface DuplicateComposition0Request {
|
|
39
57
|
id: string;
|
|
40
58
|
idempotencyKey?: string;
|
|
41
59
|
duplicateCompositionRequest?: DuplicateCompositionRequest;
|
|
42
60
|
}
|
|
43
|
-
export interface
|
|
61
|
+
export interface GetAllCompositions0Request {
|
|
44
62
|
page?: number;
|
|
45
63
|
size?: number;
|
|
46
64
|
sort?: string;
|
|
47
65
|
widgetId?: string;
|
|
48
|
-
workspace?:
|
|
66
|
+
workspace?: GetAllCompositions0WorkspaceEnum;
|
|
49
67
|
projectFolder?: string;
|
|
50
|
-
status?:
|
|
68
|
+
status?: GetAllCompositions0StatusEnum;
|
|
51
69
|
include?: string;
|
|
52
70
|
managedUserId?: string;
|
|
53
71
|
managedUserExternalId?: string;
|
|
54
72
|
}
|
|
55
|
-
export interface
|
|
73
|
+
export interface GetCompositionById0Request {
|
|
74
|
+
id: string;
|
|
75
|
+
}
|
|
76
|
+
export interface GetCompositionContentSchema0Request {
|
|
56
77
|
id: string;
|
|
57
78
|
}
|
|
58
|
-
export interface
|
|
79
|
+
export interface GetCompositionContent0Request {
|
|
59
80
|
id: string;
|
|
60
81
|
}
|
|
61
|
-
export interface
|
|
82
|
+
export interface GetCompositionDataSource0Request {
|
|
62
83
|
id: string;
|
|
63
84
|
}
|
|
64
85
|
export interface GetCompositionDatabaseRecordRequest {
|
|
@@ -70,16 +91,16 @@ export interface GetCompositionDatabaseRecordsRequest {
|
|
|
70
91
|
id: string;
|
|
71
92
|
table: string;
|
|
72
93
|
}
|
|
73
|
-
export interface
|
|
94
|
+
export interface GetCompositionDesignSchema0Request {
|
|
74
95
|
id: string;
|
|
75
96
|
}
|
|
76
|
-
export interface
|
|
97
|
+
export interface GetCompositionDesign0Request {
|
|
77
98
|
id: string;
|
|
78
99
|
}
|
|
79
|
-
export interface
|
|
100
|
+
export interface GetCompositionEmbedSchema0Request {
|
|
80
101
|
id: string;
|
|
81
102
|
}
|
|
82
|
-
export interface
|
|
103
|
+
export interface GetCompositionEmbedSettings0Request {
|
|
83
104
|
id: string;
|
|
84
105
|
}
|
|
85
106
|
export interface GetCompositionPreviewRequest {
|
|
@@ -91,20 +112,41 @@ export interface GetCompositionVersionsRequest {
|
|
|
91
112
|
export interface GetCompositionsBatchOperationRequest {
|
|
92
113
|
getCompositionsBatchRequest: GetCompositionsBatchRequest;
|
|
93
114
|
}
|
|
94
|
-
export interface
|
|
115
|
+
export interface PatchCompositionContentItem0Request {
|
|
116
|
+
id: string;
|
|
117
|
+
list: string;
|
|
118
|
+
itemId: string;
|
|
119
|
+
requestBody: {
|
|
120
|
+
[key: string]: any;
|
|
121
|
+
};
|
|
122
|
+
ifMatch?: string;
|
|
123
|
+
idempotencyKey?: string;
|
|
124
|
+
}
|
|
125
|
+
export interface ReadCompositionEntries0Request {
|
|
95
126
|
id: string;
|
|
96
127
|
table: string;
|
|
97
128
|
groupBy?: string;
|
|
98
129
|
rows?: number;
|
|
130
|
+
aggregate?: string;
|
|
131
|
+
column?: string;
|
|
132
|
+
since?: Date;
|
|
133
|
+
until?: Date;
|
|
134
|
+
context?: {
|
|
135
|
+
[key: string]: string;
|
|
136
|
+
};
|
|
137
|
+
filter?: {
|
|
138
|
+
[key: string]: string;
|
|
139
|
+
};
|
|
99
140
|
}
|
|
100
|
-
export interface
|
|
141
|
+
export interface SetCompositionDataSource0Request {
|
|
101
142
|
id: string;
|
|
102
|
-
|
|
143
|
+
setCompositionDataSourceRequest: SetCompositionDataSourceRequest;
|
|
103
144
|
idempotencyKey?: string;
|
|
104
145
|
}
|
|
105
|
-
export interface
|
|
146
|
+
export interface SetDynamicContent0Request {
|
|
106
147
|
id: string;
|
|
107
|
-
|
|
148
|
+
setDynamicContentRequest: SetDynamicContentRequest;
|
|
149
|
+
ifMatch?: string;
|
|
108
150
|
idempotencyKey?: string;
|
|
109
151
|
}
|
|
110
152
|
export interface UpdateCompositionDatabaseRecordRequest {
|
|
@@ -119,6 +161,11 @@ export interface UpdateCompositionStatusOperationRequest {
|
|
|
119
161
|
updateCompositionStatusRequest: UpdateCompositionStatusRequest;
|
|
120
162
|
idempotencyKey?: string;
|
|
121
163
|
}
|
|
164
|
+
export interface UpdateComposition0Request {
|
|
165
|
+
id: string;
|
|
166
|
+
updateComposition: UpdateComposition;
|
|
167
|
+
idempotencyKey?: string;
|
|
168
|
+
}
|
|
122
169
|
export interface ValidateCompositionContentRequest {
|
|
123
170
|
id: string;
|
|
124
171
|
body: object;
|
|
@@ -139,15 +186,15 @@ export declare class CompositionsApi extends runtime.BaseAPI {
|
|
|
139
186
|
*/
|
|
140
187
|
checkCompositionAccess(requestParameters: CheckCompositionAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckCompositionAccess200Response>;
|
|
141
188
|
/**
|
|
142
|
-
* Creates
|
|
143
|
-
*
|
|
189
|
+
* Creates one item in a widget content list without replacing the whole list. Item field keys are widget data (camelCase or snake_case are kept as sent). Partners use this to keep galleries in sync.
|
|
190
|
+
* Add a content list item
|
|
144
191
|
*/
|
|
145
|
-
|
|
192
|
+
createCompositionContentItemRaw(requestParameters: CreateCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
146
193
|
/**
|
|
147
|
-
* Creates
|
|
148
|
-
*
|
|
194
|
+
* Creates one item in a widget content list without replacing the whole list. Item field keys are widget data (camelCase or snake_case are kept as sent). Partners use this to keep galleries in sync.
|
|
195
|
+
* Add a content list item
|
|
149
196
|
*/
|
|
150
|
-
|
|
197
|
+
createCompositionContentItem(requestParameters: CreateCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
151
198
|
/**
|
|
152
199
|
* Creates a new record in a table in the composition\'s database.
|
|
153
200
|
* Create Record In Composition Database
|
|
@@ -159,15 +206,33 @@ export declare class CompositionsApi extends runtime.BaseAPI {
|
|
|
159
206
|
*/
|
|
160
207
|
createCompositionDatabaseRecord(requestParameters: CreateCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
161
208
|
/**
|
|
162
|
-
*
|
|
163
|
-
*
|
|
209
|
+
* Creates a new composition. To make the composition for one of your managed users, send `managedUserId` or `managedUserExternalId`. The composition stays in your account and is yours to edit; the tag lets you list one user\'s compositions with `getAllCompositions`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. A copy made with `duplicateComposition` keeps the tag of the original. An editor session with the `creator` surface may call this to start a composition of a widget it built: it sends only `name`, `widgetId` (a widget made for the session\'s managed user) and `content`, and the composition is always made for that managed user. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one composition is created, not two.
|
|
210
|
+
* Create Composition
|
|
164
211
|
*/
|
|
165
|
-
|
|
212
|
+
createCompositionRaw(requestParameters: CreateComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
166
213
|
/**
|
|
167
|
-
*
|
|
168
|
-
*
|
|
214
|
+
* Creates a new composition. To make the composition for one of your managed users, send `managedUserId` or `managedUserExternalId`. The composition stays in your account and is yours to edit; the tag lets you list one user\'s compositions with `getAllCompositions`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. A copy made with `duplicateComposition` keeps the tag of the original. An editor session with the `creator` surface may call this to start a composition of a widget it built: it sends only `name`, `widgetId` (a widget made for the session\'s managed user) and `content`, and the composition is always made for that managed user. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one composition is created, not two.
|
|
215
|
+
* Create Composition
|
|
216
|
+
*/
|
|
217
|
+
createComposition(requestParameters: CreateComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
218
|
+
/**
|
|
219
|
+
* Delete a content list item
|
|
220
|
+
*/
|
|
221
|
+
deleteCompositionContentItemRaw(requestParameters: DeleteCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCompositionContentItem200Response>>;
|
|
222
|
+
/**
|
|
223
|
+
* Delete a content list item
|
|
169
224
|
*/
|
|
170
|
-
|
|
225
|
+
deleteCompositionContentItem(requestParameters: DeleteCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCompositionContentItem200Response>;
|
|
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.
|
|
228
|
+
* Remove the composition data source binding
|
|
229
|
+
*/
|
|
230
|
+
deleteCompositionDataSourceRaw(requestParameters: DeleteCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCompositionDataSource200Response>>;
|
|
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.
|
|
233
|
+
* Remove the composition data source binding
|
|
234
|
+
*/
|
|
235
|
+
deleteCompositionDataSource(requestParameters: DeleteCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCompositionDataSource200Response>;
|
|
171
236
|
/**
|
|
172
237
|
* Deletes a specific record from a table in the composition\'s database.
|
|
173
238
|
* Delete Record From Composition Database
|
|
@@ -178,66 +243,86 @@ export declare class CompositionsApi extends runtime.BaseAPI {
|
|
|
178
243
|
* Delete Record From Composition Database
|
|
179
244
|
*/
|
|
180
245
|
deleteCompositionDatabaseRecord(requestParameters: DeleteCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
246
|
+
/**
|
|
247
|
+
* Deletes a specific composition.
|
|
248
|
+
* Delete Composition
|
|
249
|
+
*/
|
|
250
|
+
deleteCompositionRaw(requestParameters: DeleteComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
251
|
+
/**
|
|
252
|
+
* Deletes a specific composition.
|
|
253
|
+
* Delete Composition
|
|
254
|
+
*/
|
|
255
|
+
deleteComposition(requestParameters: DeleteComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
181
256
|
/**
|
|
182
257
|
* Names the tables a composition\'s widget keeps entries in (the votes, ratings, answers or sign-ups its visitors left), their columns, and how many entries each holds. Call it first to learn the table and column names that `readCompositionEntries` takes. A widget that only shows content keeps nothing of its own: the answer is `hasData: false` with no tables, and that is not an error. A table that could not be counted has `rows: null`, which is not zero. 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.
|
|
183
258
|
* Describe What a Composition Keeps
|
|
184
259
|
*/
|
|
185
|
-
describeCompositionEntriesRaw(requestParameters:
|
|
260
|
+
describeCompositionEntriesRaw(requestParameters: DescribeCompositionEntries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesDescription>>;
|
|
186
261
|
/**
|
|
187
262
|
* Names the tables a composition\'s widget keeps entries in (the votes, ratings, answers or sign-ups its visitors left), their columns, and how many entries each holds. Call it first to learn the table and column names that `readCompositionEntries` takes. A widget that only shows content keeps nothing of its own: the answer is `hasData: false` with no tables, and that is not an error. A table that could not be counted has `rows: null`, which is not zero. 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.
|
|
188
263
|
* Describe What a Composition Keeps
|
|
189
264
|
*/
|
|
190
|
-
describeCompositionEntries(requestParameters:
|
|
265
|
+
describeCompositionEntries(requestParameters: DescribeCompositionEntries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesDescription>;
|
|
191
266
|
/**
|
|
192
267
|
* Creates a duplicate of an existing composition for the authenticated user. The duplicate is made after the answer: the call returns `202` with an `operationId`. Ask `GET /operations/{id}` for that operation until its `status` is `completed`; the new composition is named in `metadata.newCompositionId`. A problem with the duplicate\'s database (for example, one that could not be copied) is listed in `metadata.warnings`, which is absent when there is none. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one duplicate is made, not two.
|
|
193
268
|
* Duplicate Composition
|
|
194
269
|
*/
|
|
195
|
-
duplicateCompositionRaw(requestParameters:
|
|
270
|
+
duplicateCompositionRaw(requestParameters: DuplicateComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DuplicateComposition202Response>>;
|
|
196
271
|
/**
|
|
197
272
|
* Creates a duplicate of an existing composition for the authenticated user. The duplicate is made after the answer: the call returns `202` with an `operationId`. Ask `GET /operations/{id}` for that operation until its `status` is `completed`; the new composition is named in `metadata.newCompositionId`. A problem with the duplicate\'s database (for example, one that could not be copied) is listed in `metadata.warnings`, which is absent when there is none. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one duplicate is made, not two.
|
|
198
273
|
* Duplicate Composition
|
|
199
274
|
*/
|
|
200
|
-
duplicateComposition(requestParameters:
|
|
275
|
+
duplicateComposition(requestParameters: DuplicateComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DuplicateComposition202Response>;
|
|
201
276
|
/**
|
|
202
277
|
* Retrieves all compositions with pagination support. Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the compositions made for that managed user. The compositions of your other managed users, and your own, are left out. It combines with the other filters and with paging. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. An editor session with the `creator` surface may call this to list the compositions of ONE widget it built: it must send `widget_id`, and the answer holds only the compositions made for the session\'s managed user.
|
|
203
278
|
* Get All Compositions
|
|
204
279
|
*/
|
|
205
|
-
getAllCompositionsRaw(requestParameters:
|
|
280
|
+
getAllCompositionsRaw(requestParameters: GetAllCompositions0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllCompositions200Response>>;
|
|
206
281
|
/**
|
|
207
282
|
* Retrieves all compositions with pagination support. Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the compositions made for that managed user. The compositions of your other managed users, and your own, are left out. It combines with the other filters and with paging. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. An editor session with the `creator` surface may call this to list the compositions of ONE widget it built: it must send `widget_id`, and the answer holds only the compositions made for the session\'s managed user.
|
|
208
283
|
* Get All Compositions
|
|
209
284
|
*/
|
|
210
|
-
getAllCompositions(requestParameters?:
|
|
285
|
+
getAllCompositions(requestParameters?: GetAllCompositions0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllCompositions200Response>;
|
|
211
286
|
/**
|
|
212
|
-
* 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.
|
|
213
288
|
* Get Composition
|
|
214
289
|
*/
|
|
215
|
-
getCompositionByIdRaw(requestParameters:
|
|
290
|
+
getCompositionByIdRaw(requestParameters: GetCompositionById0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
216
291
|
/**
|
|
217
|
-
* 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.
|
|
218
293
|
* Get Composition
|
|
219
294
|
*/
|
|
220
|
-
getCompositionById(requestParameters:
|
|
295
|
+
getCompositionById(requestParameters: GetCompositionById0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
296
|
+
/**
|
|
297
|
+
* Retrieves the content schema for a composition based on its widget type
|
|
298
|
+
* Get Content Schema
|
|
299
|
+
*/
|
|
300
|
+
getCompositionContentSchemaRaw(requestParameters: GetCompositionContentSchema0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionContentSchema200Response>>;
|
|
301
|
+
/**
|
|
302
|
+
* Retrieves the content schema for a composition based on its widget type
|
|
303
|
+
* Get Content Schema
|
|
304
|
+
*/
|
|
305
|
+
getCompositionContentSchema(requestParameters: GetCompositionContentSchema0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionContentSchema200Response>;
|
|
221
306
|
/**
|
|
222
307
|
* Retrieves the current content of a composition
|
|
223
308
|
* Get Current Content
|
|
224
309
|
*/
|
|
225
|
-
getCompositionContentRaw(requestParameters:
|
|
310
|
+
getCompositionContentRaw(requestParameters: GetCompositionContent0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
226
311
|
/**
|
|
227
312
|
* Retrieves the current content of a composition
|
|
228
313
|
* Get Current Content
|
|
229
314
|
*/
|
|
230
|
-
getCompositionContent(requestParameters:
|
|
315
|
+
getCompositionContent(requestParameters: GetCompositionContent0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
231
316
|
/**
|
|
232
|
-
*
|
|
233
|
-
*
|
|
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).
|
|
318
|
+
* Read the composition data source binding
|
|
234
319
|
*/
|
|
235
|
-
|
|
320
|
+
getCompositionDataSourceRaw(requestParameters: GetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionDataSource>>;
|
|
236
321
|
/**
|
|
237
|
-
*
|
|
238
|
-
*
|
|
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).
|
|
323
|
+
* Read the composition data source binding
|
|
239
324
|
*/
|
|
240
|
-
|
|
325
|
+
getCompositionDataSource(requestParameters: GetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionDataSource>;
|
|
241
326
|
/**
|
|
242
327
|
* Retrieves a specific record from a table in the composition\'s database.
|
|
243
328
|
* Get Record From Composition Database
|
|
@@ -258,46 +343,46 @@ export declare class CompositionsApi extends runtime.BaseAPI {
|
|
|
258
343
|
* Get All Records From Composition Database Table
|
|
259
344
|
*/
|
|
260
345
|
getCompositionDatabaseRecords(requestParameters: GetCompositionDatabaseRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
261
|
-
/**
|
|
262
|
-
* Retrieves only the design field from a composition.
|
|
263
|
-
* Get Composition Design
|
|
264
|
-
*/
|
|
265
|
-
getCompositionDesignRaw(requestParameters: GetCompositionDesignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
266
|
-
/**
|
|
267
|
-
* Retrieves only the design field from a composition.
|
|
268
|
-
* Get Composition Design
|
|
269
|
-
*/
|
|
270
|
-
getCompositionDesign(requestParameters: GetCompositionDesignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
271
346
|
/**
|
|
272
347
|
* Retrieves the design schema for a composition based on its widget type
|
|
273
348
|
* Get Design Schema
|
|
274
349
|
*/
|
|
275
|
-
getCompositionDesignSchemaRaw(requestParameters:
|
|
350
|
+
getCompositionDesignSchemaRaw(requestParameters: GetCompositionDesignSchema0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionDesignSchema200Response>>;
|
|
276
351
|
/**
|
|
277
352
|
* Retrieves the design schema for a composition based on its widget type
|
|
278
353
|
* Get Design Schema
|
|
279
354
|
*/
|
|
280
|
-
getCompositionDesignSchema(requestParameters:
|
|
355
|
+
getCompositionDesignSchema(requestParameters: GetCompositionDesignSchema0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionDesignSchema200Response>;
|
|
356
|
+
/**
|
|
357
|
+
* Retrieves only the design field from a composition.
|
|
358
|
+
* Get Composition Design
|
|
359
|
+
*/
|
|
360
|
+
getCompositionDesignRaw(requestParameters: GetCompositionDesign0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
361
|
+
/**
|
|
362
|
+
* Retrieves only the design field from a composition.
|
|
363
|
+
* Get Composition Design
|
|
364
|
+
*/
|
|
365
|
+
getCompositionDesign(requestParameters: GetCompositionDesign0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
281
366
|
/**
|
|
282
367
|
* Retrieves the definition of the composition\'s Embed tab: which settings exist, what each one holds, what it defaults to, and when its control is shown. It is the third tab beside `schema/content` and `schema/design`, in the same format (`componentGroups` → `components` → `propertyGroups` → `properties`, each property with a `type`, a `defaultValue` and an `inputController`), so a client that draws those two tabs draws this one with the same code. The schema is the same for every composition (it is the one Widgetic\'s own Embed Editor draws). The composition id decides who may ask: the caller must be able to read the composition. Reading and saving the values: - `GET /compositions/{id}/embed-settings` returns what the composition saved. A composition whose Embed tab was never saved has nothing to return; seed the form from `defaults`, which holds the `defaultValue` of every setting that declares one. - `PUT /compositions/{id}` with `embedSettings` saves them. The gateway stores `embedSettings` as given and does not check it against this schema; the schema is how a client knows what to put there. A property\'s `visibilityCondition` says when its control is shown: `condition` is a comparison of the current values of the properties named in `dependsOn` (`useIframe === false`, `embedTarget === \'mixed\' && keepDimensions === false`). While it is false the Embed Editor does not show the control. A colour picker with `showOpacityControls` saves its opacity next to the colour, under the key `<name>_opacity` as a number from 0 to 1 (`overlayBackgroundColor` → `overlayBackgroundColor_opacity`). Its `defaultTransparency` is a percentage and the saved value a fraction (50 → 0.5).
|
|
283
368
|
* Get Embed Schema
|
|
284
369
|
*/
|
|
285
|
-
getCompositionEmbedSchemaRaw(requestParameters:
|
|
370
|
+
getCompositionEmbedSchemaRaw(requestParameters: GetCompositionEmbedSchema0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionEmbedSchema200Response>>;
|
|
286
371
|
/**
|
|
287
372
|
* Retrieves the definition of the composition\'s Embed tab: which settings exist, what each one holds, what it defaults to, and when its control is shown. It is the third tab beside `schema/content` and `schema/design`, in the same format (`componentGroups` → `components` → `propertyGroups` → `properties`, each property with a `type`, a `defaultValue` and an `inputController`), so a client that draws those two tabs draws this one with the same code. The schema is the same for every composition (it is the one Widgetic\'s own Embed Editor draws). The composition id decides who may ask: the caller must be able to read the composition. Reading and saving the values: - `GET /compositions/{id}/embed-settings` returns what the composition saved. A composition whose Embed tab was never saved has nothing to return; seed the form from `defaults`, which holds the `defaultValue` of every setting that declares one. - `PUT /compositions/{id}` with `embedSettings` saves them. The gateway stores `embedSettings` as given and does not check it against this schema; the schema is how a client knows what to put there. A property\'s `visibilityCondition` says when its control is shown: `condition` is a comparison of the current values of the properties named in `dependsOn` (`useIframe === false`, `embedTarget === \'mixed\' && keepDimensions === false`). While it is false the Embed Editor does not show the control. A colour picker with `showOpacityControls` saves its opacity next to the colour, under the key `<name>_opacity` as a number from 0 to 1 (`overlayBackgroundColor` → `overlayBackgroundColor_opacity`). Its `defaultTransparency` is a percentage and the saved value a fraction (50 → 0.5).
|
|
288
373
|
* Get Embed Schema
|
|
289
374
|
*/
|
|
290
|
-
getCompositionEmbedSchema(requestParameters:
|
|
375
|
+
getCompositionEmbedSchema(requestParameters: GetCompositionEmbedSchema0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionEmbedSchema200Response>;
|
|
291
376
|
/**
|
|
292
377
|
* Retrieves only the embedSettings field from a composition.
|
|
293
378
|
* Get Composition Embed Settings
|
|
294
379
|
*/
|
|
295
|
-
getCompositionEmbedSettingsRaw(requestParameters:
|
|
380
|
+
getCompositionEmbedSettingsRaw(requestParameters: GetCompositionEmbedSettings0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
296
381
|
/**
|
|
297
382
|
* Retrieves only the embedSettings field from a composition.
|
|
298
383
|
* Get Composition Embed Settings
|
|
299
384
|
*/
|
|
300
|
-
getCompositionEmbedSettings(requestParameters:
|
|
385
|
+
getCompositionEmbedSettings(requestParameters: GetCompositionEmbedSettings0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
301
386
|
/**
|
|
302
387
|
* Returns the address of the page an editor shows the composition in: the page of the widget\'s published version on the CDN, with the widget and version it is. Load it in a frame, then send the frame what to show (the content, design and embed settings you read from the composition, and every change the user makes) with `postMessage`: `{ type: \'widgetic:update\', design }`, `{ type: \'widgetic:update\', content }` or `{ type: \'widgetic:update\', contentItems }`. The version is the one embeds show, so the editor previews what a visitor gets. The address does not carry the composition id: an embed uses the id to fetch the saved composition itself, while an editor sends the current state (unsaved changes included). A widget that has never been published has no page to show: the answer is 409 `WIDGET_NOT_PUBLISHED`.
|
|
303
388
|
* Get Composition Preview
|
|
@@ -329,35 +414,43 @@ export declare class CompositionsApi extends runtime.BaseAPI {
|
|
|
329
414
|
*/
|
|
330
415
|
getCompositionsBatch(requestParameters: GetCompositionsBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionsBatch200Response>;
|
|
331
416
|
/**
|
|
332
|
-
*
|
|
417
|
+
* Update a content list item
|
|
418
|
+
*/
|
|
419
|
+
patchCompositionContentItemRaw(requestParameters: PatchCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
420
|
+
/**
|
|
421
|
+
* Update a content list item
|
|
422
|
+
*/
|
|
423
|
+
patchCompositionContentItem(requestParameters: PatchCompositionContentItem0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
424
|
+
/**
|
|
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.
|
|
333
426
|
* Read the Entries of a Composition\'s Table
|
|
334
427
|
*/
|
|
335
|
-
readCompositionEntriesRaw(requestParameters:
|
|
428
|
+
readCompositionEntriesRaw(requestParameters: ReadCompositionEntries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesReading>>;
|
|
336
429
|
/**
|
|
337
|
-
* 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.
|
|
338
431
|
* Read the Entries of a Composition\'s Table
|
|
339
432
|
*/
|
|
340
|
-
readCompositionEntries(requestParameters:
|
|
433
|
+
readCompositionEntries(requestParameters: ReadCompositionEntries0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesReading>;
|
|
341
434
|
/**
|
|
342
|
-
*
|
|
343
|
-
*
|
|
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`).
|
|
436
|
+
* Bind a public JSON data source for embed refresh
|
|
344
437
|
*/
|
|
345
|
-
|
|
438
|
+
setCompositionDataSourceRaw(requestParameters: SetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionDataSource>>;
|
|
346
439
|
/**
|
|
347
|
-
*
|
|
348
|
-
*
|
|
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`).
|
|
441
|
+
* Bind a public JSON data source for embed refresh
|
|
349
442
|
*/
|
|
350
|
-
|
|
443
|
+
setCompositionDataSource(requestParameters: SetCompositionDataSource0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionDataSource>;
|
|
351
444
|
/**
|
|
352
|
-
* Updates
|
|
353
|
-
*
|
|
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`.
|
|
446
|
+
* Set Dynamic Content
|
|
354
447
|
*/
|
|
355
|
-
|
|
448
|
+
setDynamicContentRaw(requestParameters: SetDynamicContent0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetDynamicContent200Response>>;
|
|
356
449
|
/**
|
|
357
|
-
* Updates
|
|
358
|
-
*
|
|
450
|
+
* 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`.
|
|
451
|
+
* Set Dynamic Content
|
|
359
452
|
*/
|
|
360
|
-
|
|
453
|
+
setDynamicContent(requestParameters: SetDynamicContent0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetDynamicContent200Response>;
|
|
361
454
|
/**
|
|
362
455
|
* Updates a specific record in a table in the composition\'s database.
|
|
363
456
|
* Update Record In Composition Database
|
|
@@ -378,6 +471,16 @@ export declare class CompositionsApi extends runtime.BaseAPI {
|
|
|
378
471
|
* Update Composition Status
|
|
379
472
|
*/
|
|
380
473
|
updateCompositionStatus(requestParameters: UpdateCompositionStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Composition>;
|
|
474
|
+
/**
|
|
475
|
+
* 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`.
|
|
476
|
+
* Update Composition
|
|
477
|
+
*/
|
|
478
|
+
updateCompositionRaw(requestParameters: UpdateComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
479
|
+
/**
|
|
480
|
+
* 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`.
|
|
481
|
+
* Update Composition
|
|
482
|
+
*/
|
|
483
|
+
updateComposition(requestParameters: UpdateComposition0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
381
484
|
/**
|
|
382
485
|
* Validates content against the composition\'s widget schema without updating
|
|
383
486
|
* Validate Content
|
|
@@ -392,17 +495,17 @@ export declare class CompositionsApi extends runtime.BaseAPI {
|
|
|
392
495
|
/**
|
|
393
496
|
* @export
|
|
394
497
|
*/
|
|
395
|
-
export declare const
|
|
498
|
+
export declare const GetAllCompositions0WorkspaceEnum: {
|
|
396
499
|
readonly True: "true";
|
|
397
500
|
readonly False: "false";
|
|
398
501
|
};
|
|
399
|
-
export type
|
|
502
|
+
export type GetAllCompositions0WorkspaceEnum = typeof GetAllCompositions0WorkspaceEnum[keyof typeof GetAllCompositions0WorkspaceEnum];
|
|
400
503
|
/**
|
|
401
504
|
* @export
|
|
402
505
|
*/
|
|
403
|
-
export declare const
|
|
506
|
+
export declare const GetAllCompositions0StatusEnum: {
|
|
404
507
|
readonly Draft: "draft";
|
|
405
508
|
readonly Published: "published";
|
|
406
509
|
readonly Archived: "archived";
|
|
407
510
|
};
|
|
408
|
-
export type
|
|
511
|
+
export type GetAllCompositions0StatusEnum = typeof GetAllCompositions0StatusEnum[keyof typeof GetAllCompositions0StatusEnum];
|