@widgetic/api-sdk 1.0.32 → 1.0.33
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
package/dist/apis/UsersApi.js
CHANGED
|
@@ -30,7 +30,7 @@ const index_1 = require("../models/index");
|
|
|
30
30
|
*/
|
|
31
31
|
class UsersApi extends runtime.BaseAPI {
|
|
32
32
|
/**
|
|
33
|
-
* 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.
|
|
33
|
+
* 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.
|
|
34
34
|
* Allow a website to show your widgets
|
|
35
35
|
*/
|
|
36
36
|
addPersonalWorkspaceDomainRaw(requestParameters, initOverrides) {
|
|
@@ -62,7 +62,7 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
62
62
|
});
|
|
63
63
|
}
|
|
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, initOverrides) {
|
|
@@ -72,7 +72,7 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
72
72
|
});
|
|
73
73
|
}
|
|
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
|
createUserApiKeyRaw(requestParameters, initOverrides) {
|
|
@@ -107,7 +107,7 @@ class UsersApi extends runtime.BaseAPI {
|
|
|
107
107
|
});
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* 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.
|
|
110
|
+
* 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).
|
|
111
111
|
* Create an API key
|
|
112
112
|
*/
|
|
113
113
|
createUserApiKey(requestParameters, initOverrides) {
|
|
@@ -0,0 +1,44 @@
|
|
|
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 { GenerateComponentWorkflowInput, GenerateMixedComponentInput, WorkflowAcceptedResponse } from '../models/index';
|
|
14
|
+
export interface WorkflowsGenerateComponentFromMixPostRequest {
|
|
15
|
+
generateMixedComponentInput: GenerateMixedComponentInput;
|
|
16
|
+
}
|
|
17
|
+
export interface WorkflowsGenerateComponentPostRequest {
|
|
18
|
+
generateComponentWorkflowInput: GenerateComponentWorkflowInput;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
export declare class WorkflowsApi extends runtime.BaseAPI {
|
|
24
|
+
/**
|
|
25
|
+
* Initiates an asynchronous workflow to create a new component based on instructions applied to one or more source components.
|
|
26
|
+
* Generate a New Component by Mixing Existing Ones
|
|
27
|
+
*/
|
|
28
|
+
workflowsGenerateComponentFromMixPostRaw(requestParameters: WorkflowsGenerateComponentFromMixPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowAcceptedResponse>>;
|
|
29
|
+
/**
|
|
30
|
+
* Initiates an asynchronous workflow to create a new component based on instructions applied to one or more source components.
|
|
31
|
+
* Generate a New Component by Mixing Existing Ones
|
|
32
|
+
*/
|
|
33
|
+
workflowsGenerateComponentFromMixPost(requestParameters: WorkflowsGenerateComponentFromMixPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowAcceptedResponse>;
|
|
34
|
+
/**
|
|
35
|
+
* Starts the end-to-end workflow for generating a new component based on initial user requirements. This involves creating a development plan via Task Master, and then executing the plan\'s tasks using Aider for code generation. The process runs asynchronously, and progress should be monitored via WebSockets.
|
|
36
|
+
* Initiate initial component generation workflow
|
|
37
|
+
*/
|
|
38
|
+
workflowsGenerateComponentPostRaw(requestParameters: WorkflowsGenerateComponentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<WorkflowAcceptedResponse>>;
|
|
39
|
+
/**
|
|
40
|
+
* Starts the end-to-end workflow for generating a new component based on initial user requirements. This involves creating a development plan via Task Master, and then executing the plan\'s tasks using Aider for code generation. The process runs asynchronously, and progress should be monitored via WebSockets.
|
|
41
|
+
* Initiate initial component generation workflow
|
|
42
|
+
*/
|
|
43
|
+
workflowsGenerateComponentPost(requestParameters: WorkflowsGenerateComponentPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<WorkflowAcceptedResponse>;
|
|
44
|
+
}
|
|
@@ -0,0 +1,111 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Widgetic API Gateway
|
|
6
|
+
* API documentation for the Widgetic API Gateway
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.WorkflowsApi = void 0;
|
|
26
|
+
const runtime = require("../runtime");
|
|
27
|
+
const index_1 = require("../models/index");
|
|
28
|
+
/**
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
31
|
+
class WorkflowsApi extends runtime.BaseAPI {
|
|
32
|
+
/**
|
|
33
|
+
* Initiates an asynchronous workflow to create a new component based on instructions applied to one or more source components.
|
|
34
|
+
* Generate a New Component by Mixing Existing Ones
|
|
35
|
+
*/
|
|
36
|
+
workflowsGenerateComponentFromMixPostRaw(requestParameters, initOverrides) {
|
|
37
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
38
|
+
if (requestParameters['generateMixedComponentInput'] == null) {
|
|
39
|
+
throw new runtime.RequiredError('generateMixedComponentInput', 'Required parameter "generateMixedComponentInput" was null or undefined when calling workflowsGenerateComponentFromMixPost().');
|
|
40
|
+
}
|
|
41
|
+
const queryParameters = {};
|
|
42
|
+
const headerParameters = {};
|
|
43
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
44
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
45
|
+
const token = this.configuration.accessToken;
|
|
46
|
+
const tokenString = yield token("bearerAuth", []);
|
|
47
|
+
if (tokenString) {
|
|
48
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
const response = yield this.request({
|
|
52
|
+
path: `/workflows/generate-component-from-mix`,
|
|
53
|
+
method: 'POST',
|
|
54
|
+
headers: headerParameters,
|
|
55
|
+
query: queryParameters,
|
|
56
|
+
body: (0, index_1.GenerateMixedComponentInputToJSON)(requestParameters['generateMixedComponentInput']),
|
|
57
|
+
}, initOverrides);
|
|
58
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowAcceptedResponseFromJSON)(jsonValue));
|
|
59
|
+
});
|
|
60
|
+
}
|
|
61
|
+
/**
|
|
62
|
+
* Initiates an asynchronous workflow to create a new component based on instructions applied to one or more source components.
|
|
63
|
+
* Generate a New Component by Mixing Existing Ones
|
|
64
|
+
*/
|
|
65
|
+
workflowsGenerateComponentFromMixPost(requestParameters, initOverrides) {
|
|
66
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
67
|
+
const response = yield this.workflowsGenerateComponentFromMixPostRaw(requestParameters, initOverrides);
|
|
68
|
+
return yield response.value();
|
|
69
|
+
});
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* Starts the end-to-end workflow for generating a new component based on initial user requirements. This involves creating a development plan via Task Master, and then executing the plan\'s tasks using Aider for code generation. The process runs asynchronously, and progress should be monitored via WebSockets.
|
|
73
|
+
* Initiate initial component generation workflow
|
|
74
|
+
*/
|
|
75
|
+
workflowsGenerateComponentPostRaw(requestParameters, initOverrides) {
|
|
76
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
77
|
+
if (requestParameters['generateComponentWorkflowInput'] == null) {
|
|
78
|
+
throw new runtime.RequiredError('generateComponentWorkflowInput', 'Required parameter "generateComponentWorkflowInput" was null or undefined when calling workflowsGenerateComponentPost().');
|
|
79
|
+
}
|
|
80
|
+
const queryParameters = {};
|
|
81
|
+
const headerParameters = {};
|
|
82
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
83
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
84
|
+
const token = this.configuration.accessToken;
|
|
85
|
+
const tokenString = yield token("bearerAuth", []);
|
|
86
|
+
if (tokenString) {
|
|
87
|
+
headerParameters["Authorization"] = `Bearer ${tokenString}`;
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
const response = yield this.request({
|
|
91
|
+
path: `/workflows/generate-component`,
|
|
92
|
+
method: 'POST',
|
|
93
|
+
headers: headerParameters,
|
|
94
|
+
query: queryParameters,
|
|
95
|
+
body: (0, index_1.GenerateComponentWorkflowInputToJSON)(requestParameters['generateComponentWorkflowInput']),
|
|
96
|
+
}, initOverrides);
|
|
97
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.WorkflowAcceptedResponseFromJSON)(jsonValue));
|
|
98
|
+
});
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Starts the end-to-end workflow for generating a new component based on initial user requirements. This involves creating a development plan via Task Master, and then executing the plan\'s tasks using Aider for code generation. The process runs asynchronously, and progress should be monitored via WebSockets.
|
|
102
|
+
* Initiate initial component generation workflow
|
|
103
|
+
*/
|
|
104
|
+
workflowsGenerateComponentPost(requestParameters, initOverrides) {
|
|
105
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
106
|
+
const response = yield this.workflowsGenerateComponentPostRaw(requestParameters, initOverrides);
|
|
107
|
+
return yield response.value();
|
|
108
|
+
});
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
exports.WorkflowsApi = WorkflowsApi;
|
|
@@ -10,12 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type {
|
|
14
|
-
export interface AdjustPartnerCreditsOperationRequest {
|
|
15
|
-
partnerId: string;
|
|
16
|
-
adjustPartnerCreditsRequest: AdjustPartnerCreditsRequest;
|
|
17
|
-
idempotencyKey?: string;
|
|
18
|
-
}
|
|
13
|
+
import type { AdjustUserCredits200Response, AdjustUserCreditsRequest, AdminHealthStatus, CleanupOrphanedInvitations200Response, CleanupOrphanedInvitationsRequest, CreatePartnerRequest, PartnerActivation, PartnerBillingProfileSaved, PartnerBillingProfileView, PartnerBillingReport, PartnerDetails, PartnerEditorSessionSettings, PartnerInvoiceSchedule, PartnerList, PartnerUpdateResult, PartnerWithWarnings, RecordPartnerInvoicePaymentRequest, RecordedPartnerPayment, UpdatePartnerBillingProfileRequest, UpdatePartnerEditorSessionSettingsRequest, UpdatePartnerRequest, UpdatePartnerStatusRequest } from '../models/index';
|
|
19
14
|
export interface AdjustUserCreditsOperationRequest {
|
|
20
15
|
adjustUserCreditsRequest: AdjustUserCreditsRequest;
|
|
21
16
|
idempotencyKey?: string;
|
|
@@ -49,6 +44,9 @@ export interface GetPartnerDetailsRequest {
|
|
|
49
44
|
export interface GetPartnerEditorSessionSettingsRequest {
|
|
50
45
|
partnerId: string;
|
|
51
46
|
}
|
|
47
|
+
export interface GetPartnerInvoiceScheduleRequest {
|
|
48
|
+
partnerId: string;
|
|
49
|
+
}
|
|
52
50
|
export interface ListAdminWidgetsRequest {
|
|
53
51
|
scope?: ListAdminWidgetsScopeEnum;
|
|
54
52
|
preset?: ListAdminWidgetsPresetEnum;
|
|
@@ -69,10 +67,6 @@ export interface RecordPartnerInvoicePaymentOperationRequest {
|
|
|
69
67
|
idempotencyKey?: string;
|
|
70
68
|
recordPartnerInvoicePaymentRequest?: RecordPartnerInvoicePaymentRequest;
|
|
71
69
|
}
|
|
72
|
-
export interface RefundPartnerCreditsOperationRequest {
|
|
73
|
-
refundPartnerCreditsRequest: RefundPartnerCreditsRequest;
|
|
74
|
-
idempotencyKey?: string;
|
|
75
|
-
}
|
|
76
70
|
export interface UpdatePartnerOperationRequest {
|
|
77
71
|
partnerId: string;
|
|
78
72
|
updatePartnerRequest: UpdatePartnerRequest;
|
|
@@ -95,22 +89,12 @@ export interface UpdatePartnerStatusOperationRequest {
|
|
|
95
89
|
*/
|
|
96
90
|
export declare class AdminApi extends runtime.BaseAPI {
|
|
97
91
|
/**
|
|
98
|
-
* Admin only. A positive `amount`
|
|
99
|
-
* Add credits to, or remove credits from, a partner\'s wallet
|
|
100
|
-
*/
|
|
101
|
-
adjustPartnerCreditsRaw(requestParameters: AdjustPartnerCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdjustPartnerCredits200Response>>;
|
|
102
|
-
/**
|
|
103
|
-
* Admin only. A positive `amount` adds credits to the partner wallet; a negative `amount` removes them (the wallet must hold them). An `amount` of 0, or one that is not a finite number, is refused with 400. **One top-up may not exceed $100,000** (`BILLING_CONFIG.PARTNER_WALLET`), which is 1,000,000 credits at the list price of $0.10 per credit. A larger amount is refused with 400 and nothing is credited. The same ceiling applies to `POST /admin/billing/refund` and to the `creditBalance` field of `PUT /admin/partners/{partnerId}`. Removing credits is not limited by it. The `Idempotency-Key` header is required and names the adjustment: a retry with the same key replays the first result (`replayed: true`) instead of moving the balance twice, and a request without one is refused with 400. This moves a PARTNER\'s wallet. A user\'s balance is moved by `POST /admin/billing/credits/adjust`.
|
|
104
|
-
* Add credits to, or remove credits from, a partner\'s wallet
|
|
105
|
-
*/
|
|
106
|
-
adjustPartnerCredits(requestParameters: AdjustPartnerCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdjustPartnerCredits200Response>;
|
|
107
|
-
/**
|
|
108
|
-
* Admin only. A positive `amount` grants free credits; a negative `amount` takes credits away (the balance must hold them). An `amount` of 0, or one that is not a finite number, is refused with 400. The `Idempotency-Key` header is required and names the adjustment: a retry with the same key replays the first result (`replayed: true`) instead of moving the balance twice, and a request without one is refused with 400. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, `POST /credits/add` and the grants route (`POST /admin-billing/grants`). Removing credits is not counted. A request over the per-request limit is refused with 400; one that would pass the daily limit is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED` (`error.details` has the limit, what was used, what is left and when the day resets). This moves a USER\'s balance. A partner\'s wallet is moved by `POST /admin/partners/{partnerId}/credits`.
|
|
92
|
+
* Admin only. A positive `amount` grants free credits; a negative `amount` takes credits away (the balance must hold them). An `amount` of 0, or one that is not a finite number, is refused with 400. The `Idempotency-Key` header is required and names the adjustment: a retry with the same key replays the first result (`replayed: true`) instead of moving the balance twice, and a request without one is refused with 400. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, `POST /credits/add` and the grants route (`POST /admin-billing/grants`). Removing credits is not counted. A request over the per-request limit is refused with 400; one that would pass the daily limit is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED` (`error.details` has the limit, what was used, what is left and when the day resets). This moves a USER\'s balance, which includes the account a partner\'s builds are charged to (its administrator\'s): the credits of a paid partner invoice are added there, and a clawback of them is made here. No route writes to a partner\'s own wallet any more, so this is the one place a partner\'s credits are taken back.
|
|
109
93
|
* Add credits to, or remove credits from, a user\'s balance
|
|
110
94
|
*/
|
|
111
95
|
adjustUserCreditsRaw(requestParameters: AdjustUserCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdjustUserCredits200Response>>;
|
|
112
96
|
/**
|
|
113
|
-
* Admin only. A positive `amount` grants free credits; a negative `amount` takes credits away (the balance must hold them). An `amount` of 0, or one that is not a finite number, is refused with 400. The `Idempotency-Key` header is required and names the adjustment: a retry with the same key replays the first result (`replayed: true`) instead of moving the balance twice, and a request without one is refused with 400. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, `POST /credits/add` and the grants route (`POST /admin-billing/grants`). Removing credits is not counted. A request over the per-request limit is refused with 400; one that would pass the daily limit is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED` (`error.details` has the limit, what was used, what is left and when the day resets). This moves a USER\'s balance.
|
|
97
|
+
* Admin only. A positive `amount` grants free credits; a negative `amount` takes credits away (the balance must hold them). An `amount` of 0, or one that is not a finite number, is refused with 400. The `Idempotency-Key` header is required and names the adjustment: a retry with the same key replays the first result (`replayed: true`) instead of moving the balance twice, and a request without one is refused with 400. Free credits are limited per admin: one request may grant at most `ADMIN_GRANT_MAX_PER_REQUEST` credits (default 5000) and one admin may grant at most `ADMIN_GRANT_DAILY_LIMIT` credits alone per UTC day (default 10000), counted across this route, `POST /credits/add` and the grants route (`POST /admin-billing/grants`). Removing credits is not counted. A request over the per-request limit is refused with 400; one that would pass the daily limit is refused with 429 and `ADMIN_GRANT_LIMIT_REACHED` (`error.details` has the limit, what was used, what is left and when the day resets). This moves a USER\'s balance, which includes the account a partner\'s builds are charged to (its administrator\'s): the credits of a paid partner invoice are added there, and a clawback of them is made here. No route writes to a partner\'s own wallet any more, so this is the one place a partner\'s credits are taken back.
|
|
114
98
|
* Add credits to, or remove credits from, a user\'s balance
|
|
115
99
|
*/
|
|
116
100
|
adjustUserCredits(requestParameters: AdjustUserCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdjustUserCredits200Response>;
|
|
@@ -135,12 +119,12 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
135
119
|
*/
|
|
136
120
|
cleanupOrphanedInvitations(requestParameters?: CleanupOrphanedInvitations0Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CleanupOrphanedInvitations200Response>;
|
|
137
121
|
/**
|
|
138
|
-
* Admin only. This is how a partner comes to exist; there is no self-serve sign-up for one. **Before calling it**, the user who will administer the partner must exist and have the `partner` role (`PUT /admin/users/{userId}/role`). Every partner route belongs to that role, so a partner administered by an ordinary user would be created and then be unusable; such a request is refused with 400 and says so. A user with the `admin` role is accepted too. **A partner has no API key of its own, and none is issued.** The administrator calls the API with the `wgt_prt_` key of their own account: they make it themselves (`POST /users/{id}/keys`, or the dashboard\'s key screen), or Widgetic staff make it for them (the same route, called by an admin). **The new partner starts inactive, and is unusable until an administrator activates it.** A partner has no trial and pays from day one, so nothing it or its customers do works yet: its embeds are not served, its editor sessions are refused and its API key can only read and manage its billing. Activate it with `PUT /admin/partners/{partnerId}/status` (`active`) once the contract and a verified storage destination are in place (`GET /admin/partners/{partnerId}/activation` lists what is missing). Sending `isActive: true` here is refused, because it would skip that check. The new partner starts with
|
|
122
|
+
* Admin only. This is how a partner comes to exist; there is no self-serve sign-up for one. **Before calling it**, the user who will administer the partner must exist and have the `partner` role (`PUT /admin/users/{userId}/role`). Every partner route belongs to that role, so a partner administered by an ordinary user would be created and then be unusable; such a request is refused with 400 and says so. A user with the `admin` role is accepted too. **A partner has no API key of its own, and none is issued.** The administrator calls the API with the `wgt_prt_` key of their own account: they make it themselves (`POST /users/{id}/keys`, or the dashboard\'s key screen), or Widgetic staff make it for them (the same route, called by an admin). **The new partner starts inactive, and is unusable until an administrator activates it.** A partner has no trial and pays from day one, so nothing it or its customers do works yet: its embeds are not served, its editor sessions are refused and its API key can only read and manage its billing. Activate it with `PUT /admin/partners/{partnerId}/status` (`active`) once the contract and a verified storage destination are in place (`GET /admin/partners/{partnerId}/activation` lists what is missing). Sending `isActive: true` here is refused, because it would skip that check. The new partner starts with no credits and no contract. It is credited by a paid invoice that carries credits (`POST /admin-billing/partner/{partnerId}/invoice`), and the contract terms are recorded with `POST /partner-customizations/{partnerId}`. Neither is a field of this request, and a field this request does not name is refused with 400 rather than ignored. Creating the partner also records the partner plan on its administrator\'s own account (`plan.partner`). A partner is not bought, so the administrator\'s account holds no subscription of its own. If that record could not be written the partner is still created (a refusal would hide that it exists, and a retry would be a 409) and `warnings` says so; sending the status `active` for the partner again (`PUT /admin/partners/{partnerId}/status`) records it. Pausing or deactivating the partner stops what it published from being served. A partner `name` is unique: one already in use is refused with 409 and nothing is created. This route takes no `Idempotency-Key`: the unique name makes a retry safe on its own. A retry after a dropped response gets 409 for the partner the first attempt created; find it with `GET /admin/partners` (`searchTerm`).
|
|
139
123
|
* Create a partner
|
|
140
124
|
*/
|
|
141
125
|
createPartnerRaw(requestParameters: CreatePartnerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerWithWarnings>>;
|
|
142
126
|
/**
|
|
143
|
-
* Admin only. This is how a partner comes to exist; there is no self-serve sign-up for one. **Before calling it**, the user who will administer the partner must exist and have the `partner` role (`PUT /admin/users/{userId}/role`). Every partner route belongs to that role, so a partner administered by an ordinary user would be created and then be unusable; such a request is refused with 400 and says so. A user with the `admin` role is accepted too. **A partner has no API key of its own, and none is issued.** The administrator calls the API with the `wgt_prt_` key of their own account: they make it themselves (`POST /users/{id}/keys`, or the dashboard\'s key screen), or Widgetic staff make it for them (the same route, called by an admin). **The new partner starts inactive, and is unusable until an administrator activates it.** A partner has no trial and pays from day one, so nothing it or its customers do works yet: its embeds are not served, its editor sessions are refused and its API key can only read and manage its billing. Activate it with `PUT /admin/partners/{partnerId}/status` (`active`) once the contract and a verified storage destination are in place (`GET /admin/partners/{partnerId}/activation` lists what is missing). Sending `isActive: true` here is refused, because it would skip that check. The new partner starts with
|
|
127
|
+
* Admin only. This is how a partner comes to exist; there is no self-serve sign-up for one. **Before calling it**, the user who will administer the partner must exist and have the `partner` role (`PUT /admin/users/{userId}/role`). Every partner route belongs to that role, so a partner administered by an ordinary user would be created and then be unusable; such a request is refused with 400 and says so. A user with the `admin` role is accepted too. **A partner has no API key of its own, and none is issued.** The administrator calls the API with the `wgt_prt_` key of their own account: they make it themselves (`POST /users/{id}/keys`, or the dashboard\'s key screen), or Widgetic staff make it for them (the same route, called by an admin). **The new partner starts inactive, and is unusable until an administrator activates it.** A partner has no trial and pays from day one, so nothing it or its customers do works yet: its embeds are not served, its editor sessions are refused and its API key can only read and manage its billing. Activate it with `PUT /admin/partners/{partnerId}/status` (`active`) once the contract and a verified storage destination are in place (`GET /admin/partners/{partnerId}/activation` lists what is missing). Sending `isActive: true` here is refused, because it would skip that check. The new partner starts with no credits and no contract. It is credited by a paid invoice that carries credits (`POST /admin-billing/partner/{partnerId}/invoice`), and the contract terms are recorded with `POST /partner-customizations/{partnerId}`. Neither is a field of this request, and a field this request does not name is refused with 400 rather than ignored. Creating the partner also records the partner plan on its administrator\'s own account (`plan.partner`). A partner is not bought, so the administrator\'s account holds no subscription of its own. If that record could not be written the partner is still created (a refusal would hide that it exists, and a retry would be a 409) and `warnings` says so; sending the status `active` for the partner again (`PUT /admin/partners/{partnerId}/status`) records it. Pausing or deactivating the partner stops what it published from being served. A partner `name` is unique: one already in use is refused with 409 and nothing is created. This route takes no `Idempotency-Key`: the unique name makes a retry safe on its own. A retry after a dropped response gets 409 for the partner the first attempt created; find it with `GET /admin/partners` (`searchTerm`).
|
|
144
128
|
* Create a partner
|
|
145
129
|
*/
|
|
146
130
|
createPartner(requestParameters: CreatePartnerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerWithWarnings>;
|
|
@@ -165,12 +149,12 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
165
149
|
*/
|
|
166
150
|
getPartnerActivation(requestParameters: GetPartnerActivationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerActivation>;
|
|
167
151
|
/**
|
|
168
|
-
* Admin only. Reads the billing profile of a partner: the legal name, the billing emails, the billing address, the tax number and the payment terms, and what the invoices will say with them. A partner that has none saved has the defaults (the partner\'s own name, its contact email,
|
|
152
|
+
* Admin only. Reads the billing profile of a partner: the legal name, the billing emails, the billing address, the tax number and the payment terms, and what the invoices will say with them. A partner that has none saved has the defaults (the partner\'s own name, its contact email, 7 days, no address), and `gaps` says what is missing for an invoice to carry the right tax. Nothing is changed by reading it.
|
|
169
153
|
* What a partner\'s invoices are addressed with
|
|
170
154
|
*/
|
|
171
155
|
getPartnerBillingProfileRaw(requestParameters: GetPartnerBillingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerBillingProfileView>>;
|
|
172
156
|
/**
|
|
173
|
-
* Admin only. Reads the billing profile of a partner: the legal name, the billing emails, the billing address, the tax number and the payment terms, and what the invoices will say with them. A partner that has none saved has the defaults (the partner\'s own name, its contact email,
|
|
157
|
+
* Admin only. Reads the billing profile of a partner: the legal name, the billing emails, the billing address, the tax number and the payment terms, and what the invoices will say with them. A partner that has none saved has the defaults (the partner\'s own name, its contact email, 7 days, no address), and `gaps` says what is missing for an invoice to carry the right tax. Nothing is changed by reading it.
|
|
174
158
|
* What a partner\'s invoices are addressed with
|
|
175
159
|
*/
|
|
176
160
|
getPartnerBillingProfile(requestParameters: GetPartnerBillingProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerBillingProfileView>;
|
|
@@ -185,12 +169,12 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
185
169
|
*/
|
|
186
170
|
getPartnerBillingReport(requestParameters: GetPartnerBillingReportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerBillingReport>;
|
|
187
171
|
/**
|
|
188
|
-
* Admin only. The partner, with three things an administrator needs beside it: the billing overview (wallet,
|
|
172
|
+
* Admin only. The partner, with three things an administrator needs beside it: the billing overview (wallet, the ten newest ledger rows, the contract if one is recorded), the statistics of the last month\'s wallet activity, and a little metadata. The overview and the statistics are read at request time and are `null` when they could not be assembled: the partner itself is still returned. `monthlyStats.userCount` is `null` while the partner\'s member list cannot be read.
|
|
189
173
|
* Get a partner with its billing overview and last month\'s statistics
|
|
190
174
|
*/
|
|
191
175
|
getPartnerDetailsRaw(requestParameters: GetPartnerDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerDetails>>;
|
|
192
176
|
/**
|
|
193
|
-
* Admin only. The partner, with three things an administrator needs beside it: the billing overview (wallet,
|
|
177
|
+
* Admin only. The partner, with three things an administrator needs beside it: the billing overview (wallet, the ten newest ledger rows, the contract if one is recorded), the statistics of the last month\'s wallet activity, and a little metadata. The overview and the statistics are read at request time and are `null` when they could not be assembled: the partner itself is still returned. `monthlyStats.userCount` is `null` while the partner\'s member list cannot be read.
|
|
194
178
|
* Get a partner with its billing overview and last month\'s statistics
|
|
195
179
|
*/
|
|
196
180
|
getPartnerDetails(requestParameters: GetPartnerDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerDetails>;
|
|
@@ -204,6 +188,16 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
204
188
|
* What is set for a partner\'s editor sessions
|
|
205
189
|
*/
|
|
206
190
|
getPartnerEditorSessionSettings(requestParameters: GetPartnerEditorSessionSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEditorSessionSettings>;
|
|
191
|
+
/**
|
|
192
|
+
* Admin only. Shows what the daily invoicing run does with a partner\'s contract: the terms it runs on, the invoice that goes out next (the period, the day, the credits, the price of a credit and the amount before tax), the periods the run has taken so far with where each invoice stands, and the contract invoices the partner owes past their due day. The first invoice goes out on the contract\'s start date, the others 7 days before their period starts, for the credits of the period at the contract\'s price of a credit; the credits are added when the invoice is paid and expire when the period ends. `next` is worked out with the rules the run uses, so it is what the next run will do, including why it will not issue anything (`blocked`). Nothing is changed by reading it.
|
|
193
|
+
* When a partner\'s contract is invoiced next, and what it owes
|
|
194
|
+
*/
|
|
195
|
+
getPartnerInvoiceScheduleRaw(requestParameters: GetPartnerInvoiceScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerInvoiceSchedule>>;
|
|
196
|
+
/**
|
|
197
|
+
* Admin only. Shows what the daily invoicing run does with a partner\'s contract: the terms it runs on, the invoice that goes out next (the period, the day, the credits, the price of a credit and the amount before tax), the periods the run has taken so far with where each invoice stands, and the contract invoices the partner owes past their due day. The first invoice goes out on the contract\'s start date, the others 7 days before their period starts, for the credits of the period at the contract\'s price of a credit; the credits are added when the invoice is paid and expire when the period ends. `next` is worked out with the rules the run uses, so it is what the next run will do, including why it will not issue anything (`blocked`). Nothing is changed by reading it.
|
|
198
|
+
* When a partner\'s contract is invoiced next, and what it owes
|
|
199
|
+
*/
|
|
200
|
+
getPartnerInvoiceSchedule(requestParameters: GetPartnerInvoiceScheduleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerInvoiceSchedule>;
|
|
207
201
|
/**
|
|
208
202
|
* Admin only. `scope=mine` is the signed-in admin\'s widgets. `scope=others` is every other account. `scope=all` is every account. `preset=true` keeps widgets marked for signup copy. A normal account cannot call this route.
|
|
209
203
|
* List widgets for the admin console
|
|
@@ -225,33 +219,23 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
225
219
|
*/
|
|
226
220
|
listPartners(requestParameters?: ListPartnersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerList>;
|
|
227
221
|
/**
|
|
228
|
-
* Admin only. For an invoice that was paid by bank transfer, cheque or any other way outside Stripe. It marks the invoice paid in Stripe (`paid_out_of_band`), and Stripe then reports the payment exactly as it reports a card payment: the partner\'s invoice list is brought up to date (status and paid date), the reminders stop, the partner receives its receipt, and the administrators are told the payment arrived. Nothing is written to the partner\'s invoice list here, so the list changes a moment after the answer, when Stripe\'s report arrives; an administrator never updates a status by hand. The invoice is named by its id in the partner\'s invoice list and must belong to this partner. An invoice Stripe already holds as paid is answered (`recorded: false`) and nothing happens again, so a double click or a retry is safe. An invoice Stripe holds as void, uncollectible or still a draft cannot be marked paid (409 `INVOICE_NOT_PAYABLE`), and one that was never issued through Stripe has nothing to mark (409 `INVOICE_HAS_NO_STRIPE_INVOICE`). The audit trail records who recorded it, with the optional `note` (a bank reference, say).
|
|
222
|
+
* Admin only. For an invoice that was paid by bank transfer, cheque or any other way outside Stripe. It marks the invoice paid in Stripe (`paid_out_of_band`), and Stripe then reports the payment exactly as it reports a card payment: the partner\'s invoice list is brought up to date (status and paid date), the reminders stop, the partner receives its receipt, and the administrators are told the payment arrived. An invoice that was issued for credits (`credits` on `issuePartnerInvoice`) also adds them to the partner administrator\'s account at that moment, once. Nothing is written to the partner\'s invoice list here, so the list changes a moment after the answer, when Stripe\'s report arrives; an administrator never updates a status by hand. The invoice is named by its id in the partner\'s invoice list and must belong to this partner. An invoice Stripe already holds as paid is answered (`recorded: false`) and nothing happens again, so a double click or a retry is safe. An invoice Stripe holds as void, uncollectible or still a draft cannot be marked paid (409 `INVOICE_NOT_PAYABLE`), and one that was never issued through Stripe has nothing to mark (409 `INVOICE_HAS_NO_STRIPE_INVOICE`). The audit trail records who recorded it, with the optional `note` (a bank reference, say).
|
|
229
223
|
* Record a payment that arrived outside Stripe
|
|
230
224
|
*/
|
|
231
225
|
recordPartnerInvoicePaymentRaw(requestParameters: RecordPartnerInvoicePaymentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecordedPartnerPayment>>;
|
|
232
226
|
/**
|
|
233
|
-
* Admin only. For an invoice that was paid by bank transfer, cheque or any other way outside Stripe. It marks the invoice paid in Stripe (`paid_out_of_band`), and Stripe then reports the payment exactly as it reports a card payment: the partner\'s invoice list is brought up to date (status and paid date), the reminders stop, the partner receives its receipt, and the administrators are told the payment arrived. Nothing is written to the partner\'s invoice list here, so the list changes a moment after the answer, when Stripe\'s report arrives; an administrator never updates a status by hand. The invoice is named by its id in the partner\'s invoice list and must belong to this partner. An invoice Stripe already holds as paid is answered (`recorded: false`) and nothing happens again, so a double click or a retry is safe. An invoice Stripe holds as void, uncollectible or still a draft cannot be marked paid (409 `INVOICE_NOT_PAYABLE`), and one that was never issued through Stripe has nothing to mark (409 `INVOICE_HAS_NO_STRIPE_INVOICE`). The audit trail records who recorded it, with the optional `note` (a bank reference, say).
|
|
227
|
+
* Admin only. For an invoice that was paid by bank transfer, cheque or any other way outside Stripe. It marks the invoice paid in Stripe (`paid_out_of_band`), and Stripe then reports the payment exactly as it reports a card payment: the partner\'s invoice list is brought up to date (status and paid date), the reminders stop, the partner receives its receipt, and the administrators are told the payment arrived. An invoice that was issued for credits (`credits` on `issuePartnerInvoice`) also adds them to the partner administrator\'s account at that moment, once. Nothing is written to the partner\'s invoice list here, so the list changes a moment after the answer, when Stripe\'s report arrives; an administrator never updates a status by hand. The invoice is named by its id in the partner\'s invoice list and must belong to this partner. An invoice Stripe already holds as paid is answered (`recorded: false`) and nothing happens again, so a double click or a retry is safe. An invoice Stripe holds as void, uncollectible or still a draft cannot be marked paid (409 `INVOICE_NOT_PAYABLE`), and one that was never issued through Stripe has nothing to mark (409 `INVOICE_HAS_NO_STRIPE_INVOICE`). The audit trail records who recorded it, with the optional `note` (a bank reference, say).
|
|
234
228
|
* Record a payment that arrived outside Stripe
|
|
235
229
|
*/
|
|
236
230
|
recordPartnerInvoicePayment(requestParameters: RecordPartnerInvoicePaymentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecordedPartnerPayment>;
|
|
237
231
|
/**
|
|
238
|
-
* Admin only.
|
|
239
|
-
*
|
|
240
|
-
*/
|
|
241
|
-
refundPartnerCreditsRaw(requestParameters: RefundPartnerCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
242
|
-
/**
|
|
243
|
-
* Admin only. Adds `amount` credits to the partner wallet as a refund. The `Idempotency-Key` header is required: a retry with the same key replays the first refund instead of issuing a second one. A refund is held to the same ceiling as a top-up: **at most $100,000 per operation** (1,000,000 credits at $0.10 per credit). A larger amount is refused with 400 and nothing is credited.
|
|
244
|
-
* Credit a partner\'s wallet back with a refund
|
|
245
|
-
*/
|
|
246
|
-
refundPartnerCredits(requestParameters: RefundPartnerCreditsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
247
|
-
/**
|
|
248
|
-
* Admin only. Every field is optional; send the ones to change. The profile fields (`name`, `email`, `webhookUrl`, `allowedDomains`, `billingSettings`) are stored on the partner. `autoReloadAmount` and `autoReloadThreshold` are stored with the partner\'s auto-reload settings, which are a different record: an edit to one of them keeps the other and the rest of the configuration. `creditBalance` is a **target balance**, not a stored value. The wallet is moved by the difference between it and the balance the ledger holds now, as a ledger row, by the same keyed path `POST /admin/partners/{partnerId}/credits` uses. So a request that sets it **must** carry an `Idempotency-Key` (a request without one is refused with 400 and changes nothing, not even the fields beside it), a top-up is held to the same ceiling of $100,000 per operation, and a retry with the same key replays the first result instead of moving the wallet twice. `notes` becomes the reason on that ledger row. A request that sets no balance needs no key. `isActive` only flips the switch, and goes through the same check as `PUT /admin/partners/{partnerId}/status`: activating a partner that was never activated is refused with 409 `PARTNER_NOT_READY` until its contract and storage destination are in place, and the fields beside it are not written when it is refused. To pause a partner with a recorded reason, or to resume one so that everything the pause turned off is restored, use `PUT /admin/partners/{partnerId}/status`. The response is the partner as it is after the edit; `creditAdjustment` and `autoReload` report what was done to the wallet and the settings, when the request touched them.
|
|
249
|
-
* Edit a partner\'s profile, wallet balance or auto-reload settings
|
|
232
|
+
* Admin only. Every field is optional; send the ones to change. The profile fields (`name`, `email`, `webhookUrl`, `allowedDomains`, `platformDomain`, `billingSettings`) are stored on the partner. This route no longer touches the partner\'s wallet, and four fields it used to accept are retired: `autoReloadAmount` and `autoReloadThreshold` (a wallet is not reloaded automatically), `creditBalance` (a wallet is not set to a balance by hand) and `notes` (the reason that went with a balance change). A request that carries any of them is refused with 400 that names it, and nothing in the request is written, not even the fields beside it. Credits come with a paid partner invoice (`POST /admin-billing/partner/{partnerId}/invoice` with `credits`), and they are added to the partner\'s administrator\'s account; a clawback of them is made on that account, with `POST /admin/billing/credits/adjust`. `isActive` only flips the switch, and goes through the same check as `PUT /admin/partners/{partnerId}/status`: activating a partner that was never activated is refused with 409 `PARTNER_NOT_READY` until its contract and storage destination are in place, and the fields beside it are not written when it is refused. To pause a partner with a recorded reason, or to resume one so that everything the pause turned off is restored, use `PUT /admin/partners/{partnerId}/status`. The response is the partner as it is after the edit.
|
|
233
|
+
* Edit a partner\'s profile
|
|
250
234
|
*/
|
|
251
235
|
updatePartnerRaw(requestParameters: UpdatePartnerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerUpdateResult>>;
|
|
252
236
|
/**
|
|
253
|
-
* Admin only. Every field is optional; send the ones to change. The profile fields (`name`, `email`, `webhookUrl`, `allowedDomains`, `billingSettings`) are stored on the partner.
|
|
254
|
-
* Edit a partner\'s profile
|
|
237
|
+
* Admin only. Every field is optional; send the ones to change. The profile fields (`name`, `email`, `webhookUrl`, `allowedDomains`, `platformDomain`, `billingSettings`) are stored on the partner. This route no longer touches the partner\'s wallet, and four fields it used to accept are retired: `autoReloadAmount` and `autoReloadThreshold` (a wallet is not reloaded automatically), `creditBalance` (a wallet is not set to a balance by hand) and `notes` (the reason that went with a balance change). A request that carries any of them is refused with 400 that names it, and nothing in the request is written, not even the fields beside it. Credits come with a paid partner invoice (`POST /admin-billing/partner/{partnerId}/invoice` with `credits`), and they are added to the partner\'s administrator\'s account; a clawback of them is made on that account, with `POST /admin/billing/credits/adjust`. `isActive` only flips the switch, and goes through the same check as `PUT /admin/partners/{partnerId}/status`: activating a partner that was never activated is refused with 409 `PARTNER_NOT_READY` until its contract and storage destination are in place, and the fields beside it are not written when it is refused. To pause a partner with a recorded reason, or to resume one so that everything the pause turned off is restored, use `PUT /admin/partners/{partnerId}/status`. The response is the partner as it is after the edit.
|
|
238
|
+
* Edit a partner\'s profile
|
|
255
239
|
*/
|
|
256
240
|
updatePartner(requestParameters: UpdatePartnerOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerUpdateResult>;
|
|
257
241
|
/**
|
|
@@ -275,12 +259,12 @@ export declare class AdminApi extends runtime.BaseAPI {
|
|
|
275
259
|
*/
|
|
276
260
|
updatePartnerEditorSessionSettings(requestParameters: UpdatePartnerEditorSessionSettingsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerEditorSessionSettings>;
|
|
277
261
|
/**
|
|
278
|
-
* Admin only. Sets the partner\'s standing (the `status` field every partner response carries). - `active` activates a new partner, or resumes a paused one: it is switched on, and a suspension\'s reason and time are cleared. **Activating a partner that was never activated (or was deactivated) is refused with 409 `PARTNER_NOT_READY` until a contract is in force and a verified storage destination is set** (`error.details.requirements` lists each, and `GET /admin/partners/{partnerId}/activation` reads them without changing anything). Resuming a paused partner is never held up by that. It also records the partner plan on the partner\'s administrator again if that was missing (a partner created before the plan was recorded, or whose write failed); if that could not be done the partner is still reinstated and `warnings` says so. - `inactive` switches the partner off without a reason; a suspension\'s reason and time are cleared, so a partner moved from suspended to inactive is no longer reported as suspended. - `suspended` is the pause: it switches the partner off and records `reason` (default `Suspended by admin`) and the time. It is manual only. An unpaid invoice is chased and reported to the administrators,
|
|
262
|
+
* Admin only. Sets the partner\'s standing (the `status` field every partner response carries). - `active` activates a new partner, or resumes a paused one: it is switched on, and a suspension\'s reason and time are cleared. **Activating a partner that was never activated (or was deactivated) is refused with 409 `PARTNER_NOT_READY` until a contract is in force and a verified storage destination is set** (`error.details.requirements` lists each, and `GET /admin/partners/{partnerId}/activation` reads them without changing anything). Resuming a paused partner is never held up by that. It also records the partner plan on the partner\'s administrator again if that was missing (a partner created before the plan was recorded, or whose write failed); if that could not be done the partner is still reinstated and `warnings` says so. - `inactive` switches the partner off without a reason; a suspension\'s reason and time are cleared, so a partner moved from suspended to inactive is no longer reported as suspended. - `suspended` is the pause: it switches the partner off and records `reason` (default `Suspended by admin`) and the time. It is manual only. An unpaid invoice is chased and reported to the administrators, and never pauses a partner by itself: a contract invoice left unpaid past its due date STOPS the partner on its own from the day after (standing `payment_arrears`, refused with 403 `PARTNER_PAYMENT_ARREARS`). That records nothing on the partner and is not a status you set: it ends the moment the invoice is paid, voided or written off, and an invoice for extra credits never causes it. While a partner is not `active` it is unusable, and what it published is not served: its embeds answer as if they did not exist, editor sessions are refused, its customers cannot create or generate anything, and every write or generation by its API key is refused with 403 `PARTNER_SUSPENDED` (or `PARTNER_INACTIVE`). This takes hold within 15 seconds at most, on every instance. The partner\'s own administrator can still sign in and use billing, invoices, credits, the contract and notifications. Resuming the partner restores everything, with no new token for a customer. A person who administers two partners is served while either is active, and an administrator account that also holds a subscription of its own is served on that. Sending the standing the partner already has is accepted; for `suspended` it replaces the recorded reason and time.
|
|
279
263
|
* Activate, deactivate or suspend a partner
|
|
280
264
|
*/
|
|
281
265
|
updatePartnerStatusRaw(requestParameters: UpdatePartnerStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PartnerWithWarnings>>;
|
|
282
266
|
/**
|
|
283
|
-
* Admin only. Sets the partner\'s standing (the `status` field every partner response carries). - `active` activates a new partner, or resumes a paused one: it is switched on, and a suspension\'s reason and time are cleared. **Activating a partner that was never activated (or was deactivated) is refused with 409 `PARTNER_NOT_READY` until a contract is in force and a verified storage destination is set** (`error.details.requirements` lists each, and `GET /admin/partners/{partnerId}/activation` reads them without changing anything). Resuming a paused partner is never held up by that. It also records the partner plan on the partner\'s administrator again if that was missing (a partner created before the plan was recorded, or whose write failed); if that could not be done the partner is still reinstated and `warnings` says so. - `inactive` switches the partner off without a reason; a suspension\'s reason and time are cleared, so a partner moved from suspended to inactive is no longer reported as suspended. - `suspended` is the pause: it switches the partner off and records `reason` (default `Suspended by admin`) and the time. It is manual only. An unpaid invoice is chased and reported to the administrators,
|
|
267
|
+
* Admin only. Sets the partner\'s standing (the `status` field every partner response carries). - `active` activates a new partner, or resumes a paused one: it is switched on, and a suspension\'s reason and time are cleared. **Activating a partner that was never activated (or was deactivated) is refused with 409 `PARTNER_NOT_READY` until a contract is in force and a verified storage destination is set** (`error.details.requirements` lists each, and `GET /admin/partners/{partnerId}/activation` reads them without changing anything). Resuming a paused partner is never held up by that. It also records the partner plan on the partner\'s administrator again if that was missing (a partner created before the plan was recorded, or whose write failed); if that could not be done the partner is still reinstated and `warnings` says so. - `inactive` switches the partner off without a reason; a suspension\'s reason and time are cleared, so a partner moved from suspended to inactive is no longer reported as suspended. - `suspended` is the pause: it switches the partner off and records `reason` (default `Suspended by admin`) and the time. It is manual only. An unpaid invoice is chased and reported to the administrators, and never pauses a partner by itself: a contract invoice left unpaid past its due date STOPS the partner on its own from the day after (standing `payment_arrears`, refused with 403 `PARTNER_PAYMENT_ARREARS`). That records nothing on the partner and is not a status you set: it ends the moment the invoice is paid, voided or written off, and an invoice for extra credits never causes it. While a partner is not `active` it is unusable, and what it published is not served: its embeds answer as if they did not exist, editor sessions are refused, its customers cannot create or generate anything, and every write or generation by its API key is refused with 403 `PARTNER_SUSPENDED` (or `PARTNER_INACTIVE`). This takes hold within 15 seconds at most, on every instance. The partner\'s own administrator can still sign in and use billing, invoices, credits, the contract and notifications. Resuming the partner restores everything, with no new token for a customer. A person who administers two partners is served while either is active, and an administrator account that also holds a subscription of its own is served on that. Sending the standing the partner already has is accepted; for `suspended` it replaces the recorded reason and time.
|
|
284
268
|
* Activate, deactivate or suspend a partner
|
|
285
269
|
*/
|
|
286
270
|
updatePartnerStatus(requestParameters: UpdatePartnerStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PartnerWithWarnings>;
|