@widgetic/api-sdk 1.0.32 → 1.0.34
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/README.md +4 -0
- package/dist/apis/AdminApi.d.ts +30 -46
- package/dist/apis/AdminApi.js +53 -102
- package/dist/apis/AdminBillingApi.d.ts +2 -2
- package/dist/apis/AdminBillingApi.js +2 -2
- package/dist/apis/AgentRepositoryManagementApi.d.ts +32 -0
- package/dist/apis/AgentRepositoryManagementApi.js +75 -0
- package/dist/apis/BillingApi.d.ts +44 -1
- package/dist/apis/BillingApi.js +127 -0
- package/dist/apis/CompositionsApi.d.ts +2 -2
- package/dist/apis/CompositionsApi.js +2 -2
- package/dist/apis/CreditsApi.d.ts +7 -7
- package/dist/apis/CreditsApi.js +5 -5
- package/dist/apis/EnterpriseCustomizationsApi.d.ts +87 -0
- package/dist/apis/EnterpriseCustomizationsApi.js +233 -0
- package/dist/apis/OrganizationsApi.d.ts +35 -7
- package/dist/apis/OrganizationsApi.js +86 -6
- package/dist/apis/PartnerApi.d.ts +65 -21
- package/dist/apis/PartnerApi.js +147 -19
- package/dist/apis/PartnerCustomizationsApi.d.ts +4 -4
- package/dist/apis/PartnerCustomizationsApi.js +4 -4
- package/dist/apis/PartnersApi.d.ts +28 -67
- package/dist/apis/PartnersApi.js +31 -119
- package/dist/apis/PublicEmbedApi.d.ts +4 -4
- package/dist/apis/PublicEmbedApi.js +4 -4
- package/dist/apis/SubscriptionsApi.d.ts +2 -2
- package/dist/apis/SubscriptionsApi.js +2 -2
- package/dist/apis/UIComponentsApi.d.ts +96 -0
- package/dist/apis/UIComponentsApi.js +209 -0
- package/dist/apis/UploadsApi.d.ts +4 -4
- package/dist/apis/UploadsApi.js +4 -4
- package/dist/apis/UsersApi.d.ts +4 -4
- package/dist/apis/UsersApi.js +4 -4
- package/dist/apis/WorkflowsApi.d.ts +44 -0
- package/dist/apis/WorkflowsApi.js +111 -0
- package/dist/esm/apis/AdminApi.d.ts +30 -46
- package/dist/esm/apis/AdminApi.js +54 -103
- package/dist/esm/apis/AdminBillingApi.d.ts +2 -2
- package/dist/esm/apis/AdminBillingApi.js +2 -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 +44 -1
- package/dist/esm/apis/BillingApi.js +128 -1
- package/dist/esm/apis/CompositionsApi.d.ts +2 -2
- package/dist/esm/apis/CompositionsApi.js +2 -2
- package/dist/esm/apis/CreditsApi.d.ts +7 -7
- package/dist/esm/apis/CreditsApi.js +6 -6
- package/dist/esm/apis/EnterpriseCustomizationsApi.d.ts +87 -0
- package/dist/esm/apis/EnterpriseCustomizationsApi.js +229 -0
- package/dist/esm/apis/OrganizationsApi.d.ts +35 -7
- package/dist/esm/apis/OrganizationsApi.js +87 -7
- package/dist/esm/apis/PartnerApi.d.ts +65 -21
- package/dist/esm/apis/PartnerApi.js +148 -20
- package/dist/esm/apis/PartnerCustomizationsApi.d.ts +4 -4
- package/dist/esm/apis/PartnerCustomizationsApi.js +4 -4
- package/dist/esm/apis/PartnersApi.d.ts +28 -67
- package/dist/esm/apis/PartnersApi.js +31 -119
- package/dist/esm/apis/PublicEmbedApi.d.ts +4 -4
- package/dist/esm/apis/PublicEmbedApi.js +4 -4
- package/dist/esm/apis/SubscriptionsApi.d.ts +2 -2
- package/dist/esm/apis/SubscriptionsApi.js +2 -2
- package/dist/esm/apis/UIComponentsApi.d.ts +96 -0
- package/dist/esm/apis/UIComponentsApi.js +205 -0
- package/dist/esm/apis/UploadsApi.d.ts +4 -4
- package/dist/esm/apis/UploadsApi.js +4 -4
- package/dist/esm/apis/UsersApi.d.ts +4 -4
- package/dist/esm/apis/UsersApi.js +4 -4
- package/dist/esm/apis/WorkflowsApi.d.ts +44 -0
- package/dist/esm/apis/WorkflowsApi.js +107 -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/BillingUsersUserIdStorageCancelPackPostRequest.d.ts +40 -0
- package/dist/esm/models/BillingUsersUserIdStorageCancelPackPostRequest.js +43 -0
- package/dist/esm/models/BillingUsersUserIdStorageGet200Response.d.ts +39 -0
- package/dist/esm/models/BillingUsersUserIdStorageGet200Response.js +44 -0
- package/dist/esm/models/BillingUsersUserIdStorageGet200ResponseData.d.ts +33 -0
- package/dist/esm/models/BillingUsersUserIdStorageGet200ResponseData.js +42 -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/ConvertSoloToTeams200Response.d.ts +39 -0
- package/dist/esm/models/ConvertSoloToTeams200Response.js +44 -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/CreateComposition201Response.d.ts +39 -0
- package/dist/esm/models/CreateComposition201Response.js +44 -0
- package/dist/esm/models/CreatePartnerRequest.d.ts +7 -0
- package/dist/esm/models/CreatePartnerRequest.js +2 -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/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/GetOrganizationPricing200ResponseDataStorage.d.ts +3 -2
- package/dist/esm/models/GetOrganizationStorageUsage200ResponseDataBreakdown.d.ts +44 -0
- package/dist/esm/models/GetOrganizationStorageUsage200ResponseDataBreakdown.js +45 -0
- package/dist/esm/models/GetOrganizationStorageUsage200ResponseDataStorageUsage.d.ts +5 -5
- package/dist/esm/models/GetPartnerCreditTransactions200Response.d.ts +39 -0
- package/dist/esm/models/GetPartnerCreditTransactions200Response.js +44 -0
- package/dist/esm/models/IssuePartnerInvoiceRequest.d.ts +14 -1
- package/dist/esm/models/IssuePartnerInvoiceRequest.js +2 -0
- package/dist/esm/models/IssuedPartnerInvoice.d.ts +6 -0
- package/dist/esm/models/IssuedPartnerInvoice.js +4 -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/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/MyPartner.d.ts +7 -0
- package/dist/esm/models/MyPartner.js +4 -0
- package/dist/esm/models/MyPartners.d.ts +9 -1
- package/dist/esm/models/MyPartners.js +6 -1
- 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/OrganizationsOrgIdBillingGet200ResponseData.d.ts +25 -5
- package/dist/esm/models/OrganizationsOrgIdBillingGet200ResponseData.js +9 -0
- package/dist/esm/models/Partner.d.ts +7 -0
- package/dist/esm/models/Partner.js +2 -0
- package/dist/esm/models/PartnerActivation.d.ts +1 -1
- package/dist/esm/models/PartnerBillingOverviewOperationalCredits.d.ts +0 -14
- package/dist/esm/models/PartnerBillingOverviewOperationalCredits.js +0 -4
- package/dist/esm/models/PartnerBillingProfile.d.ts +1 -1
- package/dist/esm/models/PartnerContract.d.ts +15 -3
- package/dist/esm/models/PartnerContract.js +6 -2
- package/dist/esm/models/PartnerCustomization.d.ts +15 -3
- package/dist/esm/models/PartnerCustomization.js +6 -2
- package/dist/esm/models/PartnerDetails.d.ts +7 -0
- package/dist/esm/models/PartnerDetails.js +2 -0
- package/dist/esm/models/PartnerExtraCreditsInvoice.d.ts +98 -0
- package/dist/esm/models/PartnerExtraCreditsInvoice.js +87 -0
- package/dist/esm/models/PartnerInvoiceSchedule.d.ts +66 -0
- package/dist/esm/models/PartnerInvoiceSchedule.js +67 -0
- package/dist/esm/models/PartnerInvoiceScheduleContract.d.ts +68 -0
- package/dist/esm/models/PartnerInvoiceScheduleContract.js +67 -0
- package/dist/esm/models/PartnerInvoiceScheduleNext.d.ts +94 -0
- package/dist/esm/models/PartnerInvoiceScheduleNext.js +91 -0
- package/dist/esm/models/PartnerInvoiceScheduleNextPeriod.d.ts +38 -0
- package/dist/esm/models/PartnerInvoiceScheduleNextPeriod.js +47 -0
- package/dist/esm/models/PartnerInvoiceScheduleOverdue.d.ts +38 -0
- package/dist/esm/models/PartnerInvoiceScheduleOverdue.js +47 -0
- package/dist/esm/models/PartnerInvoiceSchedulePeriod.d.ts +101 -0
- package/dist/esm/models/PartnerInvoiceSchedulePeriod.js +91 -0
- package/dist/esm/models/PartnerNotification.d.ts +1 -1
- package/dist/esm/models/PartnerNotificationEventType.d.ts +2 -0
- package/dist/esm/models/PartnerNotificationEventType.js +2 -0
- package/dist/esm/models/PartnerUpdateResult.d.ts +8 -16
- package/dist/esm/models/PartnerUpdateResult.js +2 -5
- package/dist/esm/models/PartnerWithWarnings.d.ts +7 -0
- package/dist/esm/models/PartnerWithWarnings.js +2 -0
- package/dist/esm/models/PersonalExtraStorage.d.ts +92 -0
- package/dist/esm/models/PersonalExtraStorage.js +83 -0
- package/dist/esm/models/PersonalExtraStorageBlock.d.ts +56 -0
- package/dist/esm/models/PersonalExtraStorageBlock.js +57 -0
- package/dist/esm/models/PersonalStorage.d.ts +80 -0
- package/dist/esm/models/PersonalStorage.js +73 -0
- package/dist/esm/models/PersonalStoragePack.d.ts +100 -0
- package/dist/esm/models/PersonalStoragePack.js +84 -0
- package/dist/esm/models/PurchaseStoragePack200ResponseDataPaymentIntent.d.ts +50 -0
- package/dist/esm/models/PurchaseStoragePack200ResponseDataPaymentIntent.js +47 -0
- package/dist/esm/models/RequestExtraCredits.d.ts +33 -0
- package/dist/esm/models/RequestExtraCredits.js +43 -0
- package/dist/esm/models/RollbackComponentRequest.d.ts +38 -0
- package/dist/esm/models/RollbackComponentRequest.js +45 -0
- package/dist/esm/models/StorageChange.d.ts +4 -3
- package/dist/esm/models/SurfaceConversionResult.d.ts +85 -0
- package/dist/esm/models/SurfaceConversionResult.js +76 -0
- package/dist/esm/models/SurfaceConversionResultSubscription.d.ts +82 -0
- package/dist/esm/models/SurfaceConversionResultSubscription.js +62 -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/UpdatePartnerCustomizationRequest.d.ts +3 -3
- package/dist/esm/models/UpdatePartnerCustomizationRequest.js +2 -2
- package/dist/esm/models/UpdatePartnerRequest.d.ts +7 -24
- package/dist/esm/models/UpdatePartnerRequest.js +2 -8
- package/dist/esm/models/WorkflowAcceptedResponse.d.ts +38 -0
- package/dist/esm/models/WorkflowAcceptedResponse.js +43 -0
- package/dist/esm/models/index.d.ts +19 -9
- package/dist/esm/models/index.js +19 -9
- 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/BillingUsersUserIdStorageCancelPackPostRequest.d.ts +40 -0
- package/dist/models/BillingUsersUserIdStorageCancelPackPostRequest.js +50 -0
- package/dist/models/BillingUsersUserIdStorageGet200Response.d.ts +39 -0
- package/dist/models/BillingUsersUserIdStorageGet200Response.js +51 -0
- package/dist/models/BillingUsersUserIdStorageGet200ResponseData.d.ts +33 -0
- package/dist/models/BillingUsersUserIdStorageGet200ResponseData.js +49 -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/ConvertSoloToTeams200Response.d.ts +39 -0
- package/dist/models/ConvertSoloToTeams200Response.js +51 -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/CreateComposition201Response.d.ts +39 -0
- package/dist/models/CreateComposition201Response.js +51 -0
- package/dist/models/CreatePartnerRequest.d.ts +7 -0
- package/dist/models/CreatePartnerRequest.js +2 -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/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/GetOrganizationPricing200ResponseDataStorage.d.ts +3 -2
- package/dist/models/GetOrganizationStorageUsage200ResponseDataBreakdown.d.ts +44 -0
- package/dist/models/GetOrganizationStorageUsage200ResponseDataBreakdown.js +52 -0
- package/dist/models/GetOrganizationStorageUsage200ResponseDataStorageUsage.d.ts +5 -5
- package/dist/models/GetPartnerCreditTransactions200Response.d.ts +39 -0
- package/dist/models/GetPartnerCreditTransactions200Response.js +51 -0
- package/dist/models/IssuePartnerInvoiceRequest.d.ts +14 -1
- package/dist/models/IssuePartnerInvoiceRequest.js +2 -0
- package/dist/models/IssuedPartnerInvoice.d.ts +6 -0
- package/dist/models/IssuedPartnerInvoice.js +4 -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/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/MyPartner.d.ts +7 -0
- package/dist/models/MyPartner.js +4 -0
- package/dist/models/MyPartners.d.ts +9 -1
- package/dist/models/MyPartners.js +6 -1
- 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/OrganizationsOrgIdBillingGet200ResponseData.d.ts +25 -5
- package/dist/models/OrganizationsOrgIdBillingGet200ResponseData.js +10 -0
- package/dist/models/Partner.d.ts +7 -0
- package/dist/models/Partner.js +2 -0
- package/dist/models/PartnerActivation.d.ts +1 -1
- package/dist/models/PartnerBillingOverviewOperationalCredits.d.ts +0 -14
- package/dist/models/PartnerBillingOverviewOperationalCredits.js +0 -4
- package/dist/models/PartnerBillingProfile.d.ts +1 -1
- package/dist/models/PartnerContract.d.ts +15 -3
- package/dist/models/PartnerContract.js +6 -2
- package/dist/models/PartnerCustomization.d.ts +15 -3
- package/dist/models/PartnerCustomization.js +6 -2
- package/dist/models/PartnerDetails.d.ts +7 -0
- package/dist/models/PartnerDetails.js +2 -0
- package/dist/models/PartnerExtraCreditsInvoice.d.ts +98 -0
- package/dist/models/PartnerExtraCreditsInvoice.js +94 -0
- package/dist/models/PartnerInvoiceSchedule.d.ts +66 -0
- package/dist/models/PartnerInvoiceSchedule.js +74 -0
- package/dist/models/PartnerInvoiceScheduleContract.d.ts +68 -0
- package/dist/models/PartnerInvoiceScheduleContract.js +74 -0
- package/dist/models/PartnerInvoiceScheduleNext.d.ts +94 -0
- package/dist/models/PartnerInvoiceScheduleNext.js +99 -0
- package/dist/models/PartnerInvoiceScheduleNextPeriod.d.ts +38 -0
- package/dist/models/PartnerInvoiceScheduleNextPeriod.js +54 -0
- package/dist/models/PartnerInvoiceScheduleOverdue.d.ts +38 -0
- package/dist/models/PartnerInvoiceScheduleOverdue.js +54 -0
- package/dist/models/PartnerInvoiceSchedulePeriod.d.ts +101 -0
- package/dist/models/PartnerInvoiceSchedulePeriod.js +99 -0
- package/dist/models/PartnerNotification.d.ts +1 -1
- package/dist/models/PartnerNotificationEventType.d.ts +2 -0
- package/dist/models/PartnerNotificationEventType.js +2 -0
- package/dist/models/PartnerUpdateResult.d.ts +8 -16
- package/dist/models/PartnerUpdateResult.js +2 -5
- package/dist/models/PartnerWithWarnings.d.ts +7 -0
- package/dist/models/PartnerWithWarnings.js +2 -0
- package/dist/models/PersonalExtraStorage.d.ts +92 -0
- package/dist/models/PersonalExtraStorage.js +91 -0
- package/dist/models/PersonalExtraStorageBlock.d.ts +56 -0
- package/dist/models/PersonalExtraStorageBlock.js +65 -0
- package/dist/models/PersonalStorage.d.ts +80 -0
- package/dist/models/PersonalStorage.js +80 -0
- package/dist/models/PersonalStoragePack.d.ts +100 -0
- package/dist/models/PersonalStoragePack.js +92 -0
- package/dist/models/PurchaseStoragePack200ResponseDataPaymentIntent.d.ts +50 -0
- package/dist/models/PurchaseStoragePack200ResponseDataPaymentIntent.js +54 -0
- package/dist/models/RequestExtraCredits.d.ts +33 -0
- package/dist/models/RequestExtraCredits.js +50 -0
- package/dist/models/RollbackComponentRequest.d.ts +38 -0
- package/dist/models/RollbackComponentRequest.js +52 -0
- package/dist/models/StorageChange.d.ts +4 -3
- package/dist/models/SurfaceConversionResult.d.ts +85 -0
- package/dist/models/SurfaceConversionResult.js +84 -0
- package/dist/models/SurfaceConversionResultSubscription.d.ts +82 -0
- package/dist/models/SurfaceConversionResultSubscription.js +70 -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/UpdatePartnerCustomizationRequest.d.ts +3 -3
- package/dist/models/UpdatePartnerCustomizationRequest.js +2 -2
- package/dist/models/UpdatePartnerRequest.d.ts +7 -24
- package/dist/models/UpdatePartnerRequest.js +2 -8
- package/dist/models/WorkflowAcceptedResponse.d.ts +38 -0
- package/dist/models/WorkflowAcceptedResponse.js +50 -0
- package/dist/models/index.d.ts +19 -9
- package/dist/models/index.js +19 -9
- package/package.json +3 -2
|
@@ -65,7 +65,7 @@ export class PublicEmbedApi extends runtime.BaseAPI {
|
|
|
65
65
|
});
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
|
-
* Public customer embed lookup. No API key. Used by embed-sdk.js on third-party sites. If the composition\'s owner listed the websites it may appear on (the workspace\'s domain list, or the `allowedDomains` of a partner the owner administers), a request from any other website is refused with 403 `DOMAIN_NOT_ALLOWED`. The website is read from the `Origin` header, or the host of `Referer` when there is no `Origin`; a request that names neither (a server, a tool) is not refused. An owner who listed nothing is not restricted, and a page on the visitor\'s own machine (`localhost`, `127.0.0.1` or `[::1]`, on any port) is always allowed. The list stops other websites from showing the embed in a visitor\'s browser; it does not hide the published content from someone who holds the composition ID. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag. **Limit.** 500 calls for each visitor address and browser in one counting window, shared with the frame and the status routes. Over it the answer is 429 `RATE_LIMITED` with a `Retry-After` header.
|
|
68
|
+
* Public customer embed lookup. No API key. Used by embed-sdk.js on third-party sites. If the composition\'s owner listed the websites it may appear on (the workspace\'s domain list, or the `allowedDomains` of a partner the owner administers), a request from any other website is refused with 403 `DOMAIN_NOT_ALLOWED`. The website is read from the `Origin` header, or the host of `Referer` when there is no `Origin`; a request that names neither (a server, a tool) is not refused. An owner who listed nothing is not restricted, and a page on the visitor\'s own machine (`localhost`, `127.0.0.1` or `[::1]`, on any port) is always allowed. So is the website where a partner integrates Widgetic, with every subdomain of it (`platformDomain` in the answer of `GET /partners/mine`), for the widgets of that partner: a partner\'s list never has to name it. The list stops other websites from showing the embed in a visitor\'s browser; it does not hide the published content from someone who holds the composition ID. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag. **Limit.** 500 calls for each visitor address and browser in one counting window, shared with the frame and the status routes. Over it the answer is 429 `RATE_LIMITED` with a `Retry-After` header.
|
|
69
69
|
* Resolve a composition UUID to a published widget URL
|
|
70
70
|
*/
|
|
71
71
|
getPublicCompositionEmbedRaw(requestParameters, initOverrides) {
|
|
@@ -85,7 +85,7 @@ export class PublicEmbedApi extends runtime.BaseAPI {
|
|
|
85
85
|
});
|
|
86
86
|
}
|
|
87
87
|
/**
|
|
88
|
-
* Public customer embed lookup. No API key. Used by embed-sdk.js on third-party sites. If the composition\'s owner listed the websites it may appear on (the workspace\'s domain list, or the `allowedDomains` of a partner the owner administers), a request from any other website is refused with 403 `DOMAIN_NOT_ALLOWED`. The website is read from the `Origin` header, or the host of `Referer` when there is no `Origin`; a request that names neither (a server, a tool) is not refused. An owner who listed nothing is not restricted, and a page on the visitor\'s own machine (`localhost`, `127.0.0.1` or `[::1]`, on any port) is always allowed. The list stops other websites from showing the embed in a visitor\'s browser; it does not hide the published content from someone who holds the composition ID. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag. **Limit.** 500 calls for each visitor address and browser in one counting window, shared with the frame and the status routes. Over it the answer is 429 `RATE_LIMITED` with a `Retry-After` header.
|
|
88
|
+
* Public customer embed lookup. No API key. Used by embed-sdk.js on third-party sites. If the composition\'s owner listed the websites it may appear on (the workspace\'s domain list, or the `allowedDomains` of a partner the owner administers), a request from any other website is refused with 403 `DOMAIN_NOT_ALLOWED`. The website is read from the `Origin` header, or the host of `Referer` when there is no `Origin`; a request that names neither (a server, a tool) is not refused. An owner who listed nothing is not restricted, and a page on the visitor\'s own machine (`localhost`, `127.0.0.1` or `[::1]`, on any port) is always allowed. So is the website where a partner integrates Widgetic, with every subdomain of it (`platformDomain` in the answer of `GET /partners/mine`), for the widgets of that partner: a partner\'s list never has to name it. The list stops other websites from showing the embed in a visitor\'s browser; it does not hide the published content from someone who holds the composition ID. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag. **Limit.** 500 calls for each visitor address and browser in one counting window, shared with the frame and the status routes. Over it the answer is 429 `RATE_LIMITED` with a `Retry-After` header.
|
|
89
89
|
* Resolve a composition UUID to a published widget URL
|
|
90
90
|
*/
|
|
91
91
|
getPublicCompositionEmbed(requestParameters, initOverrides) {
|
|
@@ -95,7 +95,7 @@ export class PublicEmbedApi extends runtime.BaseAPI {
|
|
|
95
95
|
});
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
|
-
* Public HTML wrapper with an inner published artifact iframe. No API key or SDK required. If the composition\'s owner listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic\'s own), so a browser refuses to show it inside any other website whatever `Referer` policy that website uses. Opening the address directly still works. An owner who listed nothing is not restricted. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
98
|
+
* Public HTML wrapper with an inner published artifact iframe. No API key or SDK required. If the composition\'s owner listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic\'s own, and the website where the partner the owner administers integrates Widgetic, with its subdomains), so a browser refuses to show it inside any other website whatever `Referer` policy that website uses. Opening the address directly still works. An owner who listed nothing is not restricted. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
99
99
|
* Embed a published composition with its saved values
|
|
100
100
|
*/
|
|
101
101
|
getPublicCompositionIframeRaw(requestParameters, initOverrides) {
|
|
@@ -120,7 +120,7 @@ export class PublicEmbedApi extends runtime.BaseAPI {
|
|
|
120
120
|
});
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
|
-
* Public HTML wrapper with an inner published artifact iframe. No API key or SDK required. If the composition\'s owner listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic\'s own), so a browser refuses to show it inside any other website whatever `Referer` policy that website uses. Opening the address directly still works. An owner who listed nothing is not restricted. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
123
|
+
* Public HTML wrapper with an inner published artifact iframe. No API key or SDK required. If the composition\'s owner listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic\'s own, and the website where the partner the owner administers integrates Widgetic, with its subdomains), so a browser refuses to show it inside any other website whatever `Referer` policy that website uses. Opening the address directly still works. An owner who listed nothing is not restricted. **Address.** `https://api.widgetic.com/embed/compositions/{compositionId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
124
124
|
* Embed a published composition with its saved values
|
|
125
125
|
*/
|
|
126
126
|
getPublicCompositionIframe(requestParameters, initOverrides) {
|
|
@@ -120,12 +120,12 @@ export declare class SubscriptionsApi extends runtime.BaseAPI {
|
|
|
120
120
|
*/
|
|
121
121
|
getSubscriptionsByUserId(requestParameters: GetSubscriptionsByUserIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Subscription>>;
|
|
122
122
|
/**
|
|
123
|
-
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Admin only.
|
|
123
|
+
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Extra storage is not a reason to refuse: the storage the subscription bills stays on it at the same price (only the seats are repriced), and the storage rows the leaving holder had are handed to the arriving one, so a team\'s packs become a person\'s and back. Admin only.
|
|
124
124
|
* Move a subscription between the personal and organization surfaces
|
|
125
125
|
*/
|
|
126
126
|
moveSubscriptionSurfaceRaw(requestParameters: MoveSubscriptionSurfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
127
127
|
/**
|
|
128
|
-
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Admin only.
|
|
128
|
+
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Extra storage is not a reason to refuse: the storage the subscription bills stays on it at the same price (only the seats are repriced), and the storage rows the leaving holder had are handed to the arriving one, so a team\'s packs become a person\'s and back. Admin only.
|
|
129
129
|
* Move a subscription between the personal and organization surfaces
|
|
130
130
|
*/
|
|
131
131
|
moveSubscriptionSurface(requestParameters: MoveSubscriptionSurfaceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
@@ -271,7 +271,7 @@ export class SubscriptionsApi extends runtime.BaseAPI {
|
|
|
271
271
|
});
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Admin only.
|
|
274
|
+
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Extra storage is not a reason to refuse: the storage the subscription bills stays on it at the same price (only the seats are repriced), and the storage rows the leaving holder had are handed to the arriving one, so a team\'s packs become a person\'s and back. Admin only.
|
|
275
275
|
* Move a subscription between the personal and organization surfaces
|
|
276
276
|
*/
|
|
277
277
|
moveSubscriptionSurfaceRaw(requestParameters, initOverrides) {
|
|
@@ -306,7 +306,7 @@ export class SubscriptionsApi extends runtime.BaseAPI {
|
|
|
306
306
|
});
|
|
307
307
|
}
|
|
308
308
|
/**
|
|
309
|
-
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Admin only.
|
|
309
|
+
* Rewrites the subscription onto the target surface: the scope columns and the plan are updated together, the Stripe subscription is repriced to the target plan first (so a refusal changes nothing), the source plan\'s entitlements and the allowance it granted are retired, and the target plan\'s are granted — for an organization target, to each of its billable members. Extra storage is not a reason to refuse: the storage the subscription bills stays on it at the same price (only the seats are repriced), and the storage rows the leaving holder had are handed to the arriving one, so a team\'s packs become a person\'s and back. Admin only.
|
|
310
310
|
* Move a subscription between the personal and organization surfaces
|
|
311
311
|
*/
|
|
312
312
|
moveSubscriptionSurface(requestParameters, initOverrides) {
|
|
@@ -0,0 +1,96 @@
|
|
|
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 { ComponentManifest, ListComponents200Response, MountRequest, MountResponse } from '../models/index';
|
|
14
|
+
export interface GetComponentManifestRequest {
|
|
15
|
+
componentId: GetComponentManifestComponentIdEnum;
|
|
16
|
+
}
|
|
17
|
+
export interface MountComponentRequest {
|
|
18
|
+
componentId: MountComponentComponentIdEnum;
|
|
19
|
+
mountRequest: MountRequest;
|
|
20
|
+
}
|
|
21
|
+
export interface UnmountComponentRequest {
|
|
22
|
+
componentId: UnmountComponentComponentIdEnum;
|
|
23
|
+
instanceId: string;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export declare class UIComponentsApi extends runtime.BaseAPI {
|
|
29
|
+
/**
|
|
30
|
+
* Get component manifest with configuration and dependencies
|
|
31
|
+
* Get Component Manifest
|
|
32
|
+
*/
|
|
33
|
+
getComponentManifestRaw(requestParameters: GetComponentManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ComponentManifest>>;
|
|
34
|
+
/**
|
|
35
|
+
* Get component manifest with configuration and dependencies
|
|
36
|
+
* Get Component Manifest
|
|
37
|
+
*/
|
|
38
|
+
getComponentManifest(requestParameters: GetComponentManifestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ComponentManifest>;
|
|
39
|
+
/**
|
|
40
|
+
* List available UI components for partner
|
|
41
|
+
* List UI Components
|
|
42
|
+
*/
|
|
43
|
+
listComponentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListComponents200Response>>;
|
|
44
|
+
/**
|
|
45
|
+
* List available UI components for partner
|
|
46
|
+
* List UI Components
|
|
47
|
+
*/
|
|
48
|
+
listComponents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListComponents200Response>;
|
|
49
|
+
/**
|
|
50
|
+
* Initialize and mount a UI component
|
|
51
|
+
* Mount Component
|
|
52
|
+
*/
|
|
53
|
+
mountComponentRaw(requestParameters: MountComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MountResponse>>;
|
|
54
|
+
/**
|
|
55
|
+
* Initialize and mount a UI component
|
|
56
|
+
* Mount Component
|
|
57
|
+
*/
|
|
58
|
+
mountComponent(requestParameters: MountComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MountResponse>;
|
|
59
|
+
/**
|
|
60
|
+
* Cleanup and unmount a UI component instance
|
|
61
|
+
* Unmount Component
|
|
62
|
+
*/
|
|
63
|
+
unmountComponentRaw(requestParameters: UnmountComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
64
|
+
/**
|
|
65
|
+
* Cleanup and unmount a UI component instance
|
|
66
|
+
* Unmount Component
|
|
67
|
+
*/
|
|
68
|
+
unmountComponent(requestParameters: UnmountComponentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* @export
|
|
72
|
+
*/
|
|
73
|
+
export declare const GetComponentManifestComponentIdEnum: {
|
|
74
|
+
readonly WidgetCreator: "widget-creator";
|
|
75
|
+
readonly CompositionEditor: "composition-editor";
|
|
76
|
+
readonly EmbedEditor: "embed-editor";
|
|
77
|
+
};
|
|
78
|
+
export type GetComponentManifestComponentIdEnum = typeof GetComponentManifestComponentIdEnum[keyof typeof GetComponentManifestComponentIdEnum];
|
|
79
|
+
/**
|
|
80
|
+
* @export
|
|
81
|
+
*/
|
|
82
|
+
export declare const MountComponentComponentIdEnum: {
|
|
83
|
+
readonly WidgetCreator: "widget-creator";
|
|
84
|
+
readonly CompositionEditor: "composition-editor";
|
|
85
|
+
readonly EmbedEditor: "embed-editor";
|
|
86
|
+
};
|
|
87
|
+
export type MountComponentComponentIdEnum = typeof MountComponentComponentIdEnum[keyof typeof MountComponentComponentIdEnum];
|
|
88
|
+
/**
|
|
89
|
+
* @export
|
|
90
|
+
*/
|
|
91
|
+
export declare const UnmountComponentComponentIdEnum: {
|
|
92
|
+
readonly WidgetCreator: "widget-creator";
|
|
93
|
+
readonly CompositionEditor: "composition-editor";
|
|
94
|
+
readonly EmbedEditor: "embed-editor";
|
|
95
|
+
};
|
|
96
|
+
export type UnmountComponentComponentIdEnum = typeof UnmountComponentComponentIdEnum[keyof typeof UnmountComponentComponentIdEnum];
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Widgetic API Gateway
|
|
5
|
+
* API documentation for the Widgetic API Gateway
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
15
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
16
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
17
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
18
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
19
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
20
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
21
|
+
});
|
|
22
|
+
};
|
|
23
|
+
import * as runtime from '../runtime.js';
|
|
24
|
+
import { ComponentManifestFromJSON, ListComponents200ResponseFromJSON, MountRequestToJSON, MountResponseFromJSON, } from '../models/index.js';
|
|
25
|
+
/**
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
export class UIComponentsApi extends runtime.BaseAPI {
|
|
29
|
+
/**
|
|
30
|
+
* Get component manifest with configuration and dependencies
|
|
31
|
+
* Get Component Manifest
|
|
32
|
+
*/
|
|
33
|
+
getComponentManifestRaw(requestParameters, initOverrides) {
|
|
34
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
35
|
+
if (requestParameters['componentId'] == null) {
|
|
36
|
+
throw new runtime.RequiredError('componentId', 'Required parameter "componentId" was null or undefined when calling getComponentManifest().');
|
|
37
|
+
}
|
|
38
|
+
const queryParameters = {};
|
|
39
|
+
const headerParameters = {};
|
|
40
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
41
|
+
const token = this.configuration.accessToken;
|
|
42
|
+
const tokenString = yield token("apiKeyAuth", []);
|
|
43
|
+
if (tokenString) {
|
|
44
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
const response = yield this.request({
|
|
48
|
+
path: `/ui/components/{componentId}/manifest`.replace(`{${"componentId"}}`, encodeURIComponent(String(requestParameters['componentId']))),
|
|
49
|
+
method: 'GET',
|
|
50
|
+
headers: headerParameters,
|
|
51
|
+
query: queryParameters,
|
|
52
|
+
}, initOverrides);
|
|
53
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ComponentManifestFromJSON(jsonValue));
|
|
54
|
+
});
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* Get component manifest with configuration and dependencies
|
|
58
|
+
* Get Component Manifest
|
|
59
|
+
*/
|
|
60
|
+
getComponentManifest(requestParameters, initOverrides) {
|
|
61
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
62
|
+
const response = yield this.getComponentManifestRaw(requestParameters, initOverrides);
|
|
63
|
+
return yield response.value();
|
|
64
|
+
});
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* List available UI components for partner
|
|
68
|
+
* List UI Components
|
|
69
|
+
*/
|
|
70
|
+
listComponentsRaw(initOverrides) {
|
|
71
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
72
|
+
const queryParameters = {};
|
|
73
|
+
const headerParameters = {};
|
|
74
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
75
|
+
const token = this.configuration.accessToken;
|
|
76
|
+
const tokenString = yield token("apiKeyAuth", []);
|
|
77
|
+
if (tokenString) {
|
|
78
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
const response = yield this.request({
|
|
82
|
+
path: `/ui/components`,
|
|
83
|
+
method: 'GET',
|
|
84
|
+
headers: headerParameters,
|
|
85
|
+
query: queryParameters,
|
|
86
|
+
}, initOverrides);
|
|
87
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ListComponents200ResponseFromJSON(jsonValue));
|
|
88
|
+
});
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* List available UI components for partner
|
|
92
|
+
* List UI Components
|
|
93
|
+
*/
|
|
94
|
+
listComponents(initOverrides) {
|
|
95
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
96
|
+
const response = yield this.listComponentsRaw(initOverrides);
|
|
97
|
+
return yield response.value();
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Initialize and mount a UI component
|
|
102
|
+
* Mount Component
|
|
103
|
+
*/
|
|
104
|
+
mountComponentRaw(requestParameters, initOverrides) {
|
|
105
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
106
|
+
if (requestParameters['componentId'] == null) {
|
|
107
|
+
throw new runtime.RequiredError('componentId', 'Required parameter "componentId" was null or undefined when calling mountComponent().');
|
|
108
|
+
}
|
|
109
|
+
if (requestParameters['mountRequest'] == null) {
|
|
110
|
+
throw new runtime.RequiredError('mountRequest', 'Required parameter "mountRequest" was null or undefined when calling mountComponent().');
|
|
111
|
+
}
|
|
112
|
+
const queryParameters = {};
|
|
113
|
+
const headerParameters = {};
|
|
114
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
115
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
116
|
+
const token = this.configuration.accessToken;
|
|
117
|
+
const tokenString = yield token("apiKeyAuth", []);
|
|
118
|
+
if (tokenString) {
|
|
119
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
const response = yield this.request({
|
|
123
|
+
path: `/ui/components/{componentId}/mount`.replace(`{${"componentId"}}`, encodeURIComponent(String(requestParameters['componentId']))),
|
|
124
|
+
method: 'POST',
|
|
125
|
+
headers: headerParameters,
|
|
126
|
+
query: queryParameters,
|
|
127
|
+
body: MountRequestToJSON(requestParameters['mountRequest']),
|
|
128
|
+
}, initOverrides);
|
|
129
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => MountResponseFromJSON(jsonValue));
|
|
130
|
+
});
|
|
131
|
+
}
|
|
132
|
+
/**
|
|
133
|
+
* Initialize and mount a UI component
|
|
134
|
+
* Mount Component
|
|
135
|
+
*/
|
|
136
|
+
mountComponent(requestParameters, initOverrides) {
|
|
137
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
138
|
+
const response = yield this.mountComponentRaw(requestParameters, initOverrides);
|
|
139
|
+
return yield response.value();
|
|
140
|
+
});
|
|
141
|
+
}
|
|
142
|
+
/**
|
|
143
|
+
* Cleanup and unmount a UI component instance
|
|
144
|
+
* Unmount Component
|
|
145
|
+
*/
|
|
146
|
+
unmountComponentRaw(requestParameters, initOverrides) {
|
|
147
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
148
|
+
if (requestParameters['componentId'] == null) {
|
|
149
|
+
throw new runtime.RequiredError('componentId', 'Required parameter "componentId" was null or undefined when calling unmountComponent().');
|
|
150
|
+
}
|
|
151
|
+
if (requestParameters['instanceId'] == null) {
|
|
152
|
+
throw new runtime.RequiredError('instanceId', 'Required parameter "instanceId" was null or undefined when calling unmountComponent().');
|
|
153
|
+
}
|
|
154
|
+
const queryParameters = {};
|
|
155
|
+
const headerParameters = {};
|
|
156
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
157
|
+
const token = this.configuration.accessToken;
|
|
158
|
+
const tokenString = yield token("apiKeyAuth", []);
|
|
159
|
+
if (tokenString) {
|
|
160
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
const response = yield this.request({
|
|
164
|
+
path: `/ui/components/{componentId}/{instanceId}`.replace(`{${"componentId"}}`, encodeURIComponent(String(requestParameters['componentId']))).replace(`{${"instanceId"}}`, encodeURIComponent(String(requestParameters['instanceId']))),
|
|
165
|
+
method: 'DELETE',
|
|
166
|
+
headers: headerParameters,
|
|
167
|
+
query: queryParameters,
|
|
168
|
+
}, initOverrides);
|
|
169
|
+
return new runtime.VoidApiResponse(response);
|
|
170
|
+
});
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Cleanup and unmount a UI component instance
|
|
174
|
+
* Unmount Component
|
|
175
|
+
*/
|
|
176
|
+
unmountComponent(requestParameters, initOverrides) {
|
|
177
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
178
|
+
yield this.unmountComponentRaw(requestParameters, initOverrides);
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* @export
|
|
184
|
+
*/
|
|
185
|
+
export const GetComponentManifestComponentIdEnum = {
|
|
186
|
+
WidgetCreator: 'widget-creator',
|
|
187
|
+
CompositionEditor: 'composition-editor',
|
|
188
|
+
EmbedEditor: 'embed-editor'
|
|
189
|
+
};
|
|
190
|
+
/**
|
|
191
|
+
* @export
|
|
192
|
+
*/
|
|
193
|
+
export const MountComponentComponentIdEnum = {
|
|
194
|
+
WidgetCreator: 'widget-creator',
|
|
195
|
+
CompositionEditor: 'composition-editor',
|
|
196
|
+
EmbedEditor: 'embed-editor'
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export const UnmountComponentComponentIdEnum = {
|
|
202
|
+
WidgetCreator: 'widget-creator',
|
|
203
|
+
CompositionEditor: 'composition-editor',
|
|
204
|
+
EmbedEditor: 'embed-editor'
|
|
205
|
+
};
|
|
@@ -77,22 +77,22 @@ export declare class UploadsApi extends runtime.BaseAPI {
|
|
|
77
77
|
*/
|
|
78
78
|
uploadsLimitsGet(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UploadLimits>;
|
|
79
79
|
/**
|
|
80
|
-
* 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
|
|
80
|
+
* 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 storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team\'s shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store\'s session, always work in that team\'s shared storage. A personal API key or an SDK token always uses the account\'s own allowance. The two never add up and one never lends room to the other. 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. When the full storage is a Shopify store\'s team\'s, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person\'s own workspace, get the shorter message. 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, and it does not depend on how the file arrives. A partner\'s own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) 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.
|
|
81
81
|
* Upload a file
|
|
82
82
|
*/
|
|
83
83
|
uploadsPostRaw(requestParameters: UploadsPost0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Upload>>;
|
|
84
84
|
/**
|
|
85
|
-
* 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
|
|
85
|
+
* 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 storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team\'s shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store\'s session, always work in that team\'s shared storage. A personal API key or an SDK token always uses the account\'s own allowance. The two never add up and one never lends room to the other. 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. When the full storage is a Shopify store\'s team\'s, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person\'s own workspace, get the shorter message. 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, and it does not depend on how the file arrives. A partner\'s own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) 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.
|
|
86
86
|
* Upload a file
|
|
87
87
|
*/
|
|
88
88
|
uploadsPost(requestParameters: UploadsPost0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Upload>;
|
|
89
89
|
/**
|
|
90
|
-
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. This call stores the finished file: it counts against the
|
|
90
|
+
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. The upload is for the workspace the person was working in when it was declared: inside a team, the team\'s shared storage; inside their own workspace, their own allowance (a Shopify store\'s session always works in the store\'s team). Declaring it checks that the file fits that space right now (a team\'s space never borrows from the person\'s own, nor the other way round), and the workspace is kept with the upload. A person who has left the team by the time the file is stored gets it stored in their own space instead, never the team\'s. This call stores the finished file: it counts against the storage of that workspace only now, not while the file is on its way, so an upload that is abandoned costs nothing. It is safe to call again after a lost answer: the file that was stored is returned, not stored twice. A file that could not be stored (storage down, allowance full) stays available for a day from when the upload began, so the call can be repeated without sending the file again. An unfinished upload is deleted after that day, and an account can hold only a few at once. A partner account that is paused, not yet activated or behind on a payment cannot start a resumable upload (the declaring `POST /uploads/tus` answers 403) and cannot complete one (`PARTNER_SUSPENDED`, `PARTNER_INACTIVE`, `PARTNER_PAYMENT_ARREARS`). An account that administers a partner keeps the finished file in the partner\'s own storage destination (`setPartnerStorageDestination`), never in Widgetic\'s: the pieces wait in Widgetic\'s temporary storage and are removed when this call has written the file to the partner\'s bucket, and the file takes none of the allowance (declaring it checks no room for it either). A partner with no destination cannot start a resumable upload (the declaring `POST /uploads/tus` answers 409 with a line of text, before a byte is sent), and one that removed it since cannot complete one (`PARTNER_STORAGE_REQUIRED`).
|
|
91
91
|
* Finish a resumable upload — store the file and return it
|
|
92
92
|
*/
|
|
93
93
|
uploadsTusIdCompletePostRaw(requestParameters: UploadsTusIdCompletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Upload>>;
|
|
94
94
|
/**
|
|
95
|
-
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. This call stores the finished file: it counts against the
|
|
95
|
+
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. The upload is for the workspace the person was working in when it was declared: inside a team, the team\'s shared storage; inside their own workspace, their own allowance (a Shopify store\'s session always works in the store\'s team). Declaring it checks that the file fits that space right now (a team\'s space never borrows from the person\'s own, nor the other way round), and the workspace is kept with the upload. A person who has left the team by the time the file is stored gets it stored in their own space instead, never the team\'s. This call stores the finished file: it counts against the storage of that workspace only now, not while the file is on its way, so an upload that is abandoned costs nothing. It is safe to call again after a lost answer: the file that was stored is returned, not stored twice. A file that could not be stored (storage down, allowance full) stays available for a day from when the upload began, so the call can be repeated without sending the file again. An unfinished upload is deleted after that day, and an account can hold only a few at once. A partner account that is paused, not yet activated or behind on a payment cannot start a resumable upload (the declaring `POST /uploads/tus` answers 403) and cannot complete one (`PARTNER_SUSPENDED`, `PARTNER_INACTIVE`, `PARTNER_PAYMENT_ARREARS`). An account that administers a partner keeps the finished file in the partner\'s own storage destination (`setPartnerStorageDestination`), never in Widgetic\'s: the pieces wait in Widgetic\'s temporary storage and are removed when this call has written the file to the partner\'s bucket, and the file takes none of the allowance (declaring it checks no room for it either). A partner with no destination cannot start a resumable upload (the declaring `POST /uploads/tus` answers 409 with a line of text, before a byte is sent), and one that removed it since cannot complete one (`PARTNER_STORAGE_REQUIRED`).
|
|
96
96
|
* Finish a resumable upload — store the file and return it
|
|
97
97
|
*/
|
|
98
98
|
uploadsTusIdCompletePost(requestParameters: UploadsTusIdCompletePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Upload>;
|
|
@@ -178,7 +178,7 @@ export class UploadsApi extends runtime.BaseAPI {
|
|
|
178
178
|
});
|
|
179
179
|
}
|
|
180
180
|
/**
|
|
181
|
-
* 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
|
|
181
|
+
* 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 storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team\'s shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store\'s session, always work in that team\'s shared storage. A personal API key or an SDK token always uses the account\'s own allowance. The two never add up and one never lends room to the other. 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. When the full storage is a Shopify store\'s team\'s, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person\'s own workspace, get the shorter message. 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, and it does not depend on how the file arrives. A partner\'s own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) 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.
|
|
182
182
|
* Upload a file
|
|
183
183
|
*/
|
|
184
184
|
uploadsPostRaw(requestParameters, initOverrides) {
|
|
@@ -236,7 +236,7 @@ export class UploadsApi extends runtime.BaseAPI {
|
|
|
236
236
|
});
|
|
237
237
|
}
|
|
238
238
|
/**
|
|
239
|
-
* 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
|
|
239
|
+
* 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 storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team\'s shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store\'s session, always work in that team\'s shared storage. A personal API key or an SDK token always uses the account\'s own allowance. The two never add up and one never lends room to the other. 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. When the full storage is a Shopify store\'s team\'s, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person\'s own workspace, get the shorter message. 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, and it does not depend on how the file arrives. A partner\'s own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) 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.
|
|
240
240
|
* Upload a file
|
|
241
241
|
*/
|
|
242
242
|
uploadsPost(requestParameters, initOverrides) {
|
|
@@ -246,7 +246,7 @@ export class UploadsApi extends runtime.BaseAPI {
|
|
|
246
246
|
});
|
|
247
247
|
}
|
|
248
248
|
/**
|
|
249
|
-
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. This call stores the finished file: it counts against the
|
|
249
|
+
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. The upload is for the workspace the person was working in when it was declared: inside a team, the team\'s shared storage; inside their own workspace, their own allowance (a Shopify store\'s session always works in the store\'s team). Declaring it checks that the file fits that space right now (a team\'s space never borrows from the person\'s own, nor the other way round), and the workspace is kept with the upload. A person who has left the team by the time the file is stored gets it stored in their own space instead, never the team\'s. This call stores the finished file: it counts against the storage of that workspace only now, not while the file is on its way, so an upload that is abandoned costs nothing. It is safe to call again after a lost answer: the file that was stored is returned, not stored twice. A file that could not be stored (storage down, allowance full) stays available for a day from when the upload began, so the call can be repeated without sending the file again. An unfinished upload is deleted after that day, and an account can hold only a few at once. A partner account that is paused, not yet activated or behind on a payment cannot start a resumable upload (the declaring `POST /uploads/tus` answers 403) and cannot complete one (`PARTNER_SUSPENDED`, `PARTNER_INACTIVE`, `PARTNER_PAYMENT_ARREARS`). An account that administers a partner keeps the finished file in the partner\'s own storage destination (`setPartnerStorageDestination`), never in Widgetic\'s: the pieces wait in Widgetic\'s temporary storage and are removed when this call has written the file to the partner\'s bucket, and the file takes none of the allowance (declaring it checks no room for it either). A partner with no destination cannot start a resumable upload (the declaring `POST /uploads/tus` answers 409 with a line of text, before a byte is sent), and one that removed it since cannot complete one (`PARTNER_STORAGE_REQUIRED`).
|
|
250
250
|
* Finish a resumable upload — store the file and return it
|
|
251
251
|
*/
|
|
252
252
|
uploadsTusIdCompletePostRaw(requestParameters, initOverrides) {
|
|
@@ -266,7 +266,7 @@ export class UploadsApi extends runtime.BaseAPI {
|
|
|
266
266
|
});
|
|
267
267
|
}
|
|
268
268
|
/**
|
|
269
|
-
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. This call stores the finished file: it counts against the
|
|
269
|
+
* Resumable uploads carry a file of up to 250 MB (the limit `tus_max_bytes` of `uploadsLimitsGet`, the same for every account) in pieces that can be resumed after a dropped connection, or after the server was restarted: the pieces wait in shared storage, not on one server. They follow the [tus protocol](https://tus.io): `POST /uploads/tus` declares the file (`Upload-Length` and the `Upload-Metadata` keys `filename`, `filetype` and, optionally, `context_type`, `source`, `widget_id`, `conversation_id` and, to file the upload under one of a partner\'s managed users, `managed_user_id` or `managed_user_external_id`), `PATCH` sends the bytes, `HEAD` says how far a client got. They need a signed-in session; an API key uses `uploadsPost`. A partner files an upload under one of its managed users with `managed_user_id` (Widgetic\'s id) or `managed_user_external_id` (the partner\'s own id for the user), never both: the same two fields, with the same spelling, as the form fields of `uploadsPost`. The managed user is looked up among the signed-in account\'s own when the upload is declared, so a wrong one is refused before any byte is sent (the declaring `POST /uploads/tus` answers 400, 404 or 409 with a line of text), and is looked up again here, when the file is stored. The stored file then carries the managed user (`managedUserId`), is found by the `managedUserId` filter of `uploadsGet`, and is counted for that user by `getPartnerStorageUsage`. Without either key the file is the account\'s own. The upload is for the workspace the person was working in when it was declared: inside a team, the team\'s shared storage; inside their own workspace, their own allowance (a Shopify store\'s session always works in the store\'s team). Declaring it checks that the file fits that space right now (a team\'s space never borrows from the person\'s own, nor the other way round), and the workspace is kept with the upload. A person who has left the team by the time the file is stored gets it stored in their own space instead, never the team\'s. This call stores the finished file: it counts against the storage of that workspace only now, not while the file is on its way, so an upload that is abandoned costs nothing. It is safe to call again after a lost answer: the file that was stored is returned, not stored twice. A file that could not be stored (storage down, allowance full) stays available for a day from when the upload began, so the call can be repeated without sending the file again. An unfinished upload is deleted after that day, and an account can hold only a few at once. A partner account that is paused, not yet activated or behind on a payment cannot start a resumable upload (the declaring `POST /uploads/tus` answers 403) and cannot complete one (`PARTNER_SUSPENDED`, `PARTNER_INACTIVE`, `PARTNER_PAYMENT_ARREARS`). An account that administers a partner keeps the finished file in the partner\'s own storage destination (`setPartnerStorageDestination`), never in Widgetic\'s: the pieces wait in Widgetic\'s temporary storage and are removed when this call has written the file to the partner\'s bucket, and the file takes none of the allowance (declaring it checks no room for it either). A partner with no destination cannot start a resumable upload (the declaring `POST /uploads/tus` answers 409 with a line of text, before a byte is sent), and one that removed it since cannot complete one (`PARTNER_STORAGE_REQUIRED`).
|
|
270
270
|
* Finish a resumable upload — store the file and return it
|
|
271
271
|
*/
|
|
272
272
|
uploadsTusIdCompletePost(requestParameters, initOverrides) {
|
|
@@ -57,22 +57,22 @@ export interface UsersSendFeedbackPostOperationRequest {
|
|
|
57
57
|
*/
|
|
58
58
|
export declare class UsersApi extends runtime.BaseAPI {
|
|
59
59
|
/**
|
|
60
|
-
* 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.
|
|
60
|
+
* 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. So is the website where a partner your account administers integrates Widgetic, with every subdomain of it (`platformDomain` in the answer of `GET /partners/mine`), so there is nothing to add for it either and a list can never lock it out. 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.
|
|
61
61
|
* Allow a website to show your widgets
|
|
62
62
|
*/
|
|
63
63
|
addPersonalWorkspaceDomainRaw(requestParameters: AddPersonalWorkspaceDomain0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PersonalWorkspaceDomainResult>>;
|
|
64
64
|
/**
|
|
65
|
-
* 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.
|
|
65
|
+
* 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. So is the website where a partner your account administers integrates Widgetic, with every subdomain of it (`platformDomain` in the answer of `GET /partners/mine`), so there is nothing to add for it either and a list can never lock it out. 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.
|
|
66
66
|
* Allow a website to show your widgets
|
|
67
67
|
*/
|
|
68
68
|
addPersonalWorkspaceDomain(requestParameters: AddPersonalWorkspaceDomain0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PersonalWorkspaceDomainResult>;
|
|
69
69
|
/**
|
|
70
|
-
* 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.
|
|
70
|
+
* 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, except a partner account, which has no limit: what a partner\'s keys do is paid for from its own credits, however many integrations it runs. An account on a plan without API access cannot make one (a partner account is not asked about a plan).
|
|
71
71
|
* Create an API key
|
|
72
72
|
*/
|
|
73
73
|
createUserApiKeyRaw(requestParameters: CreateUserApiKey0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreatedUserApiKey>>;
|
|
74
74
|
/**
|
|
75
|
-
* 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.
|
|
75
|
+
* 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, except a partner account, which has no limit: what a partner\'s keys do is paid for from its own credits, however many integrations it runs. An account on a plan without API access cannot make one (a partner account is not asked about a plan).
|
|
76
76
|
* Create an API key
|
|
77
77
|
*/
|
|
78
78
|
createUserApiKey(requestParameters: CreateUserApiKey0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreatedUserApiKey>;
|