@widgetic/api-sdk 1.0.29 → 1.0.31
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/AgentRepositoryManagementApi.d.ts +32 -0
- package/dist/apis/AgentRepositoryManagementApi.js +75 -0
- package/dist/apis/BillingApi.d.ts +3 -3
- package/dist/apis/BillingApi.js +1 -1
- package/dist/apis/CompositionsApi.d.ts +182 -83
- package/dist/apis/CompositionsApi.js +368 -84
- package/dist/apis/CreditsApi.d.ts +6 -6
- package/dist/apis/EnterpriseCustomizationsApi.d.ts +87 -0
- package/dist/apis/EnterpriseCustomizationsApi.js +233 -0
- 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 +1230 -0
- package/dist/apis/PartnerApi.js +3376 -0
- package/dist/apis/PartnersApi.d.ts +83 -43
- package/dist/apis/PartnersApi.js +119 -0
- package/dist/apis/PublicEmbedApi.d.ts +33 -0
- package/dist/apis/PublicEmbedApi.js +71 -0
- package/dist/apis/UIComponentsApi.d.ts +96 -0
- package/dist/apis/UIComponentsApi.js +209 -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/WorkflowsApi.d.ts +44 -0
- package/dist/apis/WorkflowsApi.js +111 -0
- package/dist/apis/index.d.ts +6 -0
- package/dist/apis/index.js +6 -0
- package/dist/esm/apis/AdminApi.d.ts +3 -2
- package/dist/esm/apis/AdminApi.js +3 -2
- package/dist/esm/apis/AgentRepositoryManagementApi.d.ts +32 -0
- package/dist/esm/apis/AgentRepositoryManagementApi.js +71 -0
- package/dist/esm/apis/BillingApi.d.ts +3 -3
- package/dist/esm/apis/BillingApi.js +2 -2
- package/dist/esm/apis/CompositionsApi.d.ts +182 -83
- package/dist/esm/apis/CompositionsApi.js +368 -84
- package/dist/esm/apis/CreditsApi.d.ts +6 -6
- package/dist/esm/apis/EnterpriseCustomizationsApi.d.ts +87 -0
- package/dist/esm/apis/EnterpriseCustomizationsApi.js +229 -0
- 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 +1230 -0
- package/dist/esm/apis/PartnerApi.js +3372 -0
- package/dist/esm/apis/PartnersApi.d.ts +83 -43
- package/dist/esm/apis/PartnersApi.js +120 -1
- package/dist/esm/apis/PublicEmbedApi.d.ts +33 -0
- package/dist/esm/apis/PublicEmbedApi.js +67 -0
- package/dist/esm/apis/UIComponentsApi.d.ts +96 -0
- package/dist/esm/apis/UIComponentsApi.js +205 -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/WorkflowsApi.d.ts +44 -0
- package/dist/esm/apis/WorkflowsApi.js +107 -0
- package/dist/esm/apis/index.d.ts +6 -0
- package/dist/esm/apis/index.js +6 -0
- package/dist/esm/models/AgentRepositoriesRepoIdSyncPost202Response.d.ts +32 -0
- package/dist/esm/models/AgentRepositoriesRepoIdSyncPost202Response.js +41 -0
- package/dist/esm/models/AgentRepositoriesRepoIdSyncPostRequest.d.ts +32 -0
- package/dist/esm/models/AgentRepositoriesRepoIdSyncPostRequest.js +43 -0
- package/dist/esm/models/AgentTasksTaskIdStatusPutRequest.d.ts +54 -0
- package/dist/esm/models/AgentTasksTaskIdStatusPutRequest.js +60 -0
- package/dist/esm/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.d.ts +32 -0
- package/dist/esm/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.js +41 -0
- package/dist/esm/models/ApiV1AdminBillingGrantsPostRequest.d.ts +82 -0
- package/dist/esm/models/ApiV1AdminBillingGrantsPostRequest.js +79 -0
- package/dist/esm/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.d.ts +32 -0
- package/dist/esm/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.js +41 -0
- package/dist/esm/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.d.ts +32 -0
- package/dist/esm/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.js +43 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPostRequest.d.ts +64 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPostRequest.js +60 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200Response.d.ts +71 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200Response.js +59 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.d.ts +51 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.js +48 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPostRequest.d.ts +70 -0
- package/dist/esm/models/ApiV1AdminBillingRefundsPreviewPostRequest.js +62 -0
- package/dist/esm/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.d.ts +46 -0
- package/dist/esm/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.js +52 -0
- package/dist/esm/models/ApiV1BillingPricingGet200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingPricingGet200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingPricingGet200ResponseData.d.ts +46 -0
- package/dist/esm/models/ApiV1BillingPricingGet200ResponseData.js +47 -0
- package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataPlansInner.d.ts +68 -0
- package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataPlansInner.js +53 -0
- package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataTrial.d.ts +44 -0
- package/dist/esm/models/ApiV1BillingPricingGet200ResponseDataTrial.js +45 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.d.ts +33 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.js +42 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.d.ts +68 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.js +53 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.d.ts +32 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.js +41 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +32 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +41 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.d.ts +32 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.js +41 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.d.ts +32 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.js +41 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.d.ts +120 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.js +76 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.d.ts +38 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.js +43 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.js +44 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.d.ts +38 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.js +43 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.d.ts +53 -0
- package/dist/esm/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.js +58 -0
- package/dist/esm/models/ApiV1MetricsGet200Response.d.ts +39 -0
- package/dist/esm/models/ApiV1MetricsGet200Response.js +44 -0
- package/dist/esm/models/ApiV1MetricsGet200ResponseData.d.ts +56 -0
- package/dist/esm/models/ApiV1MetricsGet200ResponseData.js +50 -0
- package/dist/esm/models/ApiV1MetricsGet200ResponseDataErrorsValue.d.ts +44 -0
- package/dist/esm/models/ApiV1MetricsGet200ResponseDataErrorsValue.js +45 -0
- package/dist/esm/models/ApiV1MetricsGet200ResponseDataLatencyValue.d.ts +50 -0
- package/dist/esm/models/ApiV1MetricsGet200ResponseDataLatencyValue.js +47 -0
- package/dist/esm/models/ApiV1MetricsLatencyGet200Response.d.ts +41 -0
- package/dist/esm/models/ApiV1MetricsLatencyGet200Response.js +45 -0
- package/dist/esm/models/ApiV1MetricsLatencyGet200ResponseDataValue.d.ts +62 -0
- package/dist/esm/models/ApiV1MetricsLatencyGet200ResponseDataValue.js +51 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.d.ts +71 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.js +59 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.d.ts +51 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.js +48 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.d.ts +38 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.js +43 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.d.ts +44 -0
- package/dist/esm/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.js +45 -0
- package/dist/esm/models/CancelCurrentSubscription200Response.d.ts +45 -0
- package/dist/esm/models/CancelCurrentSubscription200Response.js +46 -0
- package/dist/esm/models/CancelCurrentSubscriptionRequest.d.ts +44 -0
- package/dist/esm/models/CancelCurrentSubscriptionRequest.js +45 -0
- package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.d.ts +38 -0
- package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.js +43 -0
- package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.d.ts +38 -0
- package/dist/esm/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.js +47 -0
- package/dist/esm/models/ComponentManifest.d.ts +52 -0
- package/dist/esm/models/ComponentManifest.js +49 -0
- package/dist/esm/models/ComponentManifestAssets.d.ts +38 -0
- package/dist/esm/models/ComponentManifestAssets.js +43 -0
- package/dist/esm/models/ComponentManifestConfig.d.ts +44 -0
- package/dist/esm/models/ComponentManifestConfig.js +45 -0
- package/dist/esm/models/Composition.d.ts +6 -0
- package/dist/esm/models/Composition.js +2 -0
- package/dist/esm/models/CompositionEntryAggregateTally.d.ts +62 -0
- package/dist/esm/models/CompositionEntryAggregateTally.js +51 -0
- package/dist/esm/models/CompositionEntryAggregatesBlock.d.ts +45 -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 +60 -0
- package/dist/esm/models/CompositionEntryItem.js +57 -0
- package/dist/esm/models/CompositionEntryItemsMeta.d.ts +51 -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/CreateCheckoutSession200Response.d.ts +38 -0
- package/dist/esm/models/CreateCheckoutSession200Response.js +43 -0
- package/dist/esm/models/CreateCheckoutSessionRequest.d.ts +32 -0
- package/dist/esm/models/CreateCheckoutSessionRequest.js +43 -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/CreateCompositionFromWidget201Response.js +44 -0
- 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/DevelopmentPlan.d.ts +97 -0
- package/dist/esm/models/DevelopmentPlan.js +69 -0
- package/dist/esm/models/DevelopmentTask.d.ts +90 -0
- package/dist/esm/models/DevelopmentTask.js +66 -0
- package/dist/esm/models/EnterpriseCustomization.d.ts +125 -0
- package/dist/esm/models/EnterpriseCustomization.js +77 -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/GenerateComponentWorkflowInput.d.ts +56 -0
- package/dist/esm/models/GenerateComponentWorkflowInput.js +55 -0
- package/dist/esm/models/GenerateMixedComponentInput.d.ts +62 -0
- package/dist/esm/models/GenerateMixedComponentInput.js +59 -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/GetOrganizationStorageUsage200ResponseDataBreakdown.d.ts +44 -0
- package/dist/esm/models/GetOrganizationStorageUsage200ResponseDataBreakdown.js +45 -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/ListComponents200Response.d.ts +33 -0
- package/dist/esm/models/ListComponents200Response.js +42 -0
- package/dist/esm/models/ListEnterpriseCustomizations200Response.d.ts +40 -0
- package/dist/esm/models/ListEnterpriseCustomizations200Response.js +45 -0
- package/dist/esm/models/ListEnterpriseCustomizations200ResponsePagination.d.ts +50 -0
- package/dist/esm/models/ListEnterpriseCustomizations200ResponsePagination.js +47 -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 +72 -0
- package/dist/esm/models/ManagedUserEntryItem.js +65 -0
- package/dist/esm/models/MountRequest.d.ts +45 -0
- package/dist/esm/models/MountRequest.js +48 -0
- package/dist/esm/models/MountRequestTheme.d.ts +54 -0
- package/dist/esm/models/MountRequestTheme.js +54 -0
- package/dist/esm/models/MountRequestThemeColors.d.ts +50 -0
- package/dist/esm/models/MountRequestThemeColors.js +47 -0
- package/dist/esm/models/MountRequestThemeTypography.d.ts +38 -0
- package/dist/esm/models/MountRequestThemeTypography.js +43 -0
- package/dist/esm/models/MountResponse.d.ts +46 -0
- package/dist/esm/models/MountResponse.js +50 -0
- package/dist/esm/models/NewWidgetComponentsMetadataInner.d.ts +64 -0
- package/dist/esm/models/NewWidgetComponentsMetadataInner.js +53 -0
- package/dist/esm/models/NewWidgetComponentsMetadataInnerPosition.d.ts +38 -0
- package/dist/esm/models/NewWidgetComponentsMetadataInnerPosition.js +43 -0
- package/dist/esm/models/NewWidgetComponentsMetadataInnerSize.d.ts +38 -0
- package/dist/esm/models/NewWidgetComponentsMetadataInnerSize.js +43 -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/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/PurchaseStoragePack200ResponseDataPaymentIntent.d.ts +50 -0
- package/dist/esm/models/PurchaseStoragePack200ResponseDataPaymentIntent.js +47 -0
- package/dist/esm/models/PurposeStorageBucket.d.ts +38 -0
- package/dist/esm/models/PurposeStorageBucket.js +47 -0
- package/dist/esm/models/RollbackComponentRequest.d.ts +38 -0
- package/dist/esm/models/RollbackComponentRequest.js +45 -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/UIComponent.d.ts +65 -0
- package/dist/esm/models/UIComponent.js +57 -0
- package/dist/esm/models/UpdateCompositionRequest.d.ts +38 -0
- package/dist/esm/models/UpdateCompositionRequest.js +43 -0
- package/dist/esm/models/UpdateCurrentSubscriptionRequest.d.ts +38 -0
- package/dist/esm/models/UpdateCurrentSubscriptionRequest.js +43 -0
- package/dist/esm/models/UpdateEnterpriseCustomizationRequest.d.ts +95 -0
- package/dist/esm/models/UpdateEnterpriseCustomizationRequest.js +67 -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/WorkflowAcceptedResponse.d.ts +38 -0
- package/dist/esm/models/WorkflowAcceptedResponse.js +43 -0
- package/dist/esm/models/index.d.ts +109 -2
- package/dist/esm/models/index.js +109 -2
- package/dist/models/AgentRepositoriesRepoIdSyncPost202Response.d.ts +32 -0
- package/dist/models/AgentRepositoriesRepoIdSyncPost202Response.js +48 -0
- package/dist/models/AgentRepositoriesRepoIdSyncPostRequest.d.ts +32 -0
- package/dist/models/AgentRepositoriesRepoIdSyncPostRequest.js +50 -0
- package/dist/models/AgentTasksTaskIdStatusPutRequest.d.ts +54 -0
- package/dist/models/AgentTasksTaskIdStatusPutRequest.js +68 -0
- package/dist/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.d.ts +32 -0
- package/dist/models/ApiV1AdminBillingGrantsGrantIdRejectPostRequest.js +48 -0
- package/dist/models/ApiV1AdminBillingGrantsPostRequest.d.ts +82 -0
- package/dist/models/ApiV1AdminBillingGrantsPostRequest.js +87 -0
- package/dist/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.d.ts +32 -0
- package/dist/models/ApiV1AdminBillingPlansPricesBackfillPostRequest.js +48 -0
- package/dist/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.d.ts +32 -0
- package/dist/models/ApiV1AdminBillingPlansPricesPlanTypeBillingFrequencyPutRequest.js +50 -0
- package/dist/models/ApiV1AdminBillingRefundsPostRequest.d.ts +64 -0
- package/dist/models/ApiV1AdminBillingRefundsPostRequest.js +68 -0
- package/dist/models/ApiV1AdminBillingRefundsPreviewPost200Response.d.ts +71 -0
- package/dist/models/ApiV1AdminBillingRefundsPreviewPost200Response.js +67 -0
- package/dist/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.d.ts +51 -0
- package/dist/models/ApiV1AdminBillingRefundsPreviewPost200ResponseOrganizationPreview.js +55 -0
- package/dist/models/ApiV1AdminBillingRefundsPreviewPostRequest.d.ts +70 -0
- package/dist/models/ApiV1AdminBillingRefundsPreviewPostRequest.js +70 -0
- package/dist/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.d.ts +46 -0
- package/dist/models/ApiV1AdminBillingSubscriptionsSubjectIdCancelPostRequest.js +60 -0
- package/dist/models/ApiV1BillingPricingGet200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingPricingGet200Response.js +51 -0
- package/dist/models/ApiV1BillingPricingGet200ResponseData.d.ts +46 -0
- package/dist/models/ApiV1BillingPricingGet200ResponseData.js +54 -0
- package/dist/models/ApiV1BillingPricingGet200ResponseDataPlansInner.d.ts +68 -0
- package/dist/models/ApiV1BillingPricingGet200ResponseDataPlansInner.js +60 -0
- package/dist/models/ApiV1BillingPricingGet200ResponseDataTrial.d.ts +44 -0
- package/dist/models/ApiV1BillingPricingGet200ResponseDataTrial.js +52 -0
- package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200Response.js +51 -0
- package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.d.ts +33 -0
- package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseData.js +49 -0
- package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.d.ts +68 -0
- package/dist/models/ApiV1BillingUsersUserIdInvoicesGet200ResponseDataInvoicesInner.js +60 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200Response.js +51 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.d.ts +32 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDefaultPut200ResponseData.js +48 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200Response.js +51 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.d.ts +32 -0
- package/dist/models/ApiV1BillingUsersUserIdPaymentMethodsPaymentMethodIdDelete200ResponseData.js +48 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200Response.js +51 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.d.ts +32 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPost200ResponseData.js +48 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.d.ts +32 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionCancelPostRequest.js +48 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200Response.js +51 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.d.ts +120 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionGet200ResponseData.js +84 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200Response.js +51 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.d.ts +38 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPayPost200ResponseData.js +50 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.d.ts +39 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200Response.js +51 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.d.ts +38 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPost200ResponseData.js +50 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.d.ts +53 -0
- package/dist/models/ApiV1BillingUsersUserIdSubscriptionPostRequest.js +66 -0
- package/dist/models/ApiV1MetricsGet200Response.d.ts +39 -0
- package/dist/models/ApiV1MetricsGet200Response.js +51 -0
- package/dist/models/ApiV1MetricsGet200ResponseData.d.ts +56 -0
- package/dist/models/ApiV1MetricsGet200ResponseData.js +57 -0
- package/dist/models/ApiV1MetricsGet200ResponseDataErrorsValue.d.ts +44 -0
- package/dist/models/ApiV1MetricsGet200ResponseDataErrorsValue.js +52 -0
- package/dist/models/ApiV1MetricsGet200ResponseDataLatencyValue.d.ts +50 -0
- package/dist/models/ApiV1MetricsGet200ResponseDataLatencyValue.js +54 -0
- package/dist/models/ApiV1MetricsLatencyGet200Response.d.ts +41 -0
- package/dist/models/ApiV1MetricsLatencyGet200Response.js +52 -0
- package/dist/models/ApiV1MetricsLatencyGet200ResponseDataValue.d.ts +62 -0
- package/dist/models/ApiV1MetricsLatencyGet200ResponseDataValue.js +58 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.d.ts +71 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200Response.js +67 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.d.ts +51 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreview.js +55 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.d.ts +38 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPost200ResponseOrganizationPreviewSharesInner.js +50 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.d.ts +44 -0
- package/dist/models/ApiV1SubscriptionsIdRefundPreviewPostRequest.js +52 -0
- package/dist/models/CancelCurrentSubscription200Response.d.ts +45 -0
- package/dist/models/CancelCurrentSubscription200Response.js +53 -0
- package/dist/models/CancelCurrentSubscriptionRequest.d.ts +44 -0
- package/dist/models/CancelCurrentSubscriptionRequest.js +52 -0
- package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.d.ts +38 -0
- package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPost202Response.js +50 -0
- package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.d.ts +38 -0
- package/dist/models/CanvasesCanvasIdComponentsComponentIdPublishPostRequest.js +54 -0
- package/dist/models/ComponentManifest.d.ts +52 -0
- package/dist/models/ComponentManifest.js +56 -0
- package/dist/models/ComponentManifestAssets.d.ts +38 -0
- package/dist/models/ComponentManifestAssets.js +50 -0
- package/dist/models/ComponentManifestConfig.d.ts +44 -0
- package/dist/models/ComponentManifestConfig.js +52 -0
- package/dist/models/Composition.d.ts +6 -0
- package/dist/models/Composition.js +2 -0
- package/dist/models/CompositionEntryAggregateTally.d.ts +62 -0
- package/dist/models/CompositionEntryAggregateTally.js +58 -0
- package/dist/models/CompositionEntryAggregatesBlock.d.ts +45 -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 +60 -0
- package/dist/models/CompositionEntryItem.js +64 -0
- package/dist/models/CompositionEntryItemsMeta.d.ts +51 -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/CreateCheckoutSession200Response.d.ts +38 -0
- package/dist/models/CreateCheckoutSession200Response.js +50 -0
- package/dist/models/CreateCheckoutSessionRequest.d.ts +32 -0
- package/dist/models/CreateCheckoutSessionRequest.js +50 -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/DevelopmentPlan.d.ts +97 -0
- package/dist/models/DevelopmentPlan.js +77 -0
- package/dist/models/DevelopmentTask.d.ts +90 -0
- package/dist/models/DevelopmentTask.js +74 -0
- package/dist/models/EnterpriseCustomization.d.ts +125 -0
- package/dist/models/EnterpriseCustomization.js +85 -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/GenerateComponentWorkflowInput.d.ts +56 -0
- package/dist/models/GenerateComponentWorkflowInput.js +62 -0
- package/dist/models/GenerateMixedComponentInput.d.ts +62 -0
- package/dist/models/GenerateMixedComponentInput.js +66 -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/GetOrganizationStorageUsage200ResponseDataBreakdown.d.ts +44 -0
- package/dist/models/GetOrganizationStorageUsage200ResponseDataBreakdown.js +52 -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/ListComponents200Response.d.ts +33 -0
- package/dist/models/ListComponents200Response.js +49 -0
- package/dist/models/ListEnterpriseCustomizations200Response.d.ts +40 -0
- package/dist/models/ListEnterpriseCustomizations200Response.js +52 -0
- package/dist/models/ListEnterpriseCustomizations200ResponsePagination.d.ts +50 -0
- package/dist/models/ListEnterpriseCustomizations200ResponsePagination.js +54 -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 +72 -0
- package/dist/models/ManagedUserEntryItem.js +72 -0
- package/dist/models/MountRequest.d.ts +45 -0
- package/dist/models/MountRequest.js +55 -0
- package/dist/models/MountRequestTheme.d.ts +54 -0
- package/dist/models/MountRequestTheme.js +62 -0
- package/dist/models/MountRequestThemeColors.d.ts +50 -0
- package/dist/models/MountRequestThemeColors.js +54 -0
- package/dist/models/MountRequestThemeTypography.d.ts +38 -0
- package/dist/models/MountRequestThemeTypography.js +50 -0
- package/dist/models/MountResponse.d.ts +46 -0
- package/dist/models/MountResponse.js +58 -0
- package/dist/models/NewWidgetComponentsMetadataInner.d.ts +64 -0
- package/dist/models/NewWidgetComponentsMetadataInner.js +60 -0
- package/dist/models/NewWidgetComponentsMetadataInnerPosition.d.ts +38 -0
- package/dist/models/NewWidgetComponentsMetadataInnerPosition.js +50 -0
- package/dist/models/NewWidgetComponentsMetadataInnerSize.d.ts +38 -0
- package/dist/models/NewWidgetComponentsMetadataInnerSize.js +50 -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/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/PurchaseStoragePack200ResponseDataPaymentIntent.d.ts +50 -0
- package/dist/models/PurchaseStoragePack200ResponseDataPaymentIntent.js +54 -0
- package/dist/models/PurposeStorageBucket.d.ts +38 -0
- package/dist/models/PurposeStorageBucket.js +54 -0
- package/dist/models/RollbackComponentRequest.d.ts +38 -0
- package/dist/models/RollbackComponentRequest.js +52 -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/UIComponent.d.ts +65 -0
- package/dist/models/UIComponent.js +65 -0
- package/dist/models/UpdateCompositionRequest.d.ts +38 -0
- package/dist/models/UpdateCompositionRequest.js +50 -0
- package/dist/models/UpdateCurrentSubscriptionRequest.d.ts +38 -0
- package/dist/models/UpdateCurrentSubscriptionRequest.js +50 -0
- package/dist/models/UpdateEnterpriseCustomizationRequest.d.ts +95 -0
- package/dist/models/UpdateEnterpriseCustomizationRequest.js +75 -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/WorkflowAcceptedResponse.d.ts +38 -0
- package/dist/models/WorkflowAcceptedResponse.js +50 -0
- package/dist/models/index.d.ts +109 -2
- package/dist/models/index.js +109 -2
- 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/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
|
@@ -0,0 +1,1230 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Widgetic API Gateway
|
|
3
|
+
* API documentation for the Widgetic API Gateway
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
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';
|
|
14
|
+
export interface AddPersonalWorkspaceDomainRequest {
|
|
15
|
+
id: string;
|
|
16
|
+
addDomainRequest: AddDomainRequest;
|
|
17
|
+
}
|
|
18
|
+
export interface CopyPresetForManagedUserRequest {
|
|
19
|
+
id: string;
|
|
20
|
+
key: string;
|
|
21
|
+
idempotencyKey?: string;
|
|
22
|
+
copyPartnerPresetRequest?: CopyPartnerPresetRequest;
|
|
23
|
+
}
|
|
24
|
+
export interface CreateCompositionRequest {
|
|
25
|
+
newComposition: NewComposition;
|
|
26
|
+
idempotencyKey?: string;
|
|
27
|
+
}
|
|
28
|
+
export interface CreateCompositionContentItemOperationRequest {
|
|
29
|
+
id: string;
|
|
30
|
+
list: string;
|
|
31
|
+
createCompositionContentItemRequest: CreateCompositionContentItemRequest;
|
|
32
|
+
ifMatch?: string;
|
|
33
|
+
idempotencyKey?: string;
|
|
34
|
+
}
|
|
35
|
+
export interface CreateCompositionFromPresetOperationRequest {
|
|
36
|
+
id: string;
|
|
37
|
+
key: string;
|
|
38
|
+
createCompositionFromPresetRequest: CreateCompositionFromPresetRequest;
|
|
39
|
+
idempotencyKey?: string;
|
|
40
|
+
}
|
|
41
|
+
export interface CreateCompositionFromWidgetOperationRequest {
|
|
42
|
+
id: string;
|
|
43
|
+
createCompositionFromWidgetRequest: CreateCompositionFromWidgetRequest;
|
|
44
|
+
idempotencyKey?: string;
|
|
45
|
+
}
|
|
46
|
+
export interface CreateManagedUserRequest {
|
|
47
|
+
newManagedUser: NewManagedUser;
|
|
48
|
+
idempotencyKey?: string;
|
|
49
|
+
}
|
|
50
|
+
export interface CreateUserApiKeyOperationRequest {
|
|
51
|
+
id: string;
|
|
52
|
+
createUserApiKeyRequest: CreateUserApiKeyRequest;
|
|
53
|
+
idempotencyKey?: string;
|
|
54
|
+
}
|
|
55
|
+
export interface CreateWidgetRequest {
|
|
56
|
+
newWidget: NewWidget;
|
|
57
|
+
idempotencyKey?: string;
|
|
58
|
+
}
|
|
59
|
+
export interface DeleteCompositionRequest {
|
|
60
|
+
id: string;
|
|
61
|
+
}
|
|
62
|
+
export interface DeleteCompositionContentItemRequest {
|
|
63
|
+
id: string;
|
|
64
|
+
list: string;
|
|
65
|
+
itemId: string;
|
|
66
|
+
ifMatch?: string;
|
|
67
|
+
idempotencyKey?: string;
|
|
68
|
+
}
|
|
69
|
+
export interface DeleteCompositionDataSourceRequest {
|
|
70
|
+
id: string;
|
|
71
|
+
idempotencyKey?: string;
|
|
72
|
+
}
|
|
73
|
+
export interface DeleteCompositionEntryItemsRequest {
|
|
74
|
+
id: string;
|
|
75
|
+
table: string;
|
|
76
|
+
ids?: string;
|
|
77
|
+
context?: {
|
|
78
|
+
[key: string]: string;
|
|
79
|
+
};
|
|
80
|
+
filter?: {
|
|
81
|
+
[key: string]: string;
|
|
82
|
+
};
|
|
83
|
+
}
|
|
84
|
+
export interface DeleteManagedUserRequest {
|
|
85
|
+
id: string;
|
|
86
|
+
}
|
|
87
|
+
export interface DeletePersonalWorkspaceDomainRequest {
|
|
88
|
+
id: string;
|
|
89
|
+
domainId: string;
|
|
90
|
+
}
|
|
91
|
+
export interface DeleteUserApiKeyRequest {
|
|
92
|
+
id: string;
|
|
93
|
+
keyId: string;
|
|
94
|
+
}
|
|
95
|
+
export interface DescribeCompositionEntriesRequest {
|
|
96
|
+
id: string;
|
|
97
|
+
}
|
|
98
|
+
export interface DuplicateCompositionOperationRequest {
|
|
99
|
+
id: string;
|
|
100
|
+
idempotencyKey?: string;
|
|
101
|
+
duplicateCompositionRequest?: DuplicateCompositionRequest;
|
|
102
|
+
}
|
|
103
|
+
export interface ExportCompositionEntryItemsRequest {
|
|
104
|
+
id: string;
|
|
105
|
+
table: string;
|
|
106
|
+
format?: ExportCompositionEntryItemsFormatEnum;
|
|
107
|
+
order?: ExportCompositionEntryItemsOrderEnum;
|
|
108
|
+
since?: Date;
|
|
109
|
+
until?: Date;
|
|
110
|
+
context?: {
|
|
111
|
+
[key: string]: string;
|
|
112
|
+
};
|
|
113
|
+
filter?: {
|
|
114
|
+
[key: string]: string;
|
|
115
|
+
};
|
|
116
|
+
}
|
|
117
|
+
export interface GetAllCompositionsRequest {
|
|
118
|
+
page?: number;
|
|
119
|
+
size?: number;
|
|
120
|
+
sort?: string;
|
|
121
|
+
widgetId?: string;
|
|
122
|
+
workspace?: GetAllCompositionsWorkspaceEnum;
|
|
123
|
+
projectFolder?: string;
|
|
124
|
+
status?: GetAllCompositionsStatusEnum;
|
|
125
|
+
include?: string;
|
|
126
|
+
managedUserId?: string;
|
|
127
|
+
managedUserExternalId?: string;
|
|
128
|
+
}
|
|
129
|
+
export interface GetAllManagedUsersRequest {
|
|
130
|
+
page?: number;
|
|
131
|
+
size?: number;
|
|
132
|
+
sort?: string;
|
|
133
|
+
}
|
|
134
|
+
export interface GetCompositionByIdRequest {
|
|
135
|
+
id: string;
|
|
136
|
+
}
|
|
137
|
+
export interface GetCompositionContentRequest {
|
|
138
|
+
id: string;
|
|
139
|
+
}
|
|
140
|
+
export interface GetCompositionContentSchemaRequest {
|
|
141
|
+
id: string;
|
|
142
|
+
}
|
|
143
|
+
export interface GetCompositionDataSourceRequest {
|
|
144
|
+
id: string;
|
|
145
|
+
}
|
|
146
|
+
export interface GetCompositionDesignRequest {
|
|
147
|
+
id: string;
|
|
148
|
+
}
|
|
149
|
+
export interface GetCompositionDesignSchemaRequest {
|
|
150
|
+
id: string;
|
|
151
|
+
}
|
|
152
|
+
export interface GetCompositionEmbedSchemaRequest {
|
|
153
|
+
id: string;
|
|
154
|
+
}
|
|
155
|
+
export interface GetCompositionEmbedSettingsRequest {
|
|
156
|
+
id: string;
|
|
157
|
+
}
|
|
158
|
+
export interface GetInvoicesByPartnerIdRequest {
|
|
159
|
+
partnerId: string;
|
|
160
|
+
status?: GetInvoicesByPartnerIdStatusEnum;
|
|
161
|
+
limit?: number;
|
|
162
|
+
offset?: number;
|
|
163
|
+
}
|
|
164
|
+
export interface GetManagedUserByIdRequest {
|
|
165
|
+
id: string;
|
|
166
|
+
}
|
|
167
|
+
export interface GetManagedUserDesignDefaultsRequest {
|
|
168
|
+
id: string;
|
|
169
|
+
}
|
|
170
|
+
export interface GetManagedUserLimitsRequest {
|
|
171
|
+
id: string;
|
|
172
|
+
}
|
|
173
|
+
export interface GetManagedUserStorageUsageRequest {
|
|
174
|
+
id: string;
|
|
175
|
+
}
|
|
176
|
+
export interface GetManagedUsersByManagerIdRequest {
|
|
177
|
+
managerId: string;
|
|
178
|
+
page?: number;
|
|
179
|
+
size?: number;
|
|
180
|
+
sort?: string;
|
|
181
|
+
}
|
|
182
|
+
export interface GetPartnerBillingOverviewRequest {
|
|
183
|
+
partnerId: string;
|
|
184
|
+
}
|
|
185
|
+
export interface GetPartnerContractRequest {
|
|
186
|
+
partnerId: string;
|
|
187
|
+
}
|
|
188
|
+
export interface GetPartnerDesignDefaultsRequest {
|
|
189
|
+
partnerId: string;
|
|
190
|
+
}
|
|
191
|
+
export interface GetPartnerNotificationSettingsRequest {
|
|
192
|
+
partnerId: string;
|
|
193
|
+
}
|
|
194
|
+
export interface GetPartnerStorageDestinationRequest {
|
|
195
|
+
partnerId: string;
|
|
196
|
+
}
|
|
197
|
+
export interface GetPersonalWorkspaceDomainsRequest {
|
|
198
|
+
id: string;
|
|
199
|
+
}
|
|
200
|
+
export interface GetUserApiKeyUsageLogsRequest {
|
|
201
|
+
id: string;
|
|
202
|
+
keyId: string;
|
|
203
|
+
limit?: number;
|
|
204
|
+
}
|
|
205
|
+
export interface GetUserApiKeysRequest {
|
|
206
|
+
id: string;
|
|
207
|
+
}
|
|
208
|
+
export interface GetUserCreditBalanceRequest {
|
|
209
|
+
userId: string;
|
|
210
|
+
}
|
|
211
|
+
export interface GetUserCreditTransactionsRequest {
|
|
212
|
+
userId: string;
|
|
213
|
+
transactionType?: string;
|
|
214
|
+
limit?: number;
|
|
215
|
+
offset?: number;
|
|
216
|
+
}
|
|
217
|
+
export interface GetWidgetsRequest {
|
|
218
|
+
page?: number;
|
|
219
|
+
size?: number;
|
|
220
|
+
canvasId?: string;
|
|
221
|
+
managedUserId?: string;
|
|
222
|
+
managedUserExternalId?: string;
|
|
223
|
+
}
|
|
224
|
+
export interface ListCompositionEntryItemsRequest {
|
|
225
|
+
id: string;
|
|
226
|
+
table: string;
|
|
227
|
+
limit?: number;
|
|
228
|
+
order?: ListCompositionEntryItemsOrderEnum;
|
|
229
|
+
since?: Date;
|
|
230
|
+
until?: Date;
|
|
231
|
+
cursor?: string;
|
|
232
|
+
context?: {
|
|
233
|
+
[key: string]: string;
|
|
234
|
+
};
|
|
235
|
+
filter?: {
|
|
236
|
+
[key: string]: string;
|
|
237
|
+
};
|
|
238
|
+
}
|
|
239
|
+
export interface ListManagedUserEntriesRequest {
|
|
240
|
+
id: string;
|
|
241
|
+
compositionId?: string;
|
|
242
|
+
table?: string;
|
|
243
|
+
limit?: number;
|
|
244
|
+
order?: ListManagedUserEntriesOrderEnum;
|
|
245
|
+
since?: Date;
|
|
246
|
+
until?: Date;
|
|
247
|
+
cursor?: string;
|
|
248
|
+
context?: {
|
|
249
|
+
[key: string]: string;
|
|
250
|
+
};
|
|
251
|
+
filter?: {
|
|
252
|
+
[key: string]: string;
|
|
253
|
+
};
|
|
254
|
+
}
|
|
255
|
+
export interface ListPartnerNotificationDeliveriesRequest {
|
|
256
|
+
partnerId: string;
|
|
257
|
+
limit?: number;
|
|
258
|
+
}
|
|
259
|
+
export interface ListPartnerNotificationsRequest {
|
|
260
|
+
partnerId: string;
|
|
261
|
+
limit?: number;
|
|
262
|
+
before?: Date;
|
|
263
|
+
}
|
|
264
|
+
export interface ListPartnerPresetsRequest {
|
|
265
|
+
partnerId: string;
|
|
266
|
+
}
|
|
267
|
+
export interface OperationsIdGetRequest {
|
|
268
|
+
id: string;
|
|
269
|
+
}
|
|
270
|
+
export interface PatchCompositionContentItemRequest {
|
|
271
|
+
id: string;
|
|
272
|
+
list: string;
|
|
273
|
+
itemId: string;
|
|
274
|
+
requestBody: {
|
|
275
|
+
[key: string]: any;
|
|
276
|
+
};
|
|
277
|
+
ifMatch?: string;
|
|
278
|
+
idempotencyKey?: string;
|
|
279
|
+
}
|
|
280
|
+
export interface ReadCompositionEntriesRequest {
|
|
281
|
+
id: string;
|
|
282
|
+
table: string;
|
|
283
|
+
groupBy?: string;
|
|
284
|
+
rows?: number;
|
|
285
|
+
aggregate?: string;
|
|
286
|
+
column?: string;
|
|
287
|
+
since?: Date;
|
|
288
|
+
until?: Date;
|
|
289
|
+
context?: {
|
|
290
|
+
[key: string]: string;
|
|
291
|
+
};
|
|
292
|
+
filter?: {
|
|
293
|
+
[key: string]: string;
|
|
294
|
+
};
|
|
295
|
+
}
|
|
296
|
+
export interface RemovePartnerPresetRequest {
|
|
297
|
+
partnerId: string;
|
|
298
|
+
key: string;
|
|
299
|
+
}
|
|
300
|
+
export interface RemovePartnerStorageDestinationRequest {
|
|
301
|
+
partnerId: string;
|
|
302
|
+
}
|
|
303
|
+
export interface ReplayPartnerNotificationDeliveryRequest {
|
|
304
|
+
partnerId: string;
|
|
305
|
+
deliveryId: string;
|
|
306
|
+
idempotencyKey?: string;
|
|
307
|
+
}
|
|
308
|
+
export interface RotatePartnerWebhookSecretRequest {
|
|
309
|
+
partnerId: string;
|
|
310
|
+
idempotencyKey?: string;
|
|
311
|
+
}
|
|
312
|
+
export interface SetCompositionDataSourceOperationRequest {
|
|
313
|
+
id: string;
|
|
314
|
+
setCompositionDataSourceRequest: SetCompositionDataSourceRequest;
|
|
315
|
+
idempotencyKey?: string;
|
|
316
|
+
}
|
|
317
|
+
export interface SetDynamicContentOperationRequest {
|
|
318
|
+
id: string;
|
|
319
|
+
setDynamicContentRequest: SetDynamicContentRequest;
|
|
320
|
+
ifMatch?: string;
|
|
321
|
+
idempotencyKey?: string;
|
|
322
|
+
}
|
|
323
|
+
export interface SetManagedUserDesignDefaultsRequest {
|
|
324
|
+
id: string;
|
|
325
|
+
setPartnerDesignDefaultsRequest: SetPartnerDesignDefaultsRequest;
|
|
326
|
+
}
|
|
327
|
+
export interface SetManagedUserLimitsOperationRequest {
|
|
328
|
+
id: string;
|
|
329
|
+
setManagedUserLimitsRequest: SetManagedUserLimitsRequest;
|
|
330
|
+
}
|
|
331
|
+
export interface SetPartnerDesignDefaultsOperationRequest {
|
|
332
|
+
partnerId: string;
|
|
333
|
+
setPartnerDesignDefaultsRequest: SetPartnerDesignDefaultsRequest;
|
|
334
|
+
}
|
|
335
|
+
export interface SetPartnerPresetOperationRequest {
|
|
336
|
+
partnerId: string;
|
|
337
|
+
key: string;
|
|
338
|
+
setPartnerPresetRequest: SetPartnerPresetRequest;
|
|
339
|
+
}
|
|
340
|
+
export interface SetPartnerStorageDestinationOperationRequest {
|
|
341
|
+
partnerId: string;
|
|
342
|
+
setPartnerStorageDestinationRequest: SetPartnerStorageDestinationRequest;
|
|
343
|
+
}
|
|
344
|
+
export interface UpdateCompositionOperationRequest {
|
|
345
|
+
id: string;
|
|
346
|
+
updateComposition: UpdateComposition;
|
|
347
|
+
idempotencyKey?: string;
|
|
348
|
+
}
|
|
349
|
+
export interface UpdateManagedUserRequest {
|
|
350
|
+
id: string;
|
|
351
|
+
updateManagedUser: UpdateManagedUser;
|
|
352
|
+
idempotencyKey?: string;
|
|
353
|
+
}
|
|
354
|
+
export interface UpdatePartnerNotificationSettingsOperationRequest {
|
|
355
|
+
partnerId: string;
|
|
356
|
+
updatePartnerNotificationSettingsRequest: UpdatePartnerNotificationSettingsRequest;
|
|
357
|
+
idempotencyKey?: string;
|
|
358
|
+
}
|
|
359
|
+
export interface UpdatePersonalWorkspaceDomainRequest {
|
|
360
|
+
id: string;
|
|
361
|
+
domainId: string;
|
|
362
|
+
updateDomainRequest: UpdateDomainRequest;
|
|
363
|
+
}
|
|
364
|
+
export interface UpdateUserApiKeyOperationRequest {
|
|
365
|
+
id: string;
|
|
366
|
+
keyId: string;
|
|
367
|
+
updateUserApiKeyRequest: UpdateUserApiKeyRequest;
|
|
368
|
+
}
|
|
369
|
+
export interface UploadsGetRequest {
|
|
370
|
+
limit?: number;
|
|
371
|
+
managedUserId?: string;
|
|
372
|
+
managedUserExternalId?: string;
|
|
373
|
+
}
|
|
374
|
+
export interface UploadsIdDeleteRequest {
|
|
375
|
+
id: string;
|
|
376
|
+
}
|
|
377
|
+
export interface UploadsIdGetRequest {
|
|
378
|
+
id: string;
|
|
379
|
+
}
|
|
380
|
+
export interface UploadsPostRequest {
|
|
381
|
+
file: Blob;
|
|
382
|
+
contextType?: UploadsPostContextTypeEnum;
|
|
383
|
+
source?: UploadsPostSourceEnum;
|
|
384
|
+
managedUserId?: string;
|
|
385
|
+
managedUserExternalId?: string;
|
|
386
|
+
}
|
|
387
|
+
export interface VerifyPartnerStorageDestinationRequest {
|
|
388
|
+
partnerId: string;
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
*
|
|
392
|
+
*/
|
|
393
|
+
export declare class PartnerApi extends runtime.BaseAPI {
|
|
394
|
+
/**
|
|
395
|
+
* Adds a website to an account\'s own list. Give a website name such as `example.com`, or `*.example.com` for a website and all of its subdomains. A scheme, a port, a path, capital letters and a leading `www.` are dropped, so `https://www.Example.com/shop` is kept as `example.com`, and `example.com` covers `www.example.com` too. Something that is not a website name is refused, not stored. Until the first website is added nothing is restricted, and a widget can be shown anywhere. Once the list has one, a widget of the account is shown on the listed websites (and on Widgetic\'s own) and nowhere else. A page on your own machine (`localhost`, `127.0.0.1` or `[::1]`, on any port) is always allowed, so there is nothing to add to test locally. A change can take about 15 seconds to reach every server. The list is a safeguard against other websites showing your widgets in a visitor\'s browser. It is not access control: anyone who knows a widget\'s id can still fetch its published content with a plain request that names no website. An account can list at most 50 websites. Use `*.example.com` for a website and all of its subdomains instead of listing each one.
|
|
396
|
+
* Allow a website to show your widgets
|
|
397
|
+
*/
|
|
398
|
+
addPersonalWorkspaceDomainRaw(requestParameters: AddPersonalWorkspaceDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PersonalWorkspaceDomainResult>>;
|
|
399
|
+
/**
|
|
400
|
+
* Adds a website to an account\'s own list. Give a website name such as `example.com`, or `*.example.com` for a website and all of its subdomains. A scheme, a port, a path, capital letters and a leading `www.` are dropped, so `https://www.Example.com/shop` is kept as `example.com`, and `example.com` covers `www.example.com` too. Something that is not a website name is refused, not stored. Until the first website is added nothing is restricted, and a widget can be shown anywhere. Once the list has one, a widget of the account is shown on the listed websites (and on Widgetic\'s own) and nowhere else. A page on your own machine (`localhost`, `127.0.0.1` or `[::1]`, on any port) is always allowed, so there is nothing to add to test locally. A change can take about 15 seconds to reach every server. The list is a safeguard against other websites showing your widgets in a visitor\'s browser. It is not access control: anyone who knows a widget\'s id can still fetch its published content with a plain request that names no website. An account can list at most 50 websites. Use `*.example.com` for a website and all of its subdomains instead of listing each one.
|
|
401
|
+
* Allow a website to show your widgets
|
|
402
|
+
*/
|
|
403
|
+
addPersonalWorkspaceDomain(requestParameters: AddPersonalWorkspaceDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PersonalWorkspaceDomainResult>;
|
|
404
|
+
/**
|
|
405
|
+
* Copies the preset `key` (see `setPartnerPreset`) onto a new canvas for one of your managed users, so their widget creator opens on a widget of their own that starts from yours. The copy is a draft widget in your account, filed under the managed user: `getAllWidgets` with `managedUserId` lists it, and no other managed user\'s editor can reach it. The copy carries the preset\'s code, design and content schemas, and thumbnail, and starts from a fork of its code repository, so the user\'s chat edits begin where yours left off. It does not carry the preset\'s database or its compositions. It is not a preset itself, and changing or removing the preset afterwards never touches it. To start a composition (the content and design editor) instead, you do not need a copy: call `createComposition` with the preset\'s `widgetId` (from `listPartnerPresets`) and the managed user. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one copy is made, not two. A copy that could not be made leaves nothing behind (503 `PRESET_COPY_FAILED`). The managed user must be yours and active.
|
|
406
|
+
* Give a managed user a copy of one of your presets
|
|
407
|
+
*/
|
|
408
|
+
copyPresetForManagedUserRaw(requestParameters: CopyPresetForManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerPresetCopy>>;
|
|
409
|
+
/**
|
|
410
|
+
* Copies the preset `key` (see `setPartnerPreset`) onto a new canvas for one of your managed users, so their widget creator opens on a widget of their own that starts from yours. The copy is a draft widget in your account, filed under the managed user: `getAllWidgets` with `managedUserId` lists it, and no other managed user\'s editor can reach it. The copy carries the preset\'s code, design and content schemas, and thumbnail, and starts from a fork of its code repository, so the user\'s chat edits begin where yours left off. It does not carry the preset\'s database or its compositions. It is not a preset itself, and changing or removing the preset afterwards never touches it. To start a composition (the content and design editor) instead, you do not need a copy: call `createComposition` with the preset\'s `widgetId` (from `listPartnerPresets`) and the managed user. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one copy is made, not two. A copy that could not be made leaves nothing behind (503 `PRESET_COPY_FAILED`). The managed user must be yours and active.
|
|
411
|
+
* Give a managed user a copy of one of your presets
|
|
412
|
+
*/
|
|
413
|
+
copyPresetForManagedUser(requestParameters: CopyPresetForManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerPresetCopy>;
|
|
414
|
+
/**
|
|
415
|
+
* 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.
|
|
416
|
+
* Create Composition
|
|
417
|
+
*/
|
|
418
|
+
createCompositionRaw(requestParameters: CreateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
419
|
+
/**
|
|
420
|
+
* 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.
|
|
421
|
+
* Create Composition
|
|
422
|
+
*/
|
|
423
|
+
createComposition(requestParameters: CreateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
424
|
+
/**
|
|
425
|
+
* 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.
|
|
426
|
+
* Add a content list item
|
|
427
|
+
*/
|
|
428
|
+
createCompositionContentItemRaw(requestParameters: CreateCompositionContentItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
429
|
+
/**
|
|
430
|
+
* 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.
|
|
431
|
+
* Add a content list item
|
|
432
|
+
*/
|
|
433
|
+
createCompositionContentItem(requestParameters: CreateCompositionContentItemOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
434
|
+
/**
|
|
435
|
+
* Validates the name, optional content, design, embed settings and locale, then creates a draft composition filed under the managed user, built on the preset\'s widget, in a single insert. A failure never leaves a half-made composition. The preset\'s widget must be published. The managed user must be yours and active. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one composition is created, not two.
|
|
436
|
+
* Create a composition from one of your presets in one call
|
|
437
|
+
*/
|
|
438
|
+
createCompositionFromPresetRaw(requestParameters: CreateCompositionFromPresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
439
|
+
/**
|
|
440
|
+
* Validates the name, optional content, design, embed settings and locale, then creates a draft composition filed under the managed user, built on the preset\'s widget, in a single insert. A failure never leaves a half-made composition. The preset\'s widget must be published. The managed user must be yours and active. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one composition is created, not two.
|
|
441
|
+
* Create a composition from one of your presets in one call
|
|
442
|
+
*/
|
|
443
|
+
createCompositionFromPreset(requestParameters: CreateCompositionFromPresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
444
|
+
/**
|
|
445
|
+
* After a managed user publishes a widget from the creator, call this with the widget id, the customer\'s managed user (when the widget is not already filed under one), and optional content, design, embed settings and locale. Every input is validated before a single insert; a failure never leaves a half-made composition. When the widget is already tagged with a managed user, you may omit `managed_user_id`. When you send it, it must match that tag. The widget must be published. The `Idempotency-Key` header is required.
|
|
446
|
+
* Create a composition for a widget in one call
|
|
447
|
+
*/
|
|
448
|
+
createCompositionFromWidgetRaw(requestParameters: CreateCompositionFromWidgetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
449
|
+
/**
|
|
450
|
+
* After a managed user publishes a widget from the creator, call this with the widget id, the customer\'s managed user (when the widget is not already filed under one), and optional content, design, embed settings and locale. Every input is validated before a single insert; a failure never leaves a half-made composition. When the widget is already tagged with a managed user, you may omit `managed_user_id`. When you send it, it must match that tag. The widget must be published. The `Idempotency-Key` header is required.
|
|
451
|
+
* Create a composition for a widget in one call
|
|
452
|
+
*/
|
|
453
|
+
createCompositionFromWidget(requestParameters: CreateCompositionFromWidgetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
454
|
+
/**
|
|
455
|
+
* Creates a new managed user for a partner account. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one managed user is created, not two.
|
|
456
|
+
* Create Managed User
|
|
457
|
+
*/
|
|
458
|
+
createManagedUserRaw(requestParameters: CreateManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagedUser>>;
|
|
459
|
+
/**
|
|
460
|
+
* Creates a new managed user for a partner account. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one managed user is created, not two.
|
|
461
|
+
* Create Managed User
|
|
462
|
+
*/
|
|
463
|
+
createManagedUser(requestParameters: CreateManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagedUser>;
|
|
464
|
+
/**
|
|
465
|
+
* Makes a new API key for an account and returns its secret in `key`. That is the only time the secret is shown: Widgetic keeps a hash, so a key that was not stored cannot be recovered, only replaced. To rotate a key, make the new one, switch the integration over to it, then delete the old one. Only a person signed in on widgetic.com can make a key: a request made with an API key, or with an SDK token, is refused with 403. That way a leaked key cannot be used to make a second one that survives its revocation. Make keys from the dashboard; a key can still list, rename, switch off and delete keys. An `Idempotency-Key` header is required (8 to 50 characters: letters, digits, `-` and `_`). A retry with the same header and the same body returns the same answer instead of making a second key, and the same header with a different body is refused with 422. Make keys one at a time: two requests for the same account that run at the same moment can overwrite each other. A key can be limited to what it needs. Send a `preset` (`read_only`, `content` or `full_access`) or a list of `scopes`, never both. Send neither for a key that can do everything its owner can, as every key made before scopes existed. A limited key is refused with 403 and the code `API_KEY_SCOPE_MISSING` on anything outside its scopes, so a key held by a build server or by a partner\'s backend can be given only the part of the API it uses. The scopes of a key are fixed when it is made: to widen one, make a new key and delete the old one. A limited key cannot make, change or delete keys, exchange tokens or reach the administration routes. The list of scopes is in the `ApiKeyScope` schema. An account can hold at most 25 keys. An account on a plan without API access cannot make one.
|
|
466
|
+
* Create an API key
|
|
467
|
+
*/
|
|
468
|
+
createUserApiKeyRaw(requestParameters: CreateUserApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedUserApiKey>>;
|
|
469
|
+
/**
|
|
470
|
+
* Makes a new API key for an account and returns its secret in `key`. That is the only time the secret is shown: Widgetic keeps a hash, so a key that was not stored cannot be recovered, only replaced. To rotate a key, make the new one, switch the integration over to it, then delete the old one. Only a person signed in on widgetic.com can make a key: a request made with an API key, or with an SDK token, is refused with 403. That way a leaked key cannot be used to make a second one that survives its revocation. Make keys from the dashboard; a key can still list, rename, switch off and delete keys. An `Idempotency-Key` header is required (8 to 50 characters: letters, digits, `-` and `_`). A retry with the same header and the same body returns the same answer instead of making a second key, and the same header with a different body is refused with 422. Make keys one at a time: two requests for the same account that run at the same moment can overwrite each other. A key can be limited to what it needs. Send a `preset` (`read_only`, `content` or `full_access`) or a list of `scopes`, never both. Send neither for a key that can do everything its owner can, as every key made before scopes existed. A limited key is refused with 403 and the code `API_KEY_SCOPE_MISSING` on anything outside its scopes, so a key held by a build server or by a partner\'s backend can be given only the part of the API it uses. The scopes of a key are fixed when it is made: to widen one, make a new key and delete the old one. A limited key cannot make, change or delete keys, exchange tokens or reach the administration routes. The list of scopes is in the `ApiKeyScope` schema. An account can hold at most 25 keys. An account on a plan without API access cannot make one.
|
|
471
|
+
* Create an API key
|
|
472
|
+
*/
|
|
473
|
+
createUserApiKey(requestParameters: CreateUserApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedUserApiKey>;
|
|
474
|
+
/**
|
|
475
|
+
* Creates a widget for your account: a named record with a type and some starting content, on a canvas of its own (or one of yours that you name), with a database provisioned for it. It costs no credits and has no code yet; the code is generated for it afterwards. The new widget is yours, and you can list it with `getWidgets`. A widget is a draft until you say otherwise (`isDraft: false`). If the database cannot be provisioned the widget is still created, and `data.warnings` says what did not go through. Read it before relying on the widget. A widget can be placed on one of your canvases (`canvasId`), in a project you can edit (`projectId`) or in an organization where you may create widgets (`organizationId`). Naming anything you cannot use is refused with 403, and the answer is the same whether it exists or not. To make the widget for one of your managed users, send `managedUserId` or `managedUserExternalId`. The widget stays in your account and is yours to edit; the tag lets you list one user\'s widgets with `getWidgets`. 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. Creating a widget provisions its database, so this call has a limit of its own: 120 per minute for each account (ask Widgetic if you need more). Past that the call is answered with 429 and a `Retry-After`. The `Idempotency-Key` header is required; send the same key when you retry, so one widget is created, not two.
|
|
476
|
+
* Create Widget
|
|
477
|
+
*/
|
|
478
|
+
createWidgetRaw(requestParameters: CreateWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWidget201Response>>;
|
|
479
|
+
/**
|
|
480
|
+
* Creates a widget for your account: a named record with a type and some starting content, on a canvas of its own (or one of yours that you name), with a database provisioned for it. It costs no credits and has no code yet; the code is generated for it afterwards. The new widget is yours, and you can list it with `getWidgets`. A widget is a draft until you say otherwise (`isDraft: false`). If the database cannot be provisioned the widget is still created, and `data.warnings` says what did not go through. Read it before relying on the widget. A widget can be placed on one of your canvases (`canvasId`), in a project you can edit (`projectId`) or in an organization where you may create widgets (`organizationId`). Naming anything you cannot use is refused with 403, and the answer is the same whether it exists or not. To make the widget for one of your managed users, send `managedUserId` or `managedUserExternalId`. The widget stays in your account and is yours to edit; the tag lets you list one user\'s widgets with `getWidgets`. 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. Creating a widget provisions its database, so this call has a limit of its own: 120 per minute for each account (ask Widgetic if you need more). Past that the call is answered with 429 and a `Retry-After`. The `Idempotency-Key` header is required; send the same key when you retry, so one widget is created, not two.
|
|
481
|
+
* Create Widget
|
|
482
|
+
*/
|
|
483
|
+
createWidget(requestParameters: CreateWidgetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWidget201Response>;
|
|
484
|
+
/**
|
|
485
|
+
* Deletes a specific composition.
|
|
486
|
+
* Delete Composition
|
|
487
|
+
*/
|
|
488
|
+
deleteCompositionRaw(requestParameters: DeleteCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
489
|
+
/**
|
|
490
|
+
* Deletes a specific composition.
|
|
491
|
+
* Delete Composition
|
|
492
|
+
*/
|
|
493
|
+
deleteComposition(requestParameters: DeleteCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
494
|
+
/**
|
|
495
|
+
* Delete a content list item
|
|
496
|
+
*/
|
|
497
|
+
deleteCompositionContentItemRaw(requestParameters: DeleteCompositionContentItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteCompositionContentItem200Response>>;
|
|
498
|
+
/**
|
|
499
|
+
* Delete a content list item
|
|
500
|
+
*/
|
|
501
|
+
deleteCompositionContentItem(requestParameters: DeleteCompositionContentItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteCompositionContentItem200Response>;
|
|
502
|
+
/**
|
|
503
|
+
* Remove the composition data source binding
|
|
504
|
+
*/
|
|
505
|
+
deleteCompositionDataSourceRaw(requestParameters: DeleteCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
506
|
+
/**
|
|
507
|
+
* Remove the composition data source binding
|
|
508
|
+
*/
|
|
509
|
+
deleteCompositionDataSource(requestParameters: DeleteCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
510
|
+
/**
|
|
511
|
+
* Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
512
|
+
* Delete composition entry items by id or host context
|
|
513
|
+
*/
|
|
514
|
+
deleteCompositionEntryItemsRaw(requestParameters: DeleteCompositionEntryItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntryDeleteSuccess>>;
|
|
515
|
+
/**
|
|
516
|
+
* Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
517
|
+
* Delete composition entry items by id or host context
|
|
518
|
+
*/
|
|
519
|
+
deleteCompositionEntryItems(requestParameters: DeleteCompositionEntryItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntryDeleteSuccess>;
|
|
520
|
+
/**
|
|
521
|
+
* Deletes a managed user by ID. Its editor sessions end with it. What was filed under it (compositions, widgets, uploads) stays in your account, untagged.
|
|
522
|
+
* Delete Managed User
|
|
523
|
+
*/
|
|
524
|
+
deleteManagedUserRaw(requestParameters: DeleteManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
525
|
+
/**
|
|
526
|
+
* Deletes a managed user by ID. Its editor sessions end with it. What was filed under it (compositions, widgets, uploads) stays in your account, untagged.
|
|
527
|
+
* Delete Managed User
|
|
528
|
+
*/
|
|
529
|
+
deleteManagedUser(requestParameters: DeleteManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
530
|
+
/**
|
|
531
|
+
* Removes one entry from an account\'s own list. When it was the last one, nothing is restricted any more and a widget can be shown anywhere again. A change can take about 15 seconds to reach every server.
|
|
532
|
+
* Stop allowing a website to show your widgets
|
|
533
|
+
*/
|
|
534
|
+
deletePersonalWorkspaceDomainRaw(requestParameters: DeletePersonalWorkspaceDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeletePersonalWorkspaceDomain200Response>>;
|
|
535
|
+
/**
|
|
536
|
+
* Removes one entry from an account\'s own list. When it was the last one, nothing is restricted any more and a widget can be shown anywhere again. A change can take about 15 seconds to reach every server.
|
|
537
|
+
* Stop allowing a website to show your widgets
|
|
538
|
+
*/
|
|
539
|
+
deletePersonalWorkspaceDomain(requestParameters: DeletePersonalWorkspaceDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeletePersonalWorkspaceDomain200Response>;
|
|
540
|
+
/**
|
|
541
|
+
* Deletes a key and the record of what it was used for. The key stops working at once on the server that took the request and within a minute on the others, and cannot be brought back: make a new one instead. To stop a key without losing it, switch it off with `updateUserApiKey`.
|
|
542
|
+
* Delete an API key
|
|
543
|
+
*/
|
|
544
|
+
deleteUserApiKeyRaw(requestParameters: DeleteUserApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteUserApiKey200Response>>;
|
|
545
|
+
/**
|
|
546
|
+
* Deletes a key and the record of what it was used for. The key stops working at once on the server that took the request and within a minute on the others, and cannot be brought back: make a new one instead. To stop a key without losing it, switch it off with `updateUserApiKey`.
|
|
547
|
+
* Delete an API key
|
|
548
|
+
*/
|
|
549
|
+
deleteUserApiKey(requestParameters: DeleteUserApiKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteUserApiKey200Response>;
|
|
550
|
+
/**
|
|
551
|
+
* 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.
|
|
552
|
+
* Describe What a Composition Keeps
|
|
553
|
+
*/
|
|
554
|
+
describeCompositionEntriesRaw(requestParameters: DescribeCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesDescription>>;
|
|
555
|
+
/**
|
|
556
|
+
* 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.
|
|
557
|
+
* Describe What a Composition Keeps
|
|
558
|
+
*/
|
|
559
|
+
describeCompositionEntries(requestParameters: DescribeCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesDescription>;
|
|
560
|
+
/**
|
|
561
|
+
* 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.
|
|
562
|
+
* Duplicate Composition
|
|
563
|
+
*/
|
|
564
|
+
duplicateCompositionRaw(requestParameters: DuplicateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DuplicateComposition202Response>>;
|
|
565
|
+
/**
|
|
566
|
+
* 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.
|
|
567
|
+
* Duplicate Composition
|
|
568
|
+
*/
|
|
569
|
+
duplicateComposition(requestParameters: DuplicateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DuplicateComposition202Response>;
|
|
570
|
+
/**
|
|
571
|
+
* Streams up to 50,000 matching rows in batches of 1,000. Tables without cursor paging export at most one batch; when more rows exist the response sets `X-Widgetic-Export-Truncated: true`. Rate limit 20 requests per minute.
|
|
572
|
+
* Export composition entry items
|
|
573
|
+
*/
|
|
574
|
+
exportCompositionEntryItemsRaw(requestParameters: ExportCompositionEntryItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
|
|
575
|
+
/**
|
|
576
|
+
* Streams up to 50,000 matching rows in batches of 1,000. Tables without cursor paging export at most one batch; when more rows exist the response sets `X-Widgetic-Export-Truncated: true`. Rate limit 20 requests per minute.
|
|
577
|
+
* Export composition entry items
|
|
578
|
+
*/
|
|
579
|
+
exportCompositionEntryItems(requestParameters: ExportCompositionEntryItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
|
|
580
|
+
/**
|
|
581
|
+
* 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.
|
|
582
|
+
* Get All Compositions
|
|
583
|
+
*/
|
|
584
|
+
getAllCompositionsRaw(requestParameters: GetAllCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllCompositions200Response>>;
|
|
585
|
+
/**
|
|
586
|
+
* 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.
|
|
587
|
+
* Get All Compositions
|
|
588
|
+
*/
|
|
589
|
+
getAllCompositions(requestParameters?: GetAllCompositionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllCompositions200Response>;
|
|
590
|
+
/**
|
|
591
|
+
* Retrieve the managed users you manage, with pagination support. (Admins see every partner\'s managed users.)
|
|
592
|
+
* Get Managed Users
|
|
593
|
+
*/
|
|
594
|
+
getAllManagedUsersRaw(requestParameters: GetAllManagedUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetAllManagedUsers200Response>>;
|
|
595
|
+
/**
|
|
596
|
+
* Retrieve the managed users you manage, with pagination support. (Admins see every partner\'s managed users.)
|
|
597
|
+
* Get Managed Users
|
|
598
|
+
*/
|
|
599
|
+
getAllManagedUsers(requestParameters?: GetAllManagedUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAllManagedUsers200Response>;
|
|
600
|
+
/**
|
|
601
|
+
* Retrieves a specific composition by its ID.
|
|
602
|
+
* Get Composition
|
|
603
|
+
*/
|
|
604
|
+
getCompositionByIdRaw(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
605
|
+
/**
|
|
606
|
+
* Retrieves a specific composition by its ID.
|
|
607
|
+
* Get Composition
|
|
608
|
+
*/
|
|
609
|
+
getCompositionById(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
610
|
+
/**
|
|
611
|
+
* Retrieves the current content of a composition
|
|
612
|
+
* Get Current Content
|
|
613
|
+
*/
|
|
614
|
+
getCompositionContentRaw(requestParameters: GetCompositionContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
615
|
+
/**
|
|
616
|
+
* Retrieves the current content of a composition
|
|
617
|
+
* Get Current Content
|
|
618
|
+
*/
|
|
619
|
+
getCompositionContent(requestParameters: GetCompositionContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
620
|
+
/**
|
|
621
|
+
* Retrieves the content schema for a composition based on its widget type
|
|
622
|
+
* Get Content Schema
|
|
623
|
+
*/
|
|
624
|
+
getCompositionContentSchemaRaw(requestParameters: GetCompositionContentSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionContentSchema200Response>>;
|
|
625
|
+
/**
|
|
626
|
+
* Retrieves the content schema for a composition based on its widget type
|
|
627
|
+
* Get Content Schema
|
|
628
|
+
*/
|
|
629
|
+
getCompositionContentSchema(requestParameters: GetCompositionContentSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionContentSchema200Response>;
|
|
630
|
+
/**
|
|
631
|
+
* Read the composition data source binding
|
|
632
|
+
*/
|
|
633
|
+
getCompositionDataSourceRaw(requestParameters: GetCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
634
|
+
/**
|
|
635
|
+
* Read the composition data source binding
|
|
636
|
+
*/
|
|
637
|
+
getCompositionDataSource(requestParameters: GetCompositionDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
638
|
+
/**
|
|
639
|
+
* Retrieves only the design field from a composition.
|
|
640
|
+
* Get Composition Design
|
|
641
|
+
*/
|
|
642
|
+
getCompositionDesignRaw(requestParameters: GetCompositionDesignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
643
|
+
/**
|
|
644
|
+
* Retrieves only the design field from a composition.
|
|
645
|
+
* Get Composition Design
|
|
646
|
+
*/
|
|
647
|
+
getCompositionDesign(requestParameters: GetCompositionDesignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
648
|
+
/**
|
|
649
|
+
* Retrieves the design schema for a composition based on its widget type
|
|
650
|
+
* Get Design Schema
|
|
651
|
+
*/
|
|
652
|
+
getCompositionDesignSchemaRaw(requestParameters: GetCompositionDesignSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionDesignSchema200Response>>;
|
|
653
|
+
/**
|
|
654
|
+
* Retrieves the design schema for a composition based on its widget type
|
|
655
|
+
* Get Design Schema
|
|
656
|
+
*/
|
|
657
|
+
getCompositionDesignSchema(requestParameters: GetCompositionDesignSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionDesignSchema200Response>;
|
|
658
|
+
/**
|
|
659
|
+
* 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).
|
|
660
|
+
* Get Embed Schema
|
|
661
|
+
*/
|
|
662
|
+
getCompositionEmbedSchemaRaw(requestParameters: GetCompositionEmbedSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionEmbedSchema200Response>>;
|
|
663
|
+
/**
|
|
664
|
+
* 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).
|
|
665
|
+
* Get Embed Schema
|
|
666
|
+
*/
|
|
667
|
+
getCompositionEmbedSchema(requestParameters: GetCompositionEmbedSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionEmbedSchema200Response>;
|
|
668
|
+
/**
|
|
669
|
+
* Retrieves only the embedSettings field from a composition.
|
|
670
|
+
* Get Composition Embed Settings
|
|
671
|
+
*/
|
|
672
|
+
getCompositionEmbedSettingsRaw(requestParameters: GetCompositionEmbedSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
|
|
673
|
+
/**
|
|
674
|
+
* Retrieves only the embedSettings field from a composition.
|
|
675
|
+
* Get Composition Embed Settings
|
|
676
|
+
*/
|
|
677
|
+
getCompositionEmbedSettings(requestParameters: GetCompositionEmbedSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
|
|
678
|
+
/**
|
|
679
|
+
* Lists the invoices issued to a partner, newest first. Each carries the price (`subtotal`), the tax on it (`taxAmount`) and what is paid (`total`), its status as the payment provider reports it, why the last payment failed (`failureReason`), and the page where it is paid (`hostedInvoiceUrl`). A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s and see exactly what the partner sees; the full records, with the internal fields, are `getAllInvoices` filtered by partner. The page is always bounded: `limit` defaults to 50 and is capped at 100, `offset` defaults to 0.
|
|
680
|
+
* List a partner\'s invoices
|
|
681
|
+
*/
|
|
682
|
+
getInvoicesByPartnerIdRaw(requestParameters: GetInvoicesByPartnerIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetInvoicesByPartnerId200Response>>;
|
|
683
|
+
/**
|
|
684
|
+
* Lists the invoices issued to a partner, newest first. Each carries the price (`subtotal`), the tax on it (`taxAmount`) and what is paid (`total`), its status as the payment provider reports it, why the last payment failed (`failureReason`), and the page where it is paid (`hostedInvoiceUrl`). A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s and see exactly what the partner sees; the full records, with the internal fields, are `getAllInvoices` filtered by partner. The page is always bounded: `limit` defaults to 50 and is capped at 100, `offset` defaults to 0.
|
|
685
|
+
* List a partner\'s invoices
|
|
686
|
+
*/
|
|
687
|
+
getInvoicesByPartnerId(requestParameters: GetInvoicesByPartnerIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInvoicesByPartnerId200Response>;
|
|
688
|
+
/**
|
|
689
|
+
* Retrieves a specific managed user by ID.
|
|
690
|
+
* Get Managed User By ID
|
|
691
|
+
*/
|
|
692
|
+
getManagedUserByIdRaw(requestParameters: GetManagedUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagedUser>>;
|
|
693
|
+
/**
|
|
694
|
+
* Retrieves a specific managed user by ID.
|
|
695
|
+
* Get Managed User By ID
|
|
696
|
+
*/
|
|
697
|
+
getManagedUserById(requestParameters: GetManagedUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagedUser>;
|
|
698
|
+
/**
|
|
699
|
+
* Read design defaults for one managed user
|
|
700
|
+
*/
|
|
701
|
+
getManagedUserDesignDefaultsRaw(requestParameters: GetManagedUserDesignDefaultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPartnerDesignDefaults200Response>>;
|
|
702
|
+
/**
|
|
703
|
+
* Read design defaults for one managed user
|
|
704
|
+
*/
|
|
705
|
+
getManagedUserDesignDefaults(requestParameters: GetManagedUserDesignDefaultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPartnerDesignDefaults200Response>;
|
|
706
|
+
/**
|
|
707
|
+
* Read monthly credit cap and usage for one managed user
|
|
708
|
+
*/
|
|
709
|
+
getManagedUserLimitsRaw(requestParameters: GetManagedUserLimitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetManagedUserLimits200Response>>;
|
|
710
|
+
/**
|
|
711
|
+
* Read monthly credit cap and usage for one managed user
|
|
712
|
+
*/
|
|
713
|
+
getManagedUserLimits(requestParameters: GetManagedUserLimitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetManagedUserLimits200Response>;
|
|
714
|
+
/**
|
|
715
|
+
* Storage used by one managed user\'s uploads
|
|
716
|
+
*/
|
|
717
|
+
getManagedUserStorageUsageRaw(requestParameters: GetManagedUserStorageUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetManagedUserStorageUsage200Response>>;
|
|
718
|
+
/**
|
|
719
|
+
* Storage used by one managed user\'s uploads
|
|
720
|
+
*/
|
|
721
|
+
getManagedUserStorageUsage(requestParameters: GetManagedUserStorageUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetManagedUserStorageUsage200Response>;
|
|
722
|
+
/**
|
|
723
|
+
* Retrieve managed users for a specific manager with pagination support.
|
|
724
|
+
* Get Managed Users By Manager
|
|
725
|
+
*/
|
|
726
|
+
getManagedUsersByManagerIdRaw(requestParameters: GetManagedUsersByManagerIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetManagedUsersByManagerId200Response>>;
|
|
727
|
+
/**
|
|
728
|
+
* Retrieve managed users for a specific manager with pagination support.
|
|
729
|
+
* Get Managed Users By Manager
|
|
730
|
+
*/
|
|
731
|
+
getManagedUsersByManagerId(requestParameters: GetManagedUsersByManagerIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetManagedUsersByManagerId200Response>;
|
|
732
|
+
/**
|
|
733
|
+
* Retrieves operational credits, the partner\'s contract terms (`partnerCustomization`, the same fields as `getPartnerContract`) and billing integration status. Internal negotiation notes are not part of it.
|
|
734
|
+
* Get comprehensive partner billing overview
|
|
735
|
+
*/
|
|
736
|
+
getPartnerBillingOverviewRaw(requestParameters: GetPartnerBillingOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
737
|
+
/**
|
|
738
|
+
* Retrieves operational credits, the partner\'s contract terms (`partnerCustomization`, the same fields as `getPartnerContract`) and billing integration status. Internal negotiation notes are not part of it.
|
|
739
|
+
* Get comprehensive partner billing overview
|
|
740
|
+
*/
|
|
741
|
+
getPartnerBillingOverview(requestParameters: GetPartnerBillingOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
742
|
+
/**
|
|
743
|
+
* Returns the commercial terms agreed with the partner: price, included credits and storage, billing cycle, commitment, support level, and the dates the contract runs between. A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s. Responds 404 while no contract has been recorded for the partner, which is the case until Widgetic sets its terms.
|
|
744
|
+
* Get a partner\'s contract
|
|
745
|
+
*/
|
|
746
|
+
getPartnerContractRaw(requestParameters: GetPartnerContractRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerContract>>;
|
|
747
|
+
/**
|
|
748
|
+
* Returns the commercial terms agreed with the partner: price, included credits and storage, billing cycle, commitment, support level, and the dates the contract runs between. A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner\'s. Responds 404 while no contract has been recorded for the partner, which is the case until Widgetic sets its terms.
|
|
749
|
+
* Get a partner\'s contract
|
|
750
|
+
*/
|
|
751
|
+
getPartnerContract(requestParameters: GetPartnerContractRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerContract>;
|
|
752
|
+
/**
|
|
753
|
+
* Read partner-wide design defaults
|
|
754
|
+
*/
|
|
755
|
+
getPartnerDesignDefaultsRaw(requestParameters: GetPartnerDesignDefaultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPartnerDesignDefaults200Response>>;
|
|
756
|
+
/**
|
|
757
|
+
* Read partner-wide design defaults
|
|
758
|
+
*/
|
|
759
|
+
getPartnerDesignDefaults(requestParameters: GetPartnerDesignDefaultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPartnerDesignDefaults200Response>;
|
|
760
|
+
/**
|
|
761
|
+
* 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
|
+
* Where your notifications go
|
|
763
|
+
*/
|
|
764
|
+
getPartnerNotificationSettingsRaw(requestParameters: GetPartnerNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettings>>;
|
|
765
|
+
/**
|
|
766
|
+
* 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.
|
|
767
|
+
* Where your notifications go
|
|
768
|
+
*/
|
|
769
|
+
getPartnerNotificationSettings(requestParameters: GetPartnerNotificationSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettings>;
|
|
770
|
+
/**
|
|
771
|
+
* Returns the partner\'s storage destination without its secret: the endpoint, bucket, folder and public address, the last four characters of the access key id, when the destination last passed the check, and why the latest re-check failed if it did. Responds 404 while the partner has no destination, which means the partner cannot be activated, its uploads are refused, and no editor session is made for its customers until a destination is set. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
772
|
+
* Get where a partner\'s uploaded files are stored
|
|
773
|
+
*/
|
|
774
|
+
getPartnerStorageDestinationRaw(requestParameters: GetPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
|
|
775
|
+
/**
|
|
776
|
+
* Returns the partner\'s storage destination without its secret: the endpoint, bucket, folder and public address, the last four characters of the access key id, when the destination last passed the check, and why the latest re-check failed if it did. Responds 404 while the partner has no destination, which means the partner cannot be activated, its uploads are refused, and no editor session is made for its customers until a destination is set. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
777
|
+
* Get where a partner\'s uploaded files are stored
|
|
778
|
+
*/
|
|
779
|
+
getPartnerStorageDestination(requestParameters: GetPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
|
|
780
|
+
/**
|
|
781
|
+
* Lists the websites on an account\'s own list, newest first. It is the list Widgetic checks when a widget of the account is embedded: when it holds at least one website, the widget is shown on those websites (and on Widgetic\'s own) and nowhere else; when it is empty, the widget can be shown anywhere. If the account administers a partner, the websites set on the partner record by Widgetic are added to them. Widgets that belong to an organization use the organization\'s list instead.
|
|
782
|
+
* List the websites allowed to show your widgets
|
|
783
|
+
*/
|
|
784
|
+
getPersonalWorkspaceDomainsRaw(requestParameters: GetPersonalWorkspaceDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPersonalWorkspaceDomains200Response>>;
|
|
785
|
+
/**
|
|
786
|
+
* Lists the websites on an account\'s own list, newest first. It is the list Widgetic checks when a widget of the account is embedded: when it holds at least one website, the widget is shown on those websites (and on Widgetic\'s own) and nowhere else; when it is empty, the widget can be shown anywhere. If the account administers a partner, the websites set on the partner record by Widgetic are added to them. Widgets that belong to an organization use the organization\'s list instead.
|
|
787
|
+
* List the websites allowed to show your widgets
|
|
788
|
+
*/
|
|
789
|
+
getPersonalWorkspaceDomains(requestParameters: GetPersonalWorkspaceDomainsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPersonalWorkspaceDomains200Response>;
|
|
790
|
+
/**
|
|
791
|
+
* Lists the calls made with one key, newest first: when, which path and method, and the status each ended with. Use it to see whether a key is still in use before deleting it, or to see what a key that should not be in use has been doing.
|
|
792
|
+
* Read what an API key was used for
|
|
793
|
+
*/
|
|
794
|
+
getUserApiKeyUsageLogsRaw(requestParameters: GetUserApiKeyUsageLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserApiKeyUsageLogs200Response>>;
|
|
795
|
+
/**
|
|
796
|
+
* Lists the calls made with one key, newest first: when, which path and method, and the status each ended with. Use it to see whether a key is still in use before deleting it, or to see what a key that should not be in use has been doing.
|
|
797
|
+
* Read what an API key was used for
|
|
798
|
+
*/
|
|
799
|
+
getUserApiKeyUsageLogs(requestParameters: GetUserApiKeyUsageLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserApiKeyUsageLogs200Response>;
|
|
800
|
+
/**
|
|
801
|
+
* Lists the API keys of an account, in the order they were made: name, the first characters of the key, when it was made, when it expires, when it was last used, whether it is switched on and what it is limited to (`scopes` and `preset`). The secret of a key is never part of the list. A caller can list its own account\'s keys; Widgetic staff can list any account\'s.
|
|
802
|
+
* List the API keys of an account
|
|
803
|
+
*/
|
|
804
|
+
getUserApiKeysRaw(requestParameters: GetUserApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserApiKeys200Response>>;
|
|
805
|
+
/**
|
|
806
|
+
* Lists the API keys of an account, in the order they were made: name, the first characters of the key, when it was made, when it expires, when it was last used, whether it is switched on and what it is limited to (`scopes` and `preset`). The secret of a key is never part of the list. A caller can list its own account\'s keys; Widgetic staff can list any account\'s.
|
|
807
|
+
* List the API keys of an account
|
|
808
|
+
*/
|
|
809
|
+
getUserApiKeys(requestParameters: GetUserApiKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserApiKeys200Response>;
|
|
810
|
+
/**
|
|
811
|
+
* Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running. An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
|
|
812
|
+
* Get an account\'s credit balance
|
|
813
|
+
*/
|
|
814
|
+
getUserCreditBalanceRaw(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AccountCreditBalance>>;
|
|
815
|
+
/**
|
|
816
|
+
* Returns the credits an account holds: the balance, and how much of it is reserved by operations that are still running. An account reads its own balance; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. An account that has never held credits reads a balance of 0.
|
|
817
|
+
* Get an account\'s credit balance
|
|
818
|
+
*/
|
|
819
|
+
getUserCreditBalance(requestParameters: GetUserCreditBalanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AccountCreditBalance>;
|
|
820
|
+
/**
|
|
821
|
+
* Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added. An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`. The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
|
|
822
|
+
* List an account\'s credit ledger
|
|
823
|
+
*/
|
|
824
|
+
getUserCreditTransactionsRaw(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetUserCreditTransactions200Response>>;
|
|
825
|
+
/**
|
|
826
|
+
* Lists the entries of an account\'s credit ledger, newest first. This is also how an account\'s usage is read: every operation that spends credits is a `debit` entry, so summing the `debit` entries over a period gives the credits consumed in it, and the other types give what was added. An account reads its own ledger; with a partner\'s API key, that is the account of the person who administers the partner. Widgetic administrators can read any account\'s. A partner\'s wallet is a separate ledger, read with `getPartnerCreditTransactions`. The page is always bounded: `limit` defaults to 100 and is capped at 500, `offset` defaults to 0.
|
|
827
|
+
* List an account\'s credit ledger
|
|
828
|
+
*/
|
|
829
|
+
getUserCreditTransactions(requestParameters: GetUserCreditTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetUserCreditTransactions200Response>;
|
|
830
|
+
/**
|
|
831
|
+
* Lists the widgets your account owns, newest first. A widget is the reusable piece a composition is made from; this is your own library, not a catalogue of Widgetic\'s widgets. Pass `page` (counting from 1) and `size` (1 to 100, 20 when left out) to read the list one page at a time. `meta` then carries `total`, `hasNextPage` and `hasPreviousPage`, so a client can walk the list to its end. A page past the end is an empty list. Without `page` and `size` the call returns the whole list in one response, which only suits an account with a few widgets. Pass `canvasId` to list only the widgets on one of your canvases. That list is always returned whole, whatever `page` and `size` say. Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the widgets made for that managed user. The widgets of your other managed users, and your own, are left out. It combines with `page`, `size` and `canvasId`. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`.
|
|
832
|
+
* List Widgets
|
|
833
|
+
*/
|
|
834
|
+
getWidgetsRaw(requestParameters: GetWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetWidgets200Response>>;
|
|
835
|
+
/**
|
|
836
|
+
* Lists the widgets your account owns, newest first. A widget is the reusable piece a composition is made from; this is your own library, not a catalogue of Widgetic\'s widgets. Pass `page` (counting from 1) and `size` (1 to 100, 20 when left out) to read the list one page at a time. `meta` then carries `total`, `hasNextPage` and `hasPreviousPage`, so a client can walk the list to its end. A page past the end is an empty list. Without `page` and `size` the call returns the whole list in one response, which only suits an account with a few widgets. Pass `canvasId` to list only the widgets on one of your canvases. That list is always returned whole, whatever `page` and `size` say. Pass `managedUserId` (Widgetic\'s id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the widgets made for that managed user. The widgets of your other managed users, and your own, are left out. It combines with `page`, `size` and `canvasId`. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`.
|
|
837
|
+
* List Widgets
|
|
838
|
+
*/
|
|
839
|
+
getWidgets(requestParameters?: GetWidgetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetWidgets200Response>;
|
|
840
|
+
/**
|
|
841
|
+
* Reads one widget table with cursor paging (time then id in byte order), optional since/until on the time column, and up to five context filters plus ten column filters. Rate limit 120 requests per minute. Each read batch uses a 5 s statement timeout.
|
|
842
|
+
* List composition entry items with paging and filters
|
|
843
|
+
*/
|
|
844
|
+
listCompositionEntryItemsRaw(requestParameters: ListCompositionEntryItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntryItemsPageSuccess>>;
|
|
845
|
+
/**
|
|
846
|
+
* Reads one widget table with cursor paging (time then id in byte order), optional since/until on the time column, and up to five context filters plus ten column filters. Rate limit 120 requests per minute. Each read batch uses a 5 s statement timeout.
|
|
847
|
+
* List composition entry items with paging and filters
|
|
848
|
+
*/
|
|
849
|
+
listCompositionEntryItems(requestParameters: ListCompositionEntryItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntryItemsPageSuccess>;
|
|
850
|
+
/**
|
|
851
|
+
* Merges eligible tables (time and id columns) across the managed user\'s compositions in global time order, then compositionId, table, and id (byte order). Only tables with both a time and an id column take part. Rate limit 120 requests per minute.
|
|
852
|
+
* List entries across a managed user\'s compositions
|
|
853
|
+
*/
|
|
854
|
+
listManagedUserEntriesRaw(requestParameters: ListManagedUserEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagedUserEntriesPageSuccess>>;
|
|
855
|
+
/**
|
|
856
|
+
* Merges eligible tables (time and id columns) across the managed user\'s compositions in global time order, then compositionId, table, and id (byte order). Only tables with both a time and an id column take part. Rate limit 120 requests per minute.
|
|
857
|
+
* List entries across a managed user\'s compositions
|
|
858
|
+
*/
|
|
859
|
+
listManagedUserEntries(requestParameters: ListManagedUserEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagedUserEntriesPageSuccess>;
|
|
860
|
+
/**
|
|
861
|
+
* Lists the sends of your notifications, the newest first: each email to one address and each call to your webhook, with whether it was delivered, when it is tried again if not, how many attempts it had, and why the last one failed. Use it to find out why a webhook of yours did not receive an event. An email counts as delivered when it was handed to the mail service; a call to your webhook counts as delivered when your endpoint answered with a 2xx status. Anything else is tried again, after 1 minute, then 5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and a day, eight attempts in all, because your address is read again at each attempt and you may have mended it. Two answers end the delivery at once: `410 Gone` and `413 Payload Too Large`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
|
|
862
|
+
* How your notifications reached you
|
|
863
|
+
*/
|
|
864
|
+
listPartnerNotificationDeliveriesRaw(requestParameters: ListPartnerNotificationDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationDeliveryLog>>;
|
|
865
|
+
/**
|
|
866
|
+
* Lists the sends of your notifications, the newest first: each email to one address and each call to your webhook, with whether it was delivered, when it is tried again if not, how many attempts it had, and why the last one failed. Use it to find out why a webhook of yours did not receive an event. An email counts as delivered when it was handed to the mail service; a call to your webhook counts as delivered when your endpoint answered with a 2xx status. Anything else is tried again, after 1 minute, then 5 minutes, 30 minutes, 2 hours, 6 hours, 12 hours and a day, eight attempts in all, because your address is read again at each attempt and you may have mended it. Two answers end the delivery at once: `410 Gone` and `413 Payload Too Large`. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
|
|
867
|
+
* How your notifications reached you
|
|
868
|
+
*/
|
|
869
|
+
listPartnerNotificationDeliveries(requestParameters: ListPartnerNotificationDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationDeliveryLog>;
|
|
870
|
+
/**
|
|
871
|
+
* Lists the notifications of a partner, the newest first: the invoices Widgetic issued and their payments, the reminders to pay them, a warning when your credits run low, and the changes to the standing of the account (activated, paused, resumed). It is the same list your dashboard shows, and each entry is what your webhook receives as `data` when you have one (`updatePartnerNotificationSettings`). A page holds `limit` notifications (20 by default, at most 100). When there are older ones `nextBefore` is set: ask again with it as `before` to get the next page. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
|
|
872
|
+
* What your partner account was told
|
|
873
|
+
*/
|
|
874
|
+
listPartnerNotificationsRaw(requestParameters: ListPartnerNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationPage>>;
|
|
875
|
+
/**
|
|
876
|
+
* Lists the notifications of a partner, the newest first: the invoices Widgetic issued and their payments, the reminders to pay them, a warning when your credits run low, and the changes to the standing of the account (activated, paused, resumed). It is the same list your dashboard shows, and each entry is what your webhook receives as `data` when you have one (`updatePartnerNotificationSettings`). A page holds `limit` notifications (20 by default, at most 100). When there are older ones `nextBefore` is set: ask again with it as `before` to get the next page. The caller must be the person who administers the partner (an API key of that account works, with the `partner:read` scope), or a Widgetic administrator.
|
|
877
|
+
* What your partner account was told
|
|
878
|
+
*/
|
|
879
|
+
listPartnerNotifications(requestParameters: ListPartnerNotificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationPage>;
|
|
880
|
+
/**
|
|
881
|
+
* Returns the partner\'s presets, ordered by `position` and then by `key`: the widgets it offers its managed users as starting points. The list is the same for every managed user. Use a preset in one of two ways: - **Make a composition of it** (the content and design editor): call `createComposition` with the preset\'s `widgetId` and the managed user. The widget itself stays yours; a composition is the user\'s own content. - **Give the user a copy to build on** (the widget creator): call `copyPresetForManagedUser`. The user gets a widget and a canvas of their own. Presets are not the same as the widgets Widgetic puts on every new Widgetic account. Those are chosen by Widgetic and are copied at sign-up. A preset here is yours, and is copied only when you ask. The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator.
|
|
882
|
+
* List the widgets a partner offers as presets
|
|
883
|
+
*/
|
|
884
|
+
listPartnerPresetsRaw(requestParameters: ListPartnerPresetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListPartnerPresets200Response>>;
|
|
885
|
+
/**
|
|
886
|
+
* Returns the partner\'s presets, ordered by `position` and then by `key`: the widgets it offers its managed users as starting points. The list is the same for every managed user. Use a preset in one of two ways: - **Make a composition of it** (the content and design editor): call `createComposition` with the preset\'s `widgetId` and the managed user. The widget itself stays yours; a composition is the user\'s own content. - **Give the user a copy to build on** (the widget creator): call `copyPresetForManagedUser`. The user gets a widget and a canvas of their own. Presets are not the same as the widgets Widgetic puts on every new Widgetic account. Those are chosen by Widgetic and are copied at sign-up. A preset here is yours, and is copied only when you ask. The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator.
|
|
887
|
+
* List the widgets a partner offers as presets
|
|
888
|
+
*/
|
|
889
|
+
listPartnerPresets(requestParameters: ListPartnerPresetsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListPartnerPresets200Response>;
|
|
890
|
+
/**
|
|
891
|
+
* Follows work that carries on after the response that started it. Duplicating a composition, for one, answers 202 with an `operationId`: ask for that operation until its `status` is `completed` (or `failed`, with the reason in `error`). A finished duplication names the new composition in `metadata.newCompositionId`. An operation belongs to the user who started it. Asking for somebody else\'s operation answers 404, exactly as for one that does not exist. Administrators may read any operation.
|
|
892
|
+
* Get operation status
|
|
893
|
+
*/
|
|
894
|
+
operationsIdGetRaw(requestParameters: OperationsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OperationsIdGet200Response>>;
|
|
895
|
+
/**
|
|
896
|
+
* Follows work that carries on after the response that started it. Duplicating a composition, for one, answers 202 with an `operationId`: ask for that operation until its `status` is `completed` (or `failed`, with the reason in `error`). A finished duplication names the new composition in `metadata.newCompositionId`. An operation belongs to the user who started it. Asking for somebody else\'s operation answers 404, exactly as for one that does not exist. Administrators may read any operation.
|
|
897
|
+
* Get operation status
|
|
898
|
+
*/
|
|
899
|
+
operationsIdGet(requestParameters: OperationsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OperationsIdGet200Response>;
|
|
900
|
+
/**
|
|
901
|
+
* Update a content list item
|
|
902
|
+
*/
|
|
903
|
+
patchCompositionContentItemRaw(requestParameters: PatchCompositionContentItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
904
|
+
/**
|
|
905
|
+
* Update a content list item
|
|
906
|
+
*/
|
|
907
|
+
patchCompositionContentItem(requestParameters: PatchCompositionContentItemRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
908
|
+
/**
|
|
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.
|
|
910
|
+
* Read the Entries of a Composition\'s Table
|
|
911
|
+
*/
|
|
912
|
+
readCompositionEntriesRaw(requestParameters: ReadCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompositionEntriesReading>>;
|
|
913
|
+
/**
|
|
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.
|
|
915
|
+
* Read the Entries of a Composition\'s Table
|
|
916
|
+
*/
|
|
917
|
+
readCompositionEntries(requestParameters: ReadCompositionEntriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompositionEntriesReading>;
|
|
918
|
+
/**
|
|
919
|
+
* Removes the preset under `key`. The widget itself is not touched, and neither are the copies and the compositions already made from it. Removing a preset the partner does not have is not an error: the answer is `removed: false`.
|
|
920
|
+
* Take a widget off the partner\'s presets
|
|
921
|
+
*/
|
|
922
|
+
removePartnerPresetRaw(requestParameters: RemovePartnerPresetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerPresetRemoval>>;
|
|
923
|
+
/**
|
|
924
|
+
* Removes the preset under `key`. The widget itself is not touched, and neither are the copies and the compositions already made from it. Removing a preset the partner does not have is not an error: the answer is `removed: false`.
|
|
925
|
+
* Take a widget off the partner\'s presets
|
|
926
|
+
*/
|
|
927
|
+
removePartnerPreset(requestParameters: RemovePartnerPresetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerPresetRemoval>;
|
|
928
|
+
/**
|
|
929
|
+
* Removes the partner\'s storage destination. Partner storage is not optional, so after this the account\'s own uploads with its API key and the uploads of your customers\' editor sessions are refused (409 `PARTNER_STORAGE_REQUIRED`) until a destination is set again, and no editor session can be made. Files already in the partner\'s bucket are not touched and are not moved: they stay where they are, at the addresses they were given. Removing a destination the partner does not have is not an error: the answer is `removed: false`. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
930
|
+
* Stop storing a partner\'s uploaded files in its own bucket
|
|
931
|
+
*/
|
|
932
|
+
removePartnerStorageDestinationRaw(requestParameters: RemovePartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageRemoval>>;
|
|
933
|
+
/**
|
|
934
|
+
* Removes the partner\'s storage destination. Partner storage is not optional, so after this the account\'s own uploads with its API key and the uploads of your customers\' editor sessions are refused (409 `PARTNER_STORAGE_REQUIRED`) until a destination is set again, and no editor session can be made. Files already in the partner\'s bucket are not touched and are not moved: they stay where they are, at the addresses they were given. Removing a destination the partner does not have is not an error: the answer is `removed: false`. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
935
|
+
* Stop storing a partner\'s uploaded files in its own bucket
|
|
936
|
+
*/
|
|
937
|
+
removePartnerStorageDestination(requestParameters: RemovePartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageRemoval>;
|
|
938
|
+
/**
|
|
939
|
+
* Sends one earlier **webhook** delivery again to your **current** webhook address, with the same event `id` (`webhook-id`) as the original notification so a receiver that remembers ids can ignore a duplicate, and a new `createdAt` and signature made with your current secret. The attempt is recorded in the delivery log as a new row that points at the delivery you replayed. Set a webhook address (and secret) under notification settings before you replay. Changing the settings needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
940
|
+
* Send a webhook delivery again
|
|
941
|
+
*/
|
|
942
|
+
replayPartnerNotificationDeliveryRaw(requestParameters: ReplayPartnerNotificationDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationDelivery>>;
|
|
943
|
+
/**
|
|
944
|
+
* Sends one earlier **webhook** delivery again to your **current** webhook address, with the same event `id` (`webhook-id`) as the original notification so a receiver that remembers ids can ignore a duplicate, and a new `createdAt` and signature made with your current secret. The attempt is recorded in the delivery log as a new row that points at the delivery you replayed. Set a webhook address (and secret) under notification settings before you replay. Changing the settings needs an API key with full access. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
945
|
+
* Send a webhook delivery again
|
|
946
|
+
*/
|
|
947
|
+
replayPartnerNotificationDelivery(requestParameters: ReplayPartnerNotificationDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationDelivery>;
|
|
948
|
+
/**
|
|
949
|
+
* 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
|
+
* Make a new secret for your webhook
|
|
951
|
+
*/
|
|
952
|
+
rotatePartnerWebhookSecretRaw(requestParameters: RotatePartnerWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettingsChange>>;
|
|
953
|
+
/**
|
|
954
|
+
* 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.
|
|
955
|
+
* Make a new secret for your webhook
|
|
956
|
+
*/
|
|
957
|
+
rotatePartnerWebhookSecret(requestParameters: RotatePartnerWebhookSecretRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettingsChange>;
|
|
958
|
+
/**
|
|
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).
|
|
960
|
+
* Bind a public JSON data source for embed refresh
|
|
961
|
+
*/
|
|
962
|
+
setCompositionDataSourceRaw(requestParameters: SetCompositionDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
963
|
+
/**
|
|
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).
|
|
965
|
+
* Bind a public JSON data source for embed refresh
|
|
966
|
+
*/
|
|
967
|
+
setCompositionDataSource(requestParameters: SetCompositionDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
968
|
+
/**
|
|
969
|
+
* 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
|
+
* Set Dynamic Content
|
|
971
|
+
*/
|
|
972
|
+
setDynamicContentRaw(requestParameters: SetDynamicContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetDynamicContent200Response>>;
|
|
973
|
+
/**
|
|
974
|
+
* 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`.
|
|
975
|
+
* Set Dynamic Content
|
|
976
|
+
*/
|
|
977
|
+
setDynamicContent(requestParameters: SetDynamicContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetDynamicContent200Response>;
|
|
978
|
+
/**
|
|
979
|
+
* Send `{ \"design\": { ... } }` to store a JSON object (at most 64 KB, nesting depth 32), or `{ \"design\": null }` to remove the override. New compositions for this customer merge this layer over the partner default and under the request body.
|
|
980
|
+
* Set or clear design defaults for one managed user
|
|
981
|
+
*/
|
|
982
|
+
setManagedUserDesignDefaultsRaw(requestParameters: SetManagedUserDesignDefaultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
983
|
+
/**
|
|
984
|
+
* Send `{ \"design\": { ... } }` to store a JSON object (at most 64 KB, nesting depth 32), or `{ \"design\": null }` to remove the override. New compositions for this customer merge this layer over the partner default and under the request body.
|
|
985
|
+
* Set or clear design defaults for one managed user
|
|
986
|
+
*/
|
|
987
|
+
setManagedUserDesignDefaults(requestParameters: SetManagedUserDesignDefaultsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
988
|
+
/**
|
|
989
|
+
* Send monthly_credits as a whole number from 0 up to 2147483647 to cap what this customer\'s editor sessions may spend in a UTC calendar month, or null to remove the cap. The cap counts the credits the customer\'s sessions spent that month (refunded credits do not count) and applies to all of the customer\'s sessions together, beside any `max_credits` a single session was given. A cap of 0 stops all paid work by this customer until you raise it. The cap starts counting from the first of the month (UTC); a cap set below what was already spent this month stops further work at once.
|
|
990
|
+
* Set or clear the monthly credit cap for one managed user
|
|
991
|
+
*/
|
|
992
|
+
setManagedUserLimitsRaw(requestParameters: SetManagedUserLimitsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
993
|
+
/**
|
|
994
|
+
* Send monthly_credits as a whole number from 0 up to 2147483647 to cap what this customer\'s editor sessions may spend in a UTC calendar month, or null to remove the cap. The cap counts the credits the customer\'s sessions spent that month (refunded credits do not count) and applies to all of the customer\'s sessions together, beside any `max_credits` a single session was given. A cap of 0 stops all paid work by this customer until you raise it. The cap starts counting from the first of the month (UTC); a cap set below what was already spent this month stops further work at once.
|
|
995
|
+
* Set or clear the monthly credit cap for one managed user
|
|
996
|
+
*/
|
|
997
|
+
setManagedUserLimits(requestParameters: SetManagedUserLimitsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
998
|
+
/**
|
|
999
|
+
* Send `{ \"design\": { ... } }` or `{ \"design\": null }` to remove. New compositions merge this layer over the widget base and under each managed user\'s default and the request body.
|
|
1000
|
+
* Set or clear partner-wide design defaults
|
|
1001
|
+
*/
|
|
1002
|
+
setPartnerDesignDefaultsRaw(requestParameters: SetPartnerDesignDefaultsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1003
|
+
/**
|
|
1004
|
+
* Send `{ \"design\": { ... } }` or `{ \"design\": null }` to remove. New compositions merge this layer over the widget base and under each managed user\'s default and the request body.
|
|
1005
|
+
* Set or clear partner-wide design defaults
|
|
1006
|
+
*/
|
|
1007
|
+
setPartnerDesignDefaults(requestParameters: SetPartnerDesignDefaultsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1008
|
+
/**
|
|
1009
|
+
* Offers one of the partner\'s own widgets as a preset under `key`. If the partner already has a preset under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole preset: a `title`, `description` or `position` you leave out goes back to its default. Keys are 1 to 64 characters: lowercase letters, digits, hyphens and underscores, the first a letter or a digit (`rating`, `quiz-3`). The widget must belong to the partner\'s account; a widget that does not exist and one that belongs to somebody else are refused in the same way (404 `PRESET_WIDGET_NOT_FOUND`). A widget is a preset under at most one key (409 `PRESET_WIDGET_ALREADY_USED`; `details.key` says which), and an account can have at most 100 presets (409 `PRESET_LIMIT_REACHED`). Later changes to the widget reach new copies and new compositions; copies made earlier are not touched. Deleting the widget removes its preset.
|
|
1010
|
+
* Make a widget a preset, or replace a preset
|
|
1011
|
+
*/
|
|
1012
|
+
setPartnerPresetRaw(requestParameters: SetPartnerPresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerPreset>>;
|
|
1013
|
+
/**
|
|
1014
|
+
* Offers one of the partner\'s own widgets as a preset under `key`. If the partner already has a preset under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole preset: a `title`, `description` or `position` you leave out goes back to its default. Keys are 1 to 64 characters: lowercase letters, digits, hyphens and underscores, the first a letter or a digit (`rating`, `quiz-3`). The widget must belong to the partner\'s account; a widget that does not exist and one that belongs to somebody else are refused in the same way (404 `PRESET_WIDGET_NOT_FOUND`). A widget is a preset under at most one key (409 `PRESET_WIDGET_ALREADY_USED`; `details.key` says which), and an account can have at most 100 presets (409 `PRESET_LIMIT_REACHED`). Later changes to the widget reach new copies and new compositions; copies made earlier are not touched. Deleting the widget removes its preset.
|
|
1015
|
+
* Make a widget a preset, or replace a preset
|
|
1016
|
+
*/
|
|
1017
|
+
setPartnerPreset(requestParameters: SetPartnerPresetOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerPreset>;
|
|
1018
|
+
/**
|
|
1019
|
+
* Points the partner at a bucket of its own on an S3-compatible service (Amazon S3, Backblaze B2, Cloudflare R2, Wasabi, MinIO and the like). From then on, a file uploaded with `uploadsPost` by the account that administers the partner is stored in that bucket instead of with Widgetic. It takes none of the account\'s storage allowance, and its `url` is served from `public_base_url`. Only uploads sent with an API key, an SDK token or an editor session use the destination. Uploads from the Widgetic website, resumable uploads and the media library keep using Widgetic\'s storage. A destination is required. Partner storage is not optional: your customers\' files, and your own uploads with your API key, are kept in this destination and nowhere else. An editor session (`createManagedUserEditorSession`) of any surface cannot be made until a destination is set (409 `PARTNER_STORAGE_REQUIRED`), a destination removed later stops the uploads of the sessions already made (the same 409), and your own upload with no destination is refused in the same way instead of being stored with Widgetic. A partner cannot be activated until it has a destination that works. The destination is checked before it is saved. Widgetic writes a small test file under `<key_prefix>widgetic-check/`, reads it back from `<public_base_url>/<its key>`, and deletes it. If any step fails nothing is saved and the answer is 422 `STORAGE_DESTINATION_UNVERIFIED`: `details.step` says where (`endpoint`, `write` or `public_read`), `details.reason` says why, and `param` names the field most likely to be wrong. What the bucket needs: - an access key that may put objects into it (it may also delete objects, which lets the test file be cleaned up, but that is not required); - its files publicly readable at `public_base_url`, either because the bucket is public or through a CDN. The secret access key is stored encrypted and is never returned or logged; a response shows only the last four characters of the access key id (`accessKeyHint`). Saving replaces the whole destination, so send every field again, including the secret. Files already stored stay where they are, and keep working for as long as that bucket stays publicly readable. Once a destination is set, an upload is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 `STORAGE_DESTINATION_UNAVAILABLE`, and when the bucket rejects the file with 502 `STORAGE_DESTINATION_WRITE_FAILED`. The caller must be the person who administers the partner (an API key of that account works); anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can set any partner\'s.
|
|
1020
|
+
* Set where a partner\'s uploaded files are stored
|
|
1021
|
+
*/
|
|
1022
|
+
setPartnerStorageDestinationRaw(requestParameters: SetPartnerStorageDestinationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
|
|
1023
|
+
/**
|
|
1024
|
+
* Points the partner at a bucket of its own on an S3-compatible service (Amazon S3, Backblaze B2, Cloudflare R2, Wasabi, MinIO and the like). From then on, a file uploaded with `uploadsPost` by the account that administers the partner is stored in that bucket instead of with Widgetic. It takes none of the account\'s storage allowance, and its `url` is served from `public_base_url`. Only uploads sent with an API key, an SDK token or an editor session use the destination. Uploads from the Widgetic website, resumable uploads and the media library keep using Widgetic\'s storage. A destination is required. Partner storage is not optional: your customers\' files, and your own uploads with your API key, are kept in this destination and nowhere else. An editor session (`createManagedUserEditorSession`) of any surface cannot be made until a destination is set (409 `PARTNER_STORAGE_REQUIRED`), a destination removed later stops the uploads of the sessions already made (the same 409), and your own upload with no destination is refused in the same way instead of being stored with Widgetic. A partner cannot be activated until it has a destination that works. The destination is checked before it is saved. Widgetic writes a small test file under `<key_prefix>widgetic-check/`, reads it back from `<public_base_url>/<its key>`, and deletes it. If any step fails nothing is saved and the answer is 422 `STORAGE_DESTINATION_UNVERIFIED`: `details.step` says where (`endpoint`, `write` or `public_read`), `details.reason` says why, and `param` names the field most likely to be wrong. What the bucket needs: - an access key that may put objects into it (it may also delete objects, which lets the test file be cleaned up, but that is not required); - its files publicly readable at `public_base_url`, either because the bucket is public or through a CDN. The secret access key is stored encrypted and is never returned or logged; a response shows only the last four characters of the access key id (`accessKeyHint`). Saving replaces the whole destination, so send every field again, including the secret. Files already stored stay where they are, and keep working for as long as that bucket stays publicly readable. Once a destination is set, an upload is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 `STORAGE_DESTINATION_UNAVAILABLE`, and when the bucket rejects the file with 502 `STORAGE_DESTINATION_WRITE_FAILED`. The caller must be the person who administers the partner (an API key of that account works); anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can set any partner\'s.
|
|
1025
|
+
* Set where a partner\'s uploaded files are stored
|
|
1026
|
+
*/
|
|
1027
|
+
setPartnerStorageDestination(requestParameters: SetPartnerStorageDestinationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
|
|
1028
|
+
/**
|
|
1029
|
+
* 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
|
+
* Update Composition
|
|
1031
|
+
*/
|
|
1032
|
+
updateCompositionRaw(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateCompositionFromWidget201Response>>;
|
|
1033
|
+
/**
|
|
1034
|
+
* 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
|
+
* Update Composition
|
|
1036
|
+
*/
|
|
1037
|
+
updateComposition(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateCompositionFromWidget201Response>;
|
|
1038
|
+
/**
|
|
1039
|
+
* 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
|
+
* Update Managed User
|
|
1041
|
+
*/
|
|
1042
|
+
updateManagedUserRaw(requestParameters: UpdateManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ManagedUser>>;
|
|
1043
|
+
/**
|
|
1044
|
+
* 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).
|
|
1045
|
+
* Update Managed User
|
|
1046
|
+
*/
|
|
1047
|
+
updateManagedUser(requestParameters: UpdateManagedUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ManagedUser>;
|
|
1048
|
+
/**
|
|
1049
|
+
* 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
|
+
* Choose where your notifications go
|
|
1051
|
+
*/
|
|
1052
|
+
updatePartnerNotificationSettingsRaw(requestParameters: UpdatePartnerNotificationSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerNotificationSettingsChange>>;
|
|
1053
|
+
/**
|
|
1054
|
+
* 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.
|
|
1055
|
+
* Choose where your notifications go
|
|
1056
|
+
*/
|
|
1057
|
+
updatePartnerNotificationSettings(requestParameters: UpdatePartnerNotificationSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerNotificationSettingsChange>;
|
|
1058
|
+
/**
|
|
1059
|
+
* Replaces the website of one entry on an account\'s own list. The same rules apply as when adding one (`addPersonalWorkspaceDomain`): a website name such as `example.com` or `*.example.com`, kept in its cleaned form, and refused when it is not a website name or is already on the list.
|
|
1060
|
+
* Change a website on your list
|
|
1061
|
+
*/
|
|
1062
|
+
updatePersonalWorkspaceDomainRaw(requestParameters: UpdatePersonalWorkspaceDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PersonalWorkspaceDomainResult>>;
|
|
1063
|
+
/**
|
|
1064
|
+
* Replaces the website of one entry on an account\'s own list. The same rules apply as when adding one (`addPersonalWorkspaceDomain`): a website name such as `example.com` or `*.example.com`, kept in its cleaned form, and refused when it is not a website name or is already on the list.
|
|
1065
|
+
* Change a website on your list
|
|
1066
|
+
*/
|
|
1067
|
+
updatePersonalWorkspaceDomain(requestParameters: UpdatePersonalWorkspaceDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PersonalWorkspaceDomainResult>;
|
|
1068
|
+
/**
|
|
1069
|
+
* Renames a key, or switches it off (`isActive: false`) or back on. A key that is switched off is refused at once by the server that took the request and within a minute by the others, and can be switched on again; deleting is for a key that is not coming back. The secret, the expiry and the scopes of a key cannot be changed. Only a key with full access can make these requests: a key limited to some scopes is refused with 403 and the code `API_KEY_SCOPE_MISSING`. Renaming and switching off can be done with an API key. Switching a key on needs a person signed in on widgetic.com: a request that asks for it with an API key or an SDK token is refused with 403, so a leaked key cannot bring a dormant key back to life.
|
|
1070
|
+
* Rename an API key, or switch it off or on
|
|
1071
|
+
*/
|
|
1072
|
+
updateUserApiKeyRaw(requestParameters: UpdateUserApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserApiKey>>;
|
|
1073
|
+
/**
|
|
1074
|
+
* Renames a key, or switches it off (`isActive: false`) or back on. A key that is switched off is refused at once by the server that took the request and within a minute by the others, and can be switched on again; deleting is for a key that is not coming back. The secret, the expiry and the scopes of a key cannot be changed. Only a key with full access can make these requests: a key limited to some scopes is refused with 403 and the code `API_KEY_SCOPE_MISSING`. Renaming and switching off can be done with an API key. Switching a key on needs a person signed in on widgetic.com: a request that asks for it with an API key or an SDK token is refused with 403, so a leaked key cannot bring a dormant key back to life.
|
|
1075
|
+
* Rename an API key, or switch it off or on
|
|
1076
|
+
*/
|
|
1077
|
+
updateUserApiKey(requestParameters: UpdateUserApiKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserApiKey>;
|
|
1078
|
+
/**
|
|
1079
|
+
* The files the account has uploaded, newest first. Deleted files are not listed. Returns at most `limit` files and has no further pages: a client that needs more narrows the list instead, for example to one managed user\'s files with `managed_user_id` or `managed_user_external_id`.
|
|
1080
|
+
* List the account\'s uploads
|
|
1081
|
+
*/
|
|
1082
|
+
uploadsGetRaw(requestParameters: UploadsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadsGet200Response>>;
|
|
1083
|
+
/**
|
|
1084
|
+
* The files the account has uploaded, newest first. Deleted files are not listed. Returns at most `limit` files and has no further pages: a client that needs more narrows the list instead, for example to one managed user\'s files with `managed_user_id` or `managed_user_external_id`.
|
|
1085
|
+
* List the account\'s uploads
|
|
1086
|
+
*/
|
|
1087
|
+
uploadsGet(requestParameters?: UploadsGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadsGet200Response>;
|
|
1088
|
+
/**
|
|
1089
|
+
* Removes the stored file and the upload row. A file in Widgetic\'s own storage gives back the space it took from your storage allowance; a file in your own bucket is removed from your bucket. Deleting an upload that is already gone succeeds the same way as the first delete. An upload that belongs to another account is not found. If the storage cannot be reached the call fails and nothing is marked deleted, so it can be repeated.
|
|
1090
|
+
* Delete an upload
|
|
1091
|
+
*/
|
|
1092
|
+
uploadsIdDeleteRaw(requestParameters: UploadsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadsIdDelete200Response>>;
|
|
1093
|
+
/**
|
|
1094
|
+
* Removes the stored file and the upload row. A file in Widgetic\'s own storage gives back the space it took from your storage allowance; a file in your own bucket is removed from your bucket. Deleting an upload that is already gone succeeds the same way as the first delete. An upload that belongs to another account is not found. If the storage cannot be reached the call fails and nothing is marked deleted, so it can be repeated.
|
|
1095
|
+
* Delete an upload
|
|
1096
|
+
*/
|
|
1097
|
+
uploadsIdDelete(requestParameters: UploadsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadsIdDelete200Response>;
|
|
1098
|
+
/**
|
|
1099
|
+
* The details of one of the account\'s uploads. An upload that belongs to another account is not found.
|
|
1100
|
+
* Get an upload by id
|
|
1101
|
+
*/
|
|
1102
|
+
uploadsIdGetRaw(requestParameters: UploadsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Upload>>;
|
|
1103
|
+
/**
|
|
1104
|
+
* The details of one of the account\'s uploads. An upload that belongs to another account is not found.
|
|
1105
|
+
* Get an upload by id
|
|
1106
|
+
*/
|
|
1107
|
+
uploadsIdGet(requestParameters: UploadsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Upload>;
|
|
1108
|
+
/**
|
|
1109
|
+
* The size limit and the accepted file types of the upload endpoints. Read them from here rather than hard-coding thresholds: they are configuration and can change. The limits are the same for every account, whatever its plan: `multipart_max_bytes` for a file sent in one request (10 MB) and `tus_max_bytes` for a resumable upload (250 MB).
|
|
1110
|
+
* Upload size limits and accepted file types
|
|
1111
|
+
*/
|
|
1112
|
+
uploadsLimitsGetRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UploadLimits>>;
|
|
1113
|
+
/**
|
|
1114
|
+
* The size limit and the accepted file types of the upload endpoints. Read them from here rather than hard-coding thresholds: they are configuration and can change. The limits are the same for every account, whatever its plan: `multipart_max_bytes` for a file sent in one request (10 MB) and `tus_max_bytes` for a resumable upload (250 MB).
|
|
1115
|
+
* Upload size limits and accepted file types
|
|
1116
|
+
*/
|
|
1117
|
+
uploadsLimitsGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadLimits>;
|
|
1118
|
+
/**
|
|
1119
|
+
* Stores one file for the account and returns its public address. This is how a user\'s own images, video and PDFs reach a widget\'s content. Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the account\'s storage allowance, and a full allowance is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `uploadsLimitsGet` lists the size limit and the accepted types. To upload the file for one of your managed users, send `managed_user_id` (Widgetic\'s id for the user) or `managed_user_external_id` (your own identifier for the user), not both. The file stays in your account and counts against its allowance; the tag lets you list one user\'s files with `uploadsGet`. The managed user must be yours and active: one that is not yours, or does not exist, is refused with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`, before the file is stored. The tag is set here and does not change afterwards. Called with an editor session (`createManagedUserEditorSession`), the file is always filed for the session\'s own managed user and is always media for widget content: naming another managed user is refused with 403 and `MANAGED_USER_SESSION_MISMATCH`, and `context_type`, `source`, `widget_id` and `conversation_id` are ignored. A full storage allowance is refused with the same 413 and `QUOTA_STORAGE_EXCEEDED`, but the message only says that it is not available right now (not how much is stored: that is the partner\'s business) and `error.details.limit` is `storage`. An account that administers a partner with a storage destination (`setPartnerStorageDestination`) has its files stored in the partner\'s own bucket instead. Such a file takes none of the allowance, its `url` is served from the partner\'s public address, and its `storage_key` is the key in the partner\'s bucket. The file is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 and `STORAGE_DESTINATION_UNAVAILABLE`, and when the partner\'s storage rejects the file with 502 and `STORAGE_DESTINATION_WRITE_FAILED`. Partner storage is not optional. A partner\'s own uploads (with its API key) and the uploads of its customers\' editor sessions are kept in the partner\'s own storage or not at all, so a partner with no destination (or one that removed it after the session was made) has them refused with 409 and `PARTNER_STORAGE_REQUIRED`; they are never stored with Widgetic. An editor session\'s browser is only told that the feature is not available right now.
|
|
1120
|
+
* Upload a file
|
|
1121
|
+
*/
|
|
1122
|
+
uploadsPostRaw(requestParameters: UploadsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Upload>>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Stores one file for the account and returns its public address. This is how a user\'s own images, video and PDFs reach a widget\'s content. Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the account\'s storage allowance, and a full allowance is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `uploadsLimitsGet` lists the size limit and the accepted types. To upload the file for one of your managed users, send `managed_user_id` (Widgetic\'s id for the user) or `managed_user_external_id` (your own identifier for the user), not both. The file stays in your account and counts against its allowance; the tag lets you list one user\'s files with `uploadsGet`. The managed user must be yours and active: one that is not yours, or does not exist, is refused with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`, before the file is stored. The tag is set here and does not change afterwards. Called with an editor session (`createManagedUserEditorSession`), the file is always filed for the session\'s own managed user and is always media for widget content: naming another managed user is refused with 403 and `MANAGED_USER_SESSION_MISMATCH`, and `context_type`, `source`, `widget_id` and `conversation_id` are ignored. A full storage allowance is refused with the same 413 and `QUOTA_STORAGE_EXCEEDED`, but the message only says that it is not available right now (not how much is stored: that is the partner\'s business) and `error.details.limit` is `storage`. An account that administers a partner with a storage destination (`setPartnerStorageDestination`) has its files stored in the partner\'s own bucket instead. Such a file takes none of the allowance, its `url` is served from the partner\'s public address, and its `storage_key` is the key in the partner\'s bucket. The file is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 and `STORAGE_DESTINATION_UNAVAILABLE`, and when the partner\'s storage rejects the file with 502 and `STORAGE_DESTINATION_WRITE_FAILED`. Partner storage is not optional. A partner\'s own uploads (with its API key) and the uploads of its customers\' editor sessions are kept in the partner\'s own storage or not at all, so a partner with no destination (or one that removed it after the session was made) has them refused with 409 and `PARTNER_STORAGE_REQUIRED`; they are never stored with Widgetic. An editor session\'s browser is only told that the feature is not available right now.
|
|
1125
|
+
* Upload a file
|
|
1126
|
+
*/
|
|
1127
|
+
uploadsPost(requestParameters: UploadsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Upload>;
|
|
1128
|
+
/**
|
|
1129
|
+
* Validate current authentication token
|
|
1130
|
+
*/
|
|
1131
|
+
validateTokenRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValidateToken200Response>>;
|
|
1132
|
+
/**
|
|
1133
|
+
* Validate current authentication token
|
|
1134
|
+
*/
|
|
1135
|
+
validateToken(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValidateToken200Response>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Runs the same check as `setPartnerStorageDestination` against the destination already saved: a test file is written, read back from the public address and deleted. Use it after rotating a key or changing a bucket policy, or when uploads are failing with 502 or 503. The result is recorded either way. A pass refreshes `verifiedAt` and clears `lastVerificationError`; a failure answers 422 `STORAGE_DESTINATION_UNVERIFIED` and is recorded in `lastVerificationError` and `lastVerificationFailedAt`, so the destination shows what went wrong the next time it is read. A failed check does not remove the destination or stop uploads from using it. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
1138
|
+
* Check that a partner\'s storage destination still works
|
|
1139
|
+
*/
|
|
1140
|
+
verifyPartnerStorageDestinationRaw(requestParameters: VerifyPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerStorageDestination>>;
|
|
1141
|
+
/**
|
|
1142
|
+
* Runs the same check as `setPartnerStorageDestination` against the destination already saved: a test file is written, read back from the public address and deleted. Use it after rotating a key or changing a bucket policy, or when uploads are failing with 502 or 503. The result is recorded either way. A pass refreshes `verifiedAt` and clears `lastVerificationError`; a failure answers 422 `STORAGE_DESTINATION_UNVERIFIED` and is recorded in `lastVerificationError` and `lastVerificationFailedAt`, so the destination shows what went wrong the next time it is read. A failed check does not remove the destination or stop uploads from using it. The caller must be the person who administers the partner, or a Widgetic administrator.
|
|
1143
|
+
* Check that a partner\'s storage destination still works
|
|
1144
|
+
*/
|
|
1145
|
+
verifyPartnerStorageDestination(requestParameters: VerifyPartnerStorageDestinationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerStorageDestination>;
|
|
1146
|
+
}
|
|
1147
|
+
/**
|
|
1148
|
+
* @export
|
|
1149
|
+
*/
|
|
1150
|
+
export declare const ExportCompositionEntryItemsFormatEnum: {
|
|
1151
|
+
readonly Csv: "csv";
|
|
1152
|
+
readonly Json: "json";
|
|
1153
|
+
};
|
|
1154
|
+
export type ExportCompositionEntryItemsFormatEnum = typeof ExportCompositionEntryItemsFormatEnum[keyof typeof ExportCompositionEntryItemsFormatEnum];
|
|
1155
|
+
/**
|
|
1156
|
+
* @export
|
|
1157
|
+
*/
|
|
1158
|
+
export declare const ExportCompositionEntryItemsOrderEnum: {
|
|
1159
|
+
readonly Asc: "asc";
|
|
1160
|
+
readonly Desc: "desc";
|
|
1161
|
+
};
|
|
1162
|
+
export type ExportCompositionEntryItemsOrderEnum = typeof ExportCompositionEntryItemsOrderEnum[keyof typeof ExportCompositionEntryItemsOrderEnum];
|
|
1163
|
+
/**
|
|
1164
|
+
* @export
|
|
1165
|
+
*/
|
|
1166
|
+
export declare const GetAllCompositionsWorkspaceEnum: {
|
|
1167
|
+
readonly True: "true";
|
|
1168
|
+
readonly False: "false";
|
|
1169
|
+
};
|
|
1170
|
+
export type GetAllCompositionsWorkspaceEnum = typeof GetAllCompositionsWorkspaceEnum[keyof typeof GetAllCompositionsWorkspaceEnum];
|
|
1171
|
+
/**
|
|
1172
|
+
* @export
|
|
1173
|
+
*/
|
|
1174
|
+
export declare const GetAllCompositionsStatusEnum: {
|
|
1175
|
+
readonly Draft: "draft";
|
|
1176
|
+
readonly Published: "published";
|
|
1177
|
+
readonly Archived: "archived";
|
|
1178
|
+
};
|
|
1179
|
+
export type GetAllCompositionsStatusEnum = typeof GetAllCompositionsStatusEnum[keyof typeof GetAllCompositionsStatusEnum];
|
|
1180
|
+
/**
|
|
1181
|
+
* @export
|
|
1182
|
+
*/
|
|
1183
|
+
export declare const GetInvoicesByPartnerIdStatusEnum: {
|
|
1184
|
+
readonly Draft: "draft";
|
|
1185
|
+
readonly Open: "open";
|
|
1186
|
+
readonly Pending: "pending";
|
|
1187
|
+
readonly Paid: "paid";
|
|
1188
|
+
readonly Failed: "failed";
|
|
1189
|
+
readonly Void: "void";
|
|
1190
|
+
readonly Uncollectible: "uncollectible";
|
|
1191
|
+
readonly Refunded: "refunded";
|
|
1192
|
+
readonly Canceled: "canceled";
|
|
1193
|
+
};
|
|
1194
|
+
export type GetInvoicesByPartnerIdStatusEnum = typeof GetInvoicesByPartnerIdStatusEnum[keyof typeof GetInvoicesByPartnerIdStatusEnum];
|
|
1195
|
+
/**
|
|
1196
|
+
* @export
|
|
1197
|
+
*/
|
|
1198
|
+
export declare const ListCompositionEntryItemsOrderEnum: {
|
|
1199
|
+
readonly Asc: "asc";
|
|
1200
|
+
readonly Desc: "desc";
|
|
1201
|
+
};
|
|
1202
|
+
export type ListCompositionEntryItemsOrderEnum = typeof ListCompositionEntryItemsOrderEnum[keyof typeof ListCompositionEntryItemsOrderEnum];
|
|
1203
|
+
/**
|
|
1204
|
+
* @export
|
|
1205
|
+
*/
|
|
1206
|
+
export declare const ListManagedUserEntriesOrderEnum: {
|
|
1207
|
+
readonly Asc: "asc";
|
|
1208
|
+
readonly Desc: "desc";
|
|
1209
|
+
};
|
|
1210
|
+
export type ListManagedUserEntriesOrderEnum = typeof ListManagedUserEntriesOrderEnum[keyof typeof ListManagedUserEntriesOrderEnum];
|
|
1211
|
+
/**
|
|
1212
|
+
* @export
|
|
1213
|
+
*/
|
|
1214
|
+
export declare const UploadsPostContextTypeEnum: {
|
|
1215
|
+
readonly WidgetCodegen: "widget-codegen";
|
|
1216
|
+
readonly BrowserIc: "browser-ic";
|
|
1217
|
+
readonly ContentProperty: "content-property";
|
|
1218
|
+
};
|
|
1219
|
+
export type UploadsPostContextTypeEnum = typeof UploadsPostContextTypeEnum[keyof typeof UploadsPostContextTypeEnum];
|
|
1220
|
+
/**
|
|
1221
|
+
* @export
|
|
1222
|
+
*/
|
|
1223
|
+
export declare const UploadsPostSourceEnum: {
|
|
1224
|
+
readonly ChatUpload: "chat-upload";
|
|
1225
|
+
readonly ChatScreenshot: "chat-screenshot";
|
|
1226
|
+
readonly BrowserIcScreenshot: "browser-ic-screenshot";
|
|
1227
|
+
readonly PreviewScreenshot: "preview-screenshot";
|
|
1228
|
+
readonly FileBrowserUpload: "file-browser-upload";
|
|
1229
|
+
};
|
|
1230
|
+
export type UploadsPostSourceEnum = typeof UploadsPostSourceEnum[keyof typeof UploadsPostSourceEnum];
|