api-sdk-rb 1.11.66
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/LICENSE +122 -0
- data/README.md +648 -0
- data/Rakefile +10 -0
- data/api-sdk-rb.gemspec +39 -0
- data/docs/AccountCreditBalance.md +26 -0
- data/docs/AccountCreditBalanceResponse.md +22 -0
- data/docs/AccountCreditTransaction.md +30 -0
- data/docs/AdapterConnection.md +30 -0
- data/docs/AdapterConnectionRemoval.md +18 -0
- data/docs/AddAiAnswersKnowledgeDocument201Response.md +22 -0
- data/docs/AddAiAnswersKnowledgeDocumentRequest.md +20 -0
- data/docs/AddDomainRequest.md +18 -0
- data/docs/AiAnswersKnowledge.md +20 -0
- data/docs/AiAnswersKnowledgeDocument.md +30 -0
- data/docs/AiAnswersKnowledgeRemoval.md +18 -0
- data/docs/AiAnswersKnowledgeTotals.md +24 -0
- data/docs/ApiKeyScope.md +15 -0
- data/docs/Canvas.md +32 -0
- data/docs/CanvasResponse.md +22 -0
- data/docs/CanvasesApi.md +377 -0
- data/docs/CheckCompositionAccessResponse.md +22 -0
- data/docs/CheckCompositionAccessResponseData.md +20 -0
- data/docs/Composition.md +46 -0
- data/docs/CompositionDataSource.md +20 -0
- data/docs/CompositionDataSourceResponse.md +22 -0
- data/docs/CompositionEntriesDescription.md +22 -0
- data/docs/CompositionEntriesDescriptionResponse.md +22 -0
- data/docs/CompositionEntriesReading.md +34 -0
- data/docs/CompositionEntriesReadingResponse.md +22 -0
- data/docs/CompositionEntryAggregateTally.md +28 -0
- data/docs/CompositionEntryAggregatesBlock.md +22 -0
- data/docs/CompositionEntryColumn.md +20 -0
- data/docs/CompositionEntryDeleteSuccess.md +20 -0
- data/docs/CompositionEntryDeleteSuccessData.md +18 -0
- data/docs/CompositionEntryItem.md +26 -0
- data/docs/CompositionEntryItemsMeta.md +22 -0
- data/docs/CompositionEntryItemsPageSuccess.md +22 -0
- data/docs/CompositionEntryTable.md +22 -0
- data/docs/CompositionEntryTally.md +20 -0
- data/docs/CompositionResponse.md +22 -0
- data/docs/CompositionVersion.md +26 -0
- data/docs/CompositionsApi.md +2768 -0
- data/docs/ContentCheckFinding.md +24 -0
- data/docs/ContentItemWriteResult.md +28 -0
- data/docs/ContentItemWriteResultValidationResult.md +22 -0
- data/docs/CopyPartnerPresetRequest.md +18 -0
- data/docs/CreateCanvasRequest.md +28 -0
- data/docs/CreateCompositionContentItem201Response.md +22 -0
- data/docs/CreateCompositionContentItemRequest.md +18 -0
- data/docs/CreateCompositionDatabaseRecord201Response.md +22 -0
- data/docs/CreateCompositionFromPresetRequest.md +26 -0
- data/docs/CreateCompositionFromWidget201Response.md +22 -0
- data/docs/CreateCompositionFromWidgetRequest.md +28 -0
- data/docs/CreateUserApiKeyRequest.md +24 -0
- data/docs/CreateWidget201Response.md +22 -0
- data/docs/CreateWidget201ResponseData.md +62 -0
- data/docs/CreatedUserApiKey.md +34 -0
- data/docs/CreatedUserApiKeyResponse.md +22 -0
- data/docs/CreditsApi.md +155 -0
- data/docs/DeleteCompositionContentItemResponse.md +22 -0
- data/docs/DeleteCompositionContentItemResponseData.md +20 -0
- data/docs/DeleteCompositionDataSourceResponse.md +22 -0
- data/docs/DeleteCompositionDataSourceResponseData.md +18 -0
- data/docs/DeleteManagedUser200Response.md +22 -0
- data/docs/DeletePersonalWorkspaceDomainResponse.md +22 -0
- data/docs/DeletePersonalWorkspaceDomainResponseData.md +18 -0
- data/docs/DeleteUserApiKeyResponse.md +22 -0
- data/docs/DeleteUserApiKeyResponseData.md +18 -0
- data/docs/DesignDefaults.md +18 -0
- data/docs/DuplicateComposition202Response.md +22 -0
- data/docs/DuplicateComposition202ResponseData.md +18 -0
- data/docs/DuplicateCompositionRequest.md +20 -0
- data/docs/EditorSession.md +34 -0
- data/docs/EditorSessionResponse.md +22 -0
- data/docs/Entitlement.md +38 -0
- data/docs/EntitlementsApi.md +163 -0
- data/docs/ErrorDetail.md +34 -0
- data/docs/ErrorResponse.md +22 -0
- data/docs/ExportCompositionEntryItems200Response.md +22 -0
- data/docs/ExportCompositionEntryItems200ResponseMeta.md +20 -0
- data/docs/GetAiAnswersKnowledge200Response.md +22 -0
- data/docs/GetAllCanvasesResponse.md +22 -0
- data/docs/GetAllCanvasesResponseData.md +24 -0
- data/docs/GetAllCompositions200Response.md +22 -0
- data/docs/GetAllManagedUsers200Response.md +22 -0
- data/docs/GetCompositionContentResponse.md +22 -0
- data/docs/GetCompositionContentSchemaResponse.md +22 -0
- data/docs/GetCompositionContentSchemaResponseData.md +28 -0
- data/docs/GetCompositionDataSourceResponse.md +22 -0
- data/docs/GetCompositionDatabaseRecords200Response.md +22 -0
- data/docs/GetCompositionDesignResponse.md +22 -0
- data/docs/GetCompositionDesignSchemaResponse.md +22 -0
- data/docs/GetCompositionDesignSchemaResponseData.md +28 -0
- data/docs/GetCompositionEmbedSchemaResponse.md +22 -0
- data/docs/GetCompositionEmbedSchemaResponseData.md +28 -0
- data/docs/GetCompositionEmbedSettingsResponse.md +22 -0
- data/docs/GetCompositionPreviewResponse.md +22 -0
- data/docs/GetCompositionPreviewResponseData.md +24 -0
- data/docs/GetCompositionVersions200Response.md +22 -0
- data/docs/GetCompositionsBatchRequest.md +18 -0
- data/docs/GetCompositionsBatchResponse.md +22 -0
- data/docs/GetCompositionsBatchResponseData.md +20 -0
- data/docs/GetInvoicesByPartnerId200Response.md +22 -0
- data/docs/GetManagedUserEntitlementsResponse.md +22 -0
- data/docs/GetManagedUserEntitlementsResponseData.md +20 -0
- data/docs/GetManagedUserLimits200Response.md +22 -0
- data/docs/GetManagedUserStorageUsage200Response.md +22 -0
- data/docs/GetManagedUserStorageUsage200ResponseData.md +22 -0
- data/docs/GetManagedUserStorageUsage200ResponseDataByPurpose.md +24 -0
- data/docs/GetManagedUsersByManagerIdResponse.md +22 -0
- data/docs/GetManagedUsersByManagerIdResponseData.md +24 -0
- data/docs/GetPartnerBillingOverview200Response.md +22 -0
- data/docs/GetPartnerCreditTransactions200Response.md +22 -0
- data/docs/GetPartnerDesignDefaults200Response.md +22 -0
- data/docs/GetPartnerEntitlementsResponse.md +22 -0
- data/docs/GetPartnerEntitlementsResponseData.md +20 -0
- data/docs/GetPersonalWorkspaceDomains200Response.md +22 -0
- data/docs/GetPublicCompositionEmbed200Response.md +46 -0
- data/docs/GetPublicCompositionEmbed200ResponseDataSource.md +20 -0
- data/docs/GetPublicCompositionEmbed200ResponseDirect.md +22 -0
- data/docs/GetUserAdapterConnections200Response.md +22 -0
- data/docs/GetUserApiKeyUsageLogsResponse.md +22 -0
- data/docs/GetUserApiKeyUsageLogsResponseData.md +18 -0
- data/docs/GetUserApiKeys200Response.md +22 -0
- data/docs/GetWidgets200Response.md +22 -0
- data/docs/GetWidgetsBatchRequest.md +18 -0
- data/docs/GetWidgetsBatchResponse.md +22 -0
- data/docs/GetWidgetsBatchResponseData.md +20 -0
- data/docs/GetWidgetsBatchResponseDataErrorsInner.md +20 -0
- data/docs/InvoicesApi.md +85 -0
- data/docs/ListPartnerPresets200Response.md +22 -0
- data/docs/ManagedUser.md +30 -0
- data/docs/ManagedUserEntriesMeta.md +26 -0
- data/docs/ManagedUserEntriesPageSuccess.md +22 -0
- data/docs/ManagedUserEntryItem.md +30 -0
- data/docs/ManagedUserLimits.md +24 -0
- data/docs/ManagedUserOperationUsage.md +26 -0
- data/docs/ManagedUserRemoval.md +20 -0
- data/docs/ManagedUserResponse.md +22 -0
- data/docs/ManagedUserUsage.md +28 -0
- data/docs/ManagedUserUsageResponse.md +22 -0
- data/docs/ManagedUserUsageTotals.md +24 -0
- data/docs/ManagedUsersApi.md +1239 -0
- data/docs/MyPartner.md +34 -0
- data/docs/MyPartners.md +22 -0
- data/docs/MyPartnersResponse.md +22 -0
- data/docs/NewComposition.md +38 -0
- data/docs/NewEditorSession.md +24 -0
- data/docs/NewManagedUser.md +22 -0
- data/docs/NewWidget.md +38 -0
- data/docs/OperationsApi.md +77 -0
- data/docs/OperationsIdGetResponse.md +22 -0
- data/docs/OperationsIdGetResponseData.md +32 -0
- data/docs/PartnerAnalyticsByManagedUser.md +24 -0
- data/docs/PartnerAnalyticsByManagedUserResponse.md +22 -0
- data/docs/PartnerAnalyticsOfDay.md +24 -0
- data/docs/PartnerAnalyticsOfManagedUser.md +36 -0
- data/docs/PartnerAnalyticsOfWidget.md +28 -0
- data/docs/PartnerAnalyticsSummary.md +32 -0
- data/docs/PartnerAnalyticsSummaryResponse.md +22 -0
- data/docs/PartnerAnalyticsTimeline.md +24 -0
- data/docs/PartnerAnalyticsTimelineResponse.md +22 -0
- data/docs/PartnerAnalyticsTopWidgets.md +24 -0
- data/docs/PartnerAnalyticsTopWidgetsResponse.md +22 -0
- data/docs/PartnerApi.md +9892 -0
- data/docs/PartnerBillingOverview.md +24 -0
- data/docs/PartnerBillingOverviewBillingIntegration.md +24 -0
- data/docs/PartnerBillingOverviewOperationalCredits.md +24 -0
- data/docs/PartnerBillingOverviewPartner.md +24 -0
- data/docs/PartnerContract.md +48 -0
- data/docs/PartnerContractResponse.md +22 -0
- data/docs/PartnerCustomization.md +50 -0
- data/docs/PartnerDataDatabase.md +32 -0
- data/docs/PartnerDataDatabaseRemoval.md +18 -0
- data/docs/PartnerDataDatabaseRemovalResponse.md +22 -0
- data/docs/PartnerDataDatabaseResponse.md +22 -0
- data/docs/PartnerEntryContextSecret.md +20 -0
- data/docs/PartnerEntryContextSecretResponse.md +22 -0
- data/docs/PartnerEntryContextSigning.md +28 -0
- data/docs/PartnerEntryContextSigningResponse.md +22 -0
- data/docs/PartnerExtraCreditsInvoice.md +40 -0
- data/docs/PartnerExtraCreditsInvoiceResponse.md +22 -0
- data/docs/PartnerInvoice.md +64 -0
- data/docs/PartnerNotification.md +30 -0
- data/docs/PartnerNotificationDefaultRecipients.md +20 -0
- data/docs/PartnerNotificationDelivery.md +46 -0
- data/docs/PartnerNotificationDeliveryLog.md +18 -0
- data/docs/PartnerNotificationDeliveryLogResponse.md +22 -0
- data/docs/PartnerNotificationDeliveryResponse.md +22 -0
- data/docs/PartnerNotificationEvent.md +28 -0
- data/docs/PartnerNotificationEventType.md +15 -0
- data/docs/PartnerNotificationPage.md +20 -0
- data/docs/PartnerNotificationPageResponse.md +22 -0
- data/docs/PartnerNotificationSettings.md +36 -0
- data/docs/PartnerNotificationSettingsChange.md +20 -0
- data/docs/PartnerNotificationSettingsChangeResponse.md +22 -0
- data/docs/PartnerNotificationSettingsResponse.md +22 -0
- data/docs/PartnerNotificationTestEventRequest.md +18 -0
- data/docs/PartnerNotificationTestEventResult.md +24 -0
- data/docs/PartnerNotificationTestEventResultResponse.md +22 -0
- data/docs/PartnerPreset.md +34 -0
- data/docs/PartnerPresetCopy.md +28 -0
- data/docs/PartnerPresetCopyResponse.md +22 -0
- data/docs/PartnerPresetRemoval.md +18 -0
- data/docs/PartnerPresetRemovalResponse.md +22 -0
- data/docs/PartnerPresetResponse.md +22 -0
- data/docs/PartnerReportPage.md +22 -0
- data/docs/PartnerReportPeriod.md +20 -0
- data/docs/PartnerStorageDestination.md +40 -0
- data/docs/PartnerStorageDestinationResponse.md +22 -0
- data/docs/PartnerStorageRemoval.md +18 -0
- data/docs/PartnerStorageRemovalResponse.md +22 -0
- data/docs/PartnerStorageUsage.md +24 -0
- data/docs/PartnerStorageUsageOfManagedUser.md +34 -0
- data/docs/PartnerStorageUsageResponse.md +22 -0
- data/docs/PartnerStorageUsageTotals.md +24 -0
- data/docs/PartnersApi.md +2708 -0
- data/docs/PersonalWorkspaceDomain.md +26 -0
- data/docs/PersonalWorkspaceDomainResult.md +20 -0
- data/docs/PersonalWorkspaceDomainResultResponse.md +22 -0
- data/docs/PostPublicCompositionEmbedStatus200Response.md +22 -0
- data/docs/PostPublicCompositionEmbedStatus200ResponseData.md +18 -0
- data/docs/PostPublicCompositionEmbedStatusRequest.md +18 -0
- data/docs/PublicAdapterCallError.md +24 -0
- data/docs/PublicAdapterCallRequest.md +26 -0
- data/docs/PublicAdapterCallResult.md +20 -0
- data/docs/PublicAdapterCallResultData.md +18 -0
- data/docs/PublicAdapterFileResult.md +20 -0
- data/docs/PublicAdapterFileResultData.md +18 -0
- data/docs/PublicAdapterFileResultDataFile.md +28 -0
- data/docs/PublicCompositionEntryCreated.md +20 -0
- data/docs/PublicCompositionEntryCreatedData.md +22 -0
- data/docs/PublicCompositionEntryRequest.md +22 -0
- data/docs/PublicEmbedApi.md +415 -0
- data/docs/PublicEmbedFailure.md +28 -0
- data/docs/PublicEmbedFailureDetails.md +20 -0
- data/docs/PublicEmbedFailureError.md +28 -0
- data/docs/PurposeStorageBucket.md +20 -0
- data/docs/RemoveAiAnswersKnowledgeDocument200Response.md +22 -0
- data/docs/RemoveUserAdapterConnection200Response.md +22 -0
- data/docs/RequestExtraCredits.md +18 -0
- data/docs/ResponseMeta.md +34 -0
- data/docs/RevokeManagedUserEditorSessionsResponse.md +22 -0
- data/docs/RevokeManagedUserEditorSessionsResponseData.md +18 -0
- data/docs/SetAdapterConnectionRequest.md +18 -0
- data/docs/SetCompositionDataSourceRequest.md +20 -0
- data/docs/SetDynamicContentRequest.md +26 -0
- data/docs/SetDynamicContentResponse.md +22 -0
- data/docs/SetDynamicContentResponseData.md +26 -0
- data/docs/SetDynamicContentResponseDataValidationResult.md +22 -0
- data/docs/SetManagedUserLimitsRequest.md +18 -0
- data/docs/SetPartnerDataDatabaseRequest.md +18 -0
- data/docs/SetPartnerDesignDefaultsRequest.md +18 -0
- data/docs/SetPartnerPresetRequest.md +24 -0
- data/docs/SetPartnerStorageDestinationRequest.md +32 -0
- data/docs/SetUserAdapterConnection200Response.md +22 -0
- data/docs/SuccessResponse.md +22 -0
- data/docs/TokensApi.md +77 -0
- data/docs/UpdateCanvasRequest.md +22 -0
- data/docs/UpdateComposition.md +32 -0
- data/docs/UpdateCompositionStatusRequest.md +18 -0
- data/docs/UpdateDomainRequest.md +18 -0
- data/docs/UpdateManagedUser.md +22 -0
- data/docs/UpdatePartnerEntryContextSigningRequest.md +18 -0
- data/docs/UpdatePartnerNotificationSettingsRequest.md +24 -0
- data/docs/UpdateUserApiKeyRequest.md +20 -0
- data/docs/Upload.md +44 -0
- data/docs/UploadLimits.md +28 -0
- data/docs/UploadLimitsResponse.md +22 -0
- data/docs/UploadResponse.md +22 -0
- data/docs/UploadsApi.md +372 -0
- data/docs/UploadsGet200Response.md +22 -0
- data/docs/UploadsIdDelete200Response.md +22 -0
- data/docs/UploadsIdDelete200ResponseData.md +18 -0
- data/docs/UserApiKey.md +34 -0
- data/docs/UserApiKeyResponse.md +22 -0
- data/docs/UserApiKeyUsageLog.md +32 -0
- data/docs/UsersApi.md +881 -0
- data/docs/ValidateCompositionContentResponse.md +22 -0
- data/docs/ValidateCompositionContentResponseData.md +24 -0
- data/docs/ValidateToken200Response.md +22 -0
- data/docs/ValidateToken200ResponseData.md +26 -0
- data/docs/Widget.md +60 -0
- data/docs/WidgetsApi.md +303 -0
- data/git_push.sh +57 -0
- data/lib/api-sdk-rb/api/canvases_api.rb +390 -0
- data/lib/api-sdk-rb/api/compositions_api.rb +3267 -0
- data/lib/api-sdk-rb/api/credits_api.rb +169 -0
- data/lib/api-sdk-rb/api/entitlements_api.rb +166 -0
- data/lib/api-sdk-rb/api/invoices_api.rb +110 -0
- data/lib/api-sdk-rb/api/managed_users_api.rb +1299 -0
- data/lib/api-sdk-rb/api/operations_api.rb +85 -0
- data/lib/api-sdk-rb/api/partner_api.rb +10693 -0
- data/lib/api-sdk-rb/api/partners_api.rb +2799 -0
- data/lib/api-sdk-rb/api/public_embed_api.rb +496 -0
- data/lib/api-sdk-rb/api/tokens_api.rb +77 -0
- data/lib/api-sdk-rb/api/uploads_api.rb +383 -0
- data/lib/api-sdk-rb/api/users_api.rb +934 -0
- data/lib/api-sdk-rb/api/widgets_api.rb +347 -0
- data/lib/api-sdk-rb/api_client.rb +394 -0
- data/lib/api-sdk-rb/api_error.rb +58 -0
- data/lib/api-sdk-rb/configuration.rb +425 -0
- data/lib/api-sdk-rb/models/account_credit_balance.rb +253 -0
- data/lib/api-sdk-rb/models/account_credit_balance_response.rb +247 -0
- data/lib/api-sdk-rb/models/account_credit_transaction.rb +277 -0
- data/lib/api-sdk-rb/models/adapter_connection.rb +355 -0
- data/lib/api-sdk-rb/models/adapter_connection_removal.rb +222 -0
- data/lib/api-sdk-rb/models/add_ai_answers_knowledge_document201_response.rb +246 -0
- data/lib/api-sdk-rb/models/add_ai_answers_knowledge_document_request.rb +277 -0
- data/lib/api-sdk-rb/models/add_domain_request.rb +222 -0
- data/lib/api-sdk-rb/models/ai_answers_knowledge.rb +240 -0
- data/lib/api-sdk-rb/models/ai_answers_knowledge_document.rb +373 -0
- data/lib/api-sdk-rb/models/ai_answers_knowledge_removal.rb +222 -0
- data/lib/api-sdk-rb/models/ai_answers_knowledge_totals.rb +273 -0
- data/lib/api-sdk-rb/models/api_key_scope.rb +47 -0
- data/lib/api-sdk-rb/models/canvas.rb +315 -0
- data/lib/api-sdk-rb/models/canvas_response.rb +247 -0
- data/lib/api-sdk-rb/models/check_composition_access_response.rb +247 -0
- data/lib/api-sdk-rb/models/check_composition_access_response_data.rb +225 -0
- data/lib/api-sdk-rb/models/composition.rb +447 -0
- data/lib/api-sdk-rb/models/composition_data_source.rb +287 -0
- data/lib/api-sdk-rb/models/composition_data_source_response.rb +247 -0
- data/lib/api-sdk-rb/models/composition_entries_description.rb +258 -0
- data/lib/api-sdk-rb/models/composition_entries_description_response.rb +247 -0
- data/lib/api-sdk-rb/models/composition_entries_reading.rb +368 -0
- data/lib/api-sdk-rb/models/composition_entries_reading_response.rb +247 -0
- data/lib/api-sdk-rb/models/composition_entry_aggregate_tally.rb +271 -0
- data/lib/api-sdk-rb/models/composition_entry_aggregates_block.rb +252 -0
- data/lib/api-sdk-rb/models/composition_entry_column.rb +239 -0
- data/lib/api-sdk-rb/models/composition_entry_delete_success.rb +237 -0
- data/lib/api-sdk-rb/models/composition_entry_delete_success_data.rb +221 -0
- data/lib/api-sdk-rb/models/composition_entry_item.rb +274 -0
- data/lib/api-sdk-rb/models/composition_entry_items_meta.rb +279 -0
- data/lib/api-sdk-rb/models/composition_entry_items_page_success.rb +255 -0
- data/lib/api-sdk-rb/models/composition_entry_table.rb +269 -0
- data/lib/api-sdk-rb/models/composition_entry_tally.rb +254 -0
- data/lib/api-sdk-rb/models/composition_response.rb +247 -0
- data/lib/api-sdk-rb/models/composition_version.rb +255 -0
- data/lib/api-sdk-rb/models/content_check_finding.rb +260 -0
- data/lib/api-sdk-rb/models/content_item_write_result.rb +266 -0
- data/lib/api-sdk-rb/models/content_item_write_result_validation_result.rb +236 -0
- data/lib/api-sdk-rb/models/copy_partner_preset_request.rb +243 -0
- data/lib/api-sdk-rb/models/create_canvas_request.rb +291 -0
- data/lib/api-sdk-rb/models/create_composition_content_item201_response.rb +246 -0
- data/lib/api-sdk-rb/models/create_composition_content_item_request.rb +233 -0
- data/lib/api-sdk-rb/models/create_composition_database_record201_response.rb +249 -0
- data/lib/api-sdk-rb/models/create_composition_from_preset_request.rb +259 -0
- data/lib/api-sdk-rb/models/create_composition_from_widget201_response.rb +246 -0
- data/lib/api-sdk-rb/models/create_composition_from_widget_request.rb +267 -0
- data/lib/api-sdk-rb/models/create_user_api_key_request.rb +335 -0
- data/lib/api-sdk-rb/models/create_widget201_response.rb +246 -0
- data/lib/api-sdk-rb/models/create_widget201_response_data.rb +493 -0
- data/lib/api-sdk-rb/models/created_user_api_key.rb +384 -0
- data/lib/api-sdk-rb/models/created_user_api_key_response.rb +247 -0
- data/lib/api-sdk-rb/models/delete_composition_content_item_response.rb +247 -0
- data/lib/api-sdk-rb/models/delete_composition_content_item_response_data.rb +223 -0
- data/lib/api-sdk-rb/models/delete_composition_data_source_response.rb +247 -0
- data/lib/api-sdk-rb/models/delete_composition_data_source_response_data.rb +222 -0
- data/lib/api-sdk-rb/models/delete_managed_user200_response.rb +246 -0
- data/lib/api-sdk-rb/models/delete_personal_workspace_domain_response.rb +247 -0
- data/lib/api-sdk-rb/models/delete_personal_workspace_domain_response_data.rb +214 -0
- data/lib/api-sdk-rb/models/delete_user_api_key_response.rb +247 -0
- data/lib/api-sdk-rb/models/delete_user_api_key_response_data.rb +214 -0
- data/lib/api-sdk-rb/models/design_defaults.rb +221 -0
- data/lib/api-sdk-rb/models/duplicate_composition202_response.rb +246 -0
- data/lib/api-sdk-rb/models/duplicate_composition202_response_data.rb +215 -0
- data/lib/api-sdk-rb/models/duplicate_composition_request.rb +227 -0
- data/lib/api-sdk-rb/models/editor_session.rb +367 -0
- data/lib/api-sdk-rb/models/editor_session_response.rb +247 -0
- data/lib/api-sdk-rb/models/entitlement.rb +350 -0
- data/lib/api-sdk-rb/models/error_detail.rb +317 -0
- data/lib/api-sdk-rb/models/error_response.rb +255 -0
- data/lib/api-sdk-rb/models/export_composition_entry_items200_response.rb +255 -0
- data/lib/api-sdk-rb/models/export_composition_entry_items200_response_meta.rb +237 -0
- data/lib/api-sdk-rb/models/get_ai_answers_knowledge200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_all_canvases_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_all_canvases_response_data.rb +244 -0
- data/lib/api-sdk-rb/models/get_all_compositions200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_all_managed_users200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_composition_content_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_composition_content_schema_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_composition_content_schema_response_data.rb +261 -0
- data/lib/api-sdk-rb/models/get_composition_data_source_response.rb +243 -0
- data/lib/api-sdk-rb/models/get_composition_database_records200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_composition_design_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_composition_design_schema_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_composition_design_schema_response_data.rb +262 -0
- data/lib/api-sdk-rb/models/get_composition_embed_schema_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_composition_embed_schema_response_data.rb +302 -0
- data/lib/api-sdk-rb/models/get_composition_embed_settings_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_composition_preview_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_composition_preview_response_data.rb +245 -0
- data/lib/api-sdk-rb/models/get_composition_versions200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_compositions_batch_request.rb +243 -0
- data/lib/api-sdk-rb/models/get_compositions_batch_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_compositions_batch_response_data.rb +227 -0
- data/lib/api-sdk-rb/models/get_invoices_by_partner_id200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_managed_user_entitlements_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_managed_user_entitlements_response_data.rb +225 -0
- data/lib/api-sdk-rb/models/get_managed_user_limits200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_managed_user_storage_usage200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_managed_user_storage_usage200_response_data.rb +253 -0
- data/lib/api-sdk-rb/models/get_managed_user_storage_usage200_response_data_by_purpose.rb +241 -0
- data/lib/api-sdk-rb/models/get_managed_users_by_manager_id_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_managed_users_by_manager_id_response_data.rb +243 -0
- data/lib/api-sdk-rb/models/get_partner_billing_overview200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_partner_credit_transactions200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_partner_design_defaults200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_partner_entitlements_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_partner_entitlements_response_data.rb +225 -0
- data/lib/api-sdk-rb/models/get_personal_workspace_domains200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response.rb +348 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_data_source.rb +223 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_direct.rb +234 -0
- data/lib/api-sdk-rb/models/get_user_adapter_connections200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_user_api_key_usage_logs_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_user_api_key_usage_logs_response_data.rb +223 -0
- data/lib/api-sdk-rb/models/get_user_api_keys200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_widgets200_response.rb +248 -0
- data/lib/api-sdk-rb/models/get_widgets_batch_request.rb +223 -0
- data/lib/api-sdk-rb/models/get_widgets_batch_response.rb +247 -0
- data/lib/api-sdk-rb/models/get_widgets_batch_response_data.rb +227 -0
- data/lib/api-sdk-rb/models/get_widgets_batch_response_data_errors_inner.rb +223 -0
- data/lib/api-sdk-rb/models/list_partner_presets200_response.rb +248 -0
- data/lib/api-sdk-rb/models/managed_user.rb +312 -0
- data/lib/api-sdk-rb/models/managed_user_entries_meta.rb +274 -0
- data/lib/api-sdk-rb/models/managed_user_entries_page_success.rb +255 -0
- data/lib/api-sdk-rb/models/managed_user_entry_item.rb +313 -0
- data/lib/api-sdk-rb/models/managed_user_limits.rb +264 -0
- data/lib/api-sdk-rb/models/managed_user_operation_usage.rb +291 -0
- data/lib/api-sdk-rb/models/managed_user_removal.rb +239 -0
- data/lib/api-sdk-rb/models/managed_user_response.rb +247 -0
- data/lib/api-sdk-rb/models/managed_user_usage.rb +308 -0
- data/lib/api-sdk-rb/models/managed_user_usage_response.rb +247 -0
- data/lib/api-sdk-rb/models/managed_user_usage_totals.rb +270 -0
- data/lib/api-sdk-rb/models/my_partner.rb +368 -0
- data/lib/api-sdk-rb/models/my_partners.rb +288 -0
- data/lib/api-sdk-rb/models/my_partners_response.rb +247 -0
- data/lib/api-sdk-rb/models/new_composition.rb +350 -0
- data/lib/api-sdk-rb/models/new_editor_session.rb +340 -0
- data/lib/api-sdk-rb/models/new_managed_user.rb +242 -0
- data/lib/api-sdk-rb/models/new_widget.rb +434 -0
- data/lib/api-sdk-rb/models/operations_id_get_response.rb +247 -0
- data/lib/api-sdk-rb/models/operations_id_get_response_data.rb +348 -0
- data/lib/api-sdk-rb/models/partner_analytics_by_managed_user.rb +272 -0
- data/lib/api-sdk-rb/models/partner_analytics_by_managed_user_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_analytics_of_day.rb +270 -0
- data/lib/api-sdk-rb/models/partner_analytics_of_managed_user.rb +354 -0
- data/lib/api-sdk-rb/models/partner_analytics_of_widget.rb +300 -0
- data/lib/api-sdk-rb/models/partner_analytics_summary.rb +336 -0
- data/lib/api-sdk-rb/models/partner_analytics_summary_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_analytics_timeline.rb +270 -0
- data/lib/api-sdk-rb/models/partner_analytics_timeline_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_analytics_top_widgets.rb +269 -0
- data/lib/api-sdk-rb/models/partner_analytics_top_widgets_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_billing_overview.rb +265 -0
- data/lib/api-sdk-rb/models/partner_billing_overview_billing_integration.rb +304 -0
- data/lib/api-sdk-rb/models/partner_billing_overview_operational_credits.rb +276 -0
- data/lib/api-sdk-rb/models/partner_billing_overview_partner.rb +304 -0
- data/lib/api-sdk-rb/models/partner_contract.rb +400 -0
- data/lib/api-sdk-rb/models/partner_contract_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_customization.rb +414 -0
- data/lib/api-sdk-rb/models/partner_data_database.rb +332 -0
- data/lib/api-sdk-rb/models/partner_data_database_removal.rb +222 -0
- data/lib/api-sdk-rb/models/partner_data_database_removal_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_data_database_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_entry_context_secret.rb +239 -0
- data/lib/api-sdk-rb/models/partner_entry_context_secret_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_entry_context_signing.rb +299 -0
- data/lib/api-sdk-rb/models/partner_entry_context_signing_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_extra_credits_invoice.rb +394 -0
- data/lib/api-sdk-rb/models/partner_extra_credits_invoice_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_invoice.rb +489 -0
- data/lib/api-sdk-rb/models/partner_notification.rb +358 -0
- data/lib/api-sdk-rb/models/partner_notification_default_recipients.rb +244 -0
- data/lib/api-sdk-rb/models/partner_notification_delivery.rb +466 -0
- data/lib/api-sdk-rb/models/partner_notification_delivery_log.rb +224 -0
- data/lib/api-sdk-rb/models/partner_notification_delivery_log_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_notification_delivery_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_notification_event.rb +351 -0
- data/lib/api-sdk-rb/models/partner_notification_event_type.rb +54 -0
- data/lib/api-sdk-rb/models/partner_notification_page.rb +237 -0
- data/lib/api-sdk-rb/models/partner_notification_page_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_notification_settings.rb +366 -0
- data/lib/api-sdk-rb/models/partner_notification_settings_change.rb +235 -0
- data/lib/api-sdk-rb/models/partner_notification_settings_change_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_notification_settings_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_notification_test_event_request.rb +244 -0
- data/lib/api-sdk-rb/models/partner_notification_test_event_result.rb +263 -0
- data/lib/api-sdk-rb/models/partner_notification_test_event_result_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_preset.rb +344 -0
- data/lib/api-sdk-rb/models/partner_preset_copy.rb +308 -0
- data/lib/api-sdk-rb/models/partner_preset_copy_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_preset_removal.rb +222 -0
- data/lib/api-sdk-rb/models/partner_preset_removal_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_preset_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_report_page.rb +257 -0
- data/lib/api-sdk-rb/models/partner_report_period.rb +240 -0
- data/lib/api-sdk-rb/models/partner_storage_destination.rb +393 -0
- data/lib/api-sdk-rb/models/partner_storage_destination_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_storage_removal.rb +222 -0
- data/lib/api-sdk-rb/models/partner_storage_removal_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_storage_usage.rb +272 -0
- data/lib/api-sdk-rb/models/partner_storage_usage_of_managed_user.rb +334 -0
- data/lib/api-sdk-rb/models/partner_storage_usage_response.rb +247 -0
- data/lib/api-sdk-rb/models/partner_storage_usage_totals.rb +273 -0
- data/lib/api-sdk-rb/models/personal_workspace_domain.rb +275 -0
- data/lib/api-sdk-rb/models/personal_workspace_domain_result.rb +237 -0
- data/lib/api-sdk-rb/models/personal_workspace_domain_result_response.rb +247 -0
- data/lib/api-sdk-rb/models/post_public_composition_embed_status200_response.rb +246 -0
- data/lib/api-sdk-rb/models/post_public_composition_embed_status200_response_data.rb +239 -0
- data/lib/api-sdk-rb/models/post_public_composition_embed_status_request.rb +251 -0
- data/lib/api-sdk-rb/models/public_adapter_call_error.rb +265 -0
- data/lib/api-sdk-rb/models/public_adapter_call_request.rb +332 -0
- data/lib/api-sdk-rb/models/public_adapter_call_result.rb +237 -0
- data/lib/api-sdk-rb/models/public_adapter_call_result_data.rb +224 -0
- data/lib/api-sdk-rb/models/public_adapter_file_result.rb +237 -0
- data/lib/api-sdk-rb/models/public_adapter_file_result_data.rb +221 -0
- data/lib/api-sdk-rb/models/public_adapter_file_result_data_file.rb +318 -0
- data/lib/api-sdk-rb/models/public_composition_entry_created.rb +237 -0
- data/lib/api-sdk-rb/models/public_composition_entry_created_data.rb +253 -0
- data/lib/api-sdk-rb/models/public_composition_entry_request.rb +246 -0
- data/lib/api-sdk-rb/models/public_embed_failure.rb +291 -0
- data/lib/api-sdk-rb/models/public_embed_failure_details.rb +260 -0
- data/lib/api-sdk-rb/models/public_embed_failure_error.rb +283 -0
- data/lib/api-sdk-rb/models/purpose_storage_bucket.rb +237 -0
- data/lib/api-sdk-rb/models/remove_ai_answers_knowledge_document200_response.rb +246 -0
- data/lib/api-sdk-rb/models/remove_user_adapter_connection200_response.rb +246 -0
- data/lib/api-sdk-rb/models/request_extra_credits.rb +250 -0
- data/lib/api-sdk-rb/models/response_meta.rb +297 -0
- data/lib/api-sdk-rb/models/revoke_managed_user_editor_sessions_response.rb +247 -0
- data/lib/api-sdk-rb/models/revoke_managed_user_editor_sessions_response_data.rb +215 -0
- data/lib/api-sdk-rb/models/set_adapter_connection_request.rb +241 -0
- data/lib/api-sdk-rb/models/set_composition_data_source_request.rb +284 -0
- data/lib/api-sdk-rb/models/set_dynamic_content_request.rb +266 -0
- data/lib/api-sdk-rb/models/set_dynamic_content_response.rb +247 -0
- data/lib/api-sdk-rb/models/set_dynamic_content_response_data.rb +251 -0
- data/lib/api-sdk-rb/models/set_dynamic_content_response_data_validation_result.rb +236 -0
- data/lib/api-sdk-rb/models/set_managed_user_limits_request.rb +241 -0
- data/lib/api-sdk-rb/models/set_partner_data_database_request.rb +222 -0
- data/lib/api-sdk-rb/models/set_partner_design_defaults_request.rb +217 -0
- data/lib/api-sdk-rb/models/set_partner_preset_request.rb +322 -0
- data/lib/api-sdk-rb/models/set_partner_storage_destination_request.rb +331 -0
- data/lib/api-sdk-rb/models/set_user_adapter_connection200_response.rb +246 -0
- data/lib/api-sdk-rb/models/success_response.rb +250 -0
- data/lib/api-sdk-rb/models/update_canvas_request.rb +236 -0
- data/lib/api-sdk-rb/models/update_composition.rb +285 -0
- data/lib/api-sdk-rb/models/update_composition_status_request.rb +256 -0
- data/lib/api-sdk-rb/models/update_domain_request.rb +223 -0
- data/lib/api-sdk-rb/models/update_managed_user.rb +235 -0
- data/lib/api-sdk-rb/models/update_partner_entry_context_signing_request.rb +222 -0
- data/lib/api-sdk-rb/models/update_partner_notification_settings_request.rb +289 -0
- data/lib/api-sdk-rb/models/update_user_api_key_request.rb +254 -0
- data/lib/api-sdk-rb/models/upload.rb +462 -0
- data/lib/api-sdk-rb/models/upload_limits.rb +269 -0
- data/lib/api-sdk-rb/models/upload_limits_response.rb +247 -0
- data/lib/api-sdk-rb/models/upload_response.rb +247 -0
- data/lib/api-sdk-rb/models/uploads_get200_response.rb +248 -0
- data/lib/api-sdk-rb/models/uploads_id_delete200_response.rb +246 -0
- data/lib/api-sdk-rb/models/uploads_id_delete200_response_data.rb +214 -0
- data/lib/api-sdk-rb/models/user_api_key.rb +382 -0
- data/lib/api-sdk-rb/models/user_api_key_response.rb +247 -0
- data/lib/api-sdk-rb/models/user_api_key_usage_log.rb +326 -0
- data/lib/api-sdk-rb/models/validate_composition_content_response.rb +247 -0
- data/lib/api-sdk-rb/models/validate_composition_content_response_data.rb +258 -0
- data/lib/api-sdk-rb/models/validate_token200_response.rb +246 -0
- data/lib/api-sdk-rb/models/validate_token200_response_data.rb +286 -0
- data/lib/api-sdk-rb/models/widget.rb +475 -0
- data/lib/api-sdk-rb/version.rb +15 -0
- data/lib/api-sdk-rb.rb +319 -0
- data/spec/api/canvases_api_spec.rb +104 -0
- data/spec/api/compositions_api_spec.rb +578 -0
- data/spec/api/credits_api_spec.rb +62 -0
- data/spec/api/entitlements_api_spec.rb +65 -0
- data/spec/api/invoices_api_spec.rb +50 -0
- data/spec/api/managed_users_api_spec.rb +256 -0
- data/spec/api/operations_api_spec.rb +47 -0
- data/spec/api/partner_api_spec.rb +1895 -0
- data/spec/api/partners_api_spec.rb +525 -0
- data/spec/api/public_embed_api_spec.rb +115 -0
- data/spec/api/tokens_api_spec.rb +45 -0
- data/spec/api/uploads_api_spec.rb +101 -0
- data/spec/api/users_api_spec.rb +195 -0
- data/spec/api/widgets_api_spec.rb +90 -0
- data/spec/models/account_credit_balance_response_spec.rb +48 -0
- data/spec/models/account_credit_balance_spec.rb +60 -0
- data/spec/models/account_credit_transaction_spec.rb +72 -0
- data/spec/models/adapter_connection_removal_spec.rb +36 -0
- data/spec/models/adapter_connection_spec.rb +76 -0
- data/spec/models/add_ai_answers_knowledge_document201_response_spec.rb +48 -0
- data/spec/models/add_ai_answers_knowledge_document_request_spec.rb +42 -0
- data/spec/models/add_domain_request_spec.rb +36 -0
- data/spec/models/ai_answers_knowledge_document_spec.rb +76 -0
- data/spec/models/ai_answers_knowledge_removal_spec.rb +36 -0
- data/spec/models/ai_answers_knowledge_spec.rb +42 -0
- data/spec/models/ai_answers_knowledge_totals_spec.rb +54 -0
- data/spec/models/api_key_scope_spec.rb +30 -0
- data/spec/models/canvas_response_spec.rb +48 -0
- data/spec/models/canvas_spec.rb +78 -0
- data/spec/models/check_composition_access_response_data_spec.rb +42 -0
- data/spec/models/check_composition_access_response_spec.rb +48 -0
- data/spec/models/composition_data_source_response_spec.rb +48 -0
- data/spec/models/composition_data_source_spec.rb +42 -0
- data/spec/models/composition_entries_description_response_spec.rb +48 -0
- data/spec/models/composition_entries_description_spec.rb +48 -0
- data/spec/models/composition_entries_reading_response_spec.rb +48 -0
- data/spec/models/composition_entries_reading_spec.rb +84 -0
- data/spec/models/composition_entry_aggregate_tally_spec.rb +66 -0
- data/spec/models/composition_entry_aggregates_block_spec.rb +48 -0
- data/spec/models/composition_entry_column_spec.rb +42 -0
- data/spec/models/composition_entry_delete_success_data_spec.rb +36 -0
- data/spec/models/composition_entry_delete_success_spec.rb +42 -0
- data/spec/models/composition_entry_item_spec.rb +60 -0
- data/spec/models/composition_entry_items_meta_spec.rb +52 -0
- data/spec/models/composition_entry_items_page_success_spec.rb +48 -0
- data/spec/models/composition_entry_table_spec.rb +48 -0
- data/spec/models/composition_entry_tally_spec.rb +42 -0
- data/spec/models/composition_response_spec.rb +48 -0
- data/spec/models/composition_spec.rb +124 -0
- data/spec/models/composition_version_spec.rb +60 -0
- data/spec/models/content_check_finding_spec.rb +54 -0
- data/spec/models/content_item_write_result_spec.rb +66 -0
- data/spec/models/content_item_write_result_validation_result_spec.rb +48 -0
- data/spec/models/copy_partner_preset_request_spec.rb +36 -0
- data/spec/models/create_canvas_request_spec.rb +66 -0
- data/spec/models/create_composition_content_item201_response_spec.rb +48 -0
- data/spec/models/create_composition_content_item_request_spec.rb +36 -0
- data/spec/models/create_composition_database_record201_response_spec.rb +48 -0
- data/spec/models/create_composition_from_preset_request_spec.rb +60 -0
- data/spec/models/create_composition_from_widget201_response_spec.rb +48 -0
- data/spec/models/create_composition_from_widget_request_spec.rb +66 -0
- data/spec/models/create_user_api_key_request_spec.rb +58 -0
- data/spec/models/create_widget201_response_data_spec.rb +172 -0
- data/spec/models/create_widget201_response_spec.rb +48 -0
- data/spec/models/created_user_api_key_response_spec.rb +48 -0
- data/spec/models/created_user_api_key_spec.rb +88 -0
- data/spec/models/delete_composition_content_item_response_data_spec.rb +42 -0
- data/spec/models/delete_composition_content_item_response_spec.rb +48 -0
- data/spec/models/delete_composition_data_source_response_data_spec.rb +36 -0
- data/spec/models/delete_composition_data_source_response_spec.rb +48 -0
- data/spec/models/delete_managed_user200_response_spec.rb +48 -0
- data/spec/models/delete_personal_workspace_domain_response_data_spec.rb +36 -0
- data/spec/models/delete_personal_workspace_domain_response_spec.rb +48 -0
- data/spec/models/delete_user_api_key_response_data_spec.rb +36 -0
- data/spec/models/delete_user_api_key_response_spec.rb +48 -0
- data/spec/models/design_defaults_spec.rb +36 -0
- data/spec/models/duplicate_composition202_response_data_spec.rb +36 -0
- data/spec/models/duplicate_composition202_response_spec.rb +48 -0
- data/spec/models/duplicate_composition_request_spec.rb +42 -0
- data/spec/models/editor_session_response_spec.rb +48 -0
- data/spec/models/editor_session_spec.rb +88 -0
- data/spec/models/entitlement_spec.rb +100 -0
- data/spec/models/error_detail_spec.rb +84 -0
- data/spec/models/error_response_spec.rb +48 -0
- data/spec/models/export_composition_entry_items200_response_meta_spec.rb +42 -0
- data/spec/models/export_composition_entry_items200_response_spec.rb +48 -0
- data/spec/models/get_ai_answers_knowledge200_response_spec.rb +48 -0
- data/spec/models/get_all_canvases_response_data_spec.rb +54 -0
- data/spec/models/get_all_canvases_response_spec.rb +48 -0
- data/spec/models/get_all_compositions200_response_spec.rb +48 -0
- data/spec/models/get_all_managed_users200_response_spec.rb +48 -0
- data/spec/models/get_composition_content_response_spec.rb +48 -0
- data/spec/models/get_composition_content_schema_response_data_spec.rb +66 -0
- data/spec/models/get_composition_content_schema_response_spec.rb +48 -0
- data/spec/models/get_composition_data_source_response_spec.rb +48 -0
- data/spec/models/get_composition_database_records200_response_spec.rb +48 -0
- data/spec/models/get_composition_design_response_spec.rb +48 -0
- data/spec/models/get_composition_design_schema_response_data_spec.rb +66 -0
- data/spec/models/get_composition_design_schema_response_spec.rb +48 -0
- data/spec/models/get_composition_embed_schema_response_data_spec.rb +70 -0
- data/spec/models/get_composition_embed_schema_response_spec.rb +48 -0
- data/spec/models/get_composition_embed_settings_response_spec.rb +48 -0
- data/spec/models/get_composition_preview_response_data_spec.rb +54 -0
- data/spec/models/get_composition_preview_response_spec.rb +48 -0
- data/spec/models/get_composition_versions200_response_spec.rb +48 -0
- data/spec/models/get_compositions_batch_request_spec.rb +36 -0
- data/spec/models/get_compositions_batch_response_data_spec.rb +42 -0
- data/spec/models/get_compositions_batch_response_spec.rb +48 -0
- data/spec/models/get_invoices_by_partner_id200_response_spec.rb +48 -0
- data/spec/models/get_managed_user_entitlements_response_data_spec.rb +42 -0
- data/spec/models/get_managed_user_entitlements_response_spec.rb +48 -0
- data/spec/models/get_managed_user_limits200_response_spec.rb +48 -0
- data/spec/models/get_managed_user_storage_usage200_response_data_by_purpose_spec.rb +54 -0
- data/spec/models/get_managed_user_storage_usage200_response_data_spec.rb +48 -0
- data/spec/models/get_managed_user_storage_usage200_response_spec.rb +48 -0
- data/spec/models/get_managed_users_by_manager_id_response_data_spec.rb +54 -0
- data/spec/models/get_managed_users_by_manager_id_response_spec.rb +48 -0
- data/spec/models/get_partner_billing_overview200_response_spec.rb +48 -0
- data/spec/models/get_partner_credit_transactions200_response_spec.rb +48 -0
- data/spec/models/get_partner_design_defaults200_response_spec.rb +48 -0
- data/spec/models/get_partner_entitlements_response_data_spec.rb +42 -0
- data/spec/models/get_partner_entitlements_response_spec.rb +48 -0
- data/spec/models/get_personal_workspace_domains200_response_spec.rb +48 -0
- data/spec/models/get_public_composition_embed200_response_data_source_spec.rb +42 -0
- data/spec/models/get_public_composition_embed200_response_direct_spec.rb +48 -0
- data/spec/models/get_public_composition_embed200_response_spec.rb +120 -0
- data/spec/models/get_user_adapter_connections200_response_spec.rb +48 -0
- data/spec/models/get_user_api_key_usage_logs_response_data_spec.rb +36 -0
- data/spec/models/get_user_api_key_usage_logs_response_spec.rb +48 -0
- data/spec/models/get_user_api_keys200_response_spec.rb +48 -0
- data/spec/models/get_widgets200_response_spec.rb +48 -0
- data/spec/models/get_widgets_batch_request_spec.rb +36 -0
- data/spec/models/get_widgets_batch_response_data_errors_inner_spec.rb +42 -0
- data/spec/models/get_widgets_batch_response_data_spec.rb +42 -0
- data/spec/models/get_widgets_batch_response_spec.rb +48 -0
- data/spec/models/list_partner_presets200_response_spec.rb +48 -0
- data/spec/models/managed_user_entries_meta_spec.rb +60 -0
- data/spec/models/managed_user_entries_page_success_spec.rb +48 -0
- data/spec/models/managed_user_entry_item_spec.rb +72 -0
- data/spec/models/managed_user_limits_spec.rb +54 -0
- data/spec/models/managed_user_operation_usage_spec.rb +60 -0
- data/spec/models/managed_user_removal_spec.rb +42 -0
- data/spec/models/managed_user_response_spec.rb +48 -0
- data/spec/models/managed_user_spec.rb +72 -0
- data/spec/models/managed_user_usage_response_spec.rb +48 -0
- data/spec/models/managed_user_usage_spec.rb +66 -0
- data/spec/models/managed_user_usage_totals_spec.rb +54 -0
- data/spec/models/my_partner_spec.rb +88 -0
- data/spec/models/my_partners_response_spec.rb +48 -0
- data/spec/models/my_partners_spec.rb +52 -0
- data/spec/models/new_composition_spec.rb +96 -0
- data/spec/models/new_editor_session_spec.rb +58 -0
- data/spec/models/new_managed_user_spec.rb +48 -0
- data/spec/models/new_widget_spec.rb +100 -0
- data/spec/models/operations_id_get_response_data_spec.rb +82 -0
- data/spec/models/operations_id_get_response_spec.rb +48 -0
- data/spec/models/partner_analytics_by_managed_user_response_spec.rb +48 -0
- data/spec/models/partner_analytics_by_managed_user_spec.rb +54 -0
- data/spec/models/partner_analytics_of_day_spec.rb +54 -0
- data/spec/models/partner_analytics_of_managed_user_spec.rb +90 -0
- data/spec/models/partner_analytics_of_widget_spec.rb +66 -0
- data/spec/models/partner_analytics_summary_response_spec.rb +48 -0
- data/spec/models/partner_analytics_summary_spec.rb +78 -0
- data/spec/models/partner_analytics_timeline_response_spec.rb +48 -0
- data/spec/models/partner_analytics_timeline_spec.rb +54 -0
- data/spec/models/partner_analytics_top_widgets_response_spec.rb +48 -0
- data/spec/models/partner_analytics_top_widgets_spec.rb +54 -0
- data/spec/models/partner_billing_overview_billing_integration_spec.rb +58 -0
- data/spec/models/partner_billing_overview_operational_credits_spec.rb +54 -0
- data/spec/models/partner_billing_overview_partner_spec.rb +58 -0
- data/spec/models/partner_billing_overview_spec.rb +54 -0
- data/spec/models/partner_contract_response_spec.rb +48 -0
- data/spec/models/partner_contract_spec.rb +130 -0
- data/spec/models/partner_customization_spec.rb +136 -0
- data/spec/models/partner_data_database_removal_response_spec.rb +48 -0
- data/spec/models/partner_data_database_removal_spec.rb +36 -0
- data/spec/models/partner_data_database_response_spec.rb +48 -0
- data/spec/models/partner_data_database_spec.rb +78 -0
- data/spec/models/partner_entry_context_secret_response_spec.rb +48 -0
- data/spec/models/partner_entry_context_secret_spec.rb +42 -0
- data/spec/models/partner_entry_context_signing_response_spec.rb +48 -0
- data/spec/models/partner_entry_context_signing_spec.rb +66 -0
- data/spec/models/partner_extra_credits_invoice_response_spec.rb +48 -0
- data/spec/models/partner_extra_credits_invoice_spec.rb +102 -0
- data/spec/models/partner_invoice_spec.rb +178 -0
- data/spec/models/partner_notification_default_recipients_spec.rb +42 -0
- data/spec/models/partner_notification_delivery_log_response_spec.rb +48 -0
- data/spec/models/partner_notification_delivery_log_spec.rb +36 -0
- data/spec/models/partner_notification_delivery_response_spec.rb +48 -0
- data/spec/models/partner_notification_delivery_spec.rb +128 -0
- data/spec/models/partner_notification_event_spec.rb +74 -0
- data/spec/models/partner_notification_event_type_spec.rb +30 -0
- data/spec/models/partner_notification_page_response_spec.rb +48 -0
- data/spec/models/partner_notification_page_spec.rb +42 -0
- data/spec/models/partner_notification_settings_change_response_spec.rb +48 -0
- data/spec/models/partner_notification_settings_change_spec.rb +42 -0
- data/spec/models/partner_notification_settings_response_spec.rb +48 -0
- data/spec/models/partner_notification_settings_spec.rb +90 -0
- data/spec/models/partner_notification_spec.rb +76 -0
- data/spec/models/partner_notification_test_event_request_spec.rb +36 -0
- data/spec/models/partner_notification_test_event_result_response_spec.rb +48 -0
- data/spec/models/partner_notification_test_event_result_spec.rb +54 -0
- data/spec/models/partner_preset_copy_response_spec.rb +48 -0
- data/spec/models/partner_preset_copy_spec.rb +66 -0
- data/spec/models/partner_preset_removal_response_spec.rb +48 -0
- data/spec/models/partner_preset_removal_spec.rb +36 -0
- data/spec/models/partner_preset_response_spec.rb +48 -0
- data/spec/models/partner_preset_spec.rb +84 -0
- data/spec/models/partner_report_page_spec.rb +48 -0
- data/spec/models/partner_report_period_spec.rb +42 -0
- data/spec/models/partner_storage_destination_response_spec.rb +48 -0
- data/spec/models/partner_storage_destination_spec.rb +102 -0
- data/spec/models/partner_storage_removal_response_spec.rb +48 -0
- data/spec/models/partner_storage_removal_spec.rb +36 -0
- data/spec/models/partner_storage_usage_of_managed_user_spec.rb +84 -0
- data/spec/models/partner_storage_usage_response_spec.rb +48 -0
- data/spec/models/partner_storage_usage_spec.rb +54 -0
- data/spec/models/partner_storage_usage_totals_spec.rb +54 -0
- data/spec/models/personal_workspace_domain_result_response_spec.rb +48 -0
- data/spec/models/personal_workspace_domain_result_spec.rb +42 -0
- data/spec/models/personal_workspace_domain_spec.rb +60 -0
- data/spec/models/post_public_composition_embed_status200_response_data_spec.rb +40 -0
- data/spec/models/post_public_composition_embed_status200_response_spec.rb +48 -0
- data/spec/models/post_public_composition_embed_status_request_spec.rb +36 -0
- data/spec/models/public_adapter_call_error_spec.rb +54 -0
- data/spec/models/public_adapter_call_request_spec.rb +60 -0
- data/spec/models/public_adapter_call_result_data_spec.rb +36 -0
- data/spec/models/public_adapter_call_result_spec.rb +42 -0
- data/spec/models/public_adapter_file_result_data_file_spec.rb +66 -0
- data/spec/models/public_adapter_file_result_data_spec.rb +36 -0
- data/spec/models/public_adapter_file_result_spec.rb +42 -0
- data/spec/models/public_composition_entry_created_data_spec.rb +48 -0
- data/spec/models/public_composition_entry_created_spec.rb +42 -0
- data/spec/models/public_composition_entry_request_spec.rb +48 -0
- data/spec/models/public_embed_failure_details_spec.rb +46 -0
- data/spec/models/public_embed_failure_error_spec.rb +66 -0
- data/spec/models/public_embed_failure_spec.rb +66 -0
- data/spec/models/purpose_storage_bucket_spec.rb +42 -0
- data/spec/models/remove_ai_answers_knowledge_document200_response_spec.rb +48 -0
- data/spec/models/remove_user_adapter_connection200_response_spec.rb +48 -0
- data/spec/models/request_extra_credits_spec.rb +36 -0
- data/spec/models/response_meta_spec.rb +84 -0
- data/spec/models/revoke_managed_user_editor_sessions_response_data_spec.rb +36 -0
- data/spec/models/revoke_managed_user_editor_sessions_response_spec.rb +48 -0
- data/spec/models/set_adapter_connection_request_spec.rb +36 -0
- data/spec/models/set_composition_data_source_request_spec.rb +42 -0
- data/spec/models/set_dynamic_content_request_spec.rb +60 -0
- data/spec/models/set_dynamic_content_response_data_spec.rb +60 -0
- data/spec/models/set_dynamic_content_response_data_validation_result_spec.rb +48 -0
- data/spec/models/set_dynamic_content_response_spec.rb +48 -0
- data/spec/models/set_managed_user_limits_request_spec.rb +36 -0
- data/spec/models/set_partner_data_database_request_spec.rb +36 -0
- data/spec/models/set_partner_design_defaults_request_spec.rb +36 -0
- data/spec/models/set_partner_preset_request_spec.rb +54 -0
- data/spec/models/set_partner_storage_destination_request_spec.rb +78 -0
- data/spec/models/set_user_adapter_connection200_response_spec.rb +48 -0
- data/spec/models/success_response_spec.rb +48 -0
- data/spec/models/update_canvas_request_spec.rb +48 -0
- data/spec/models/update_composition_spec.rb +78 -0
- data/spec/models/update_composition_status_request_spec.rb +40 -0
- data/spec/models/update_domain_request_spec.rb +36 -0
- data/spec/models/update_managed_user_spec.rb +48 -0
- data/spec/models/update_partner_entry_context_signing_request_spec.rb +36 -0
- data/spec/models/update_partner_notification_settings_request_spec.rb +54 -0
- data/spec/models/update_user_api_key_request_spec.rb +42 -0
- data/spec/models/upload_limits_response_spec.rb +48 -0
- data/spec/models/upload_limits_spec.rb +66 -0
- data/spec/models/upload_response_spec.rb +48 -0
- data/spec/models/upload_spec.rb +126 -0
- data/spec/models/uploads_get200_response_spec.rb +48 -0
- data/spec/models/uploads_id_delete200_response_data_spec.rb +36 -0
- data/spec/models/uploads_id_delete200_response_spec.rb +48 -0
- data/spec/models/user_api_key_response_spec.rb +48 -0
- data/spec/models/user_api_key_spec.rb +88 -0
- data/spec/models/user_api_key_usage_log_spec.rb +78 -0
- data/spec/models/validate_composition_content_response_data_spec.rb +54 -0
- data/spec/models/validate_composition_content_response_spec.rb +48 -0
- data/spec/models/validate_token200_response_data_spec.rb +64 -0
- data/spec/models/validate_token200_response_spec.rb +48 -0
- data/spec/models/widget_spec.rb +166 -0
- data/spec/spec_helper.rb +111 -0
- metadata +1216 -0
data/README.md
ADDED
|
@@ -0,0 +1,648 @@
|
|
|
1
|
+
# api-sdk-rb
|
|
2
|
+
|
|
3
|
+
ApiSdkRb - the Ruby gem for the Widgetic API Gateway
|
|
4
|
+
|
|
5
|
+
API documentation for the Widgetic API Gateway
|
|
6
|
+
|
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
|
+
|
|
9
|
+
- API version: 1.0.0
|
|
10
|
+
- Package version: 1.11.66
|
|
11
|
+
- Generator version: 7.9.0
|
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
### Build a gem
|
|
17
|
+
|
|
18
|
+
To build the Ruby code into a gem:
|
|
19
|
+
|
|
20
|
+
```shell
|
|
21
|
+
gem build api-sdk-rb.gemspec
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Then either install the gem locally:
|
|
25
|
+
|
|
26
|
+
```shell
|
|
27
|
+
gem install ./api-sdk-rb-1.11.66.gem
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
(for development, run `gem install --dev ./api-sdk-rb-1.11.66.gem` to install the development dependencies)
|
|
31
|
+
|
|
32
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
|
+
|
|
34
|
+
Finally add this to the Gemfile:
|
|
35
|
+
|
|
36
|
+
gem 'api-sdk-rb', '~> 1.11.66'
|
|
37
|
+
|
|
38
|
+
### Install from Git
|
|
39
|
+
|
|
40
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
|
41
|
+
|
|
42
|
+
gem 'api-sdk-rb', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
|
43
|
+
|
|
44
|
+
### Include the Ruby code directly
|
|
45
|
+
|
|
46
|
+
Include the Ruby code directly using `-I` as follows:
|
|
47
|
+
|
|
48
|
+
```shell
|
|
49
|
+
ruby -Ilib script.rb
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Getting Started
|
|
53
|
+
|
|
54
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
|
55
|
+
|
|
56
|
+
```ruby
|
|
57
|
+
# Load the gem
|
|
58
|
+
require 'api-sdk-rb'
|
|
59
|
+
|
|
60
|
+
# Setup authorization
|
|
61
|
+
ApiSdkRb.configure do |config|
|
|
62
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
63
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
64
|
+
# Configure a proc to get access tokens in lieu of the static access_token configuration
|
|
65
|
+
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
api_instance = ApiSdkRb::CanvasesApi.new
|
|
69
|
+
create_canvas_request = ApiSdkRb::CreateCanvasRequest.new({persistence_key: 'canvas_xyz123'}) # CreateCanvasRequest |
|
|
70
|
+
|
|
71
|
+
begin
|
|
72
|
+
#Create Canvas
|
|
73
|
+
result = api_instance.create_canvas_0(create_canvas_request)
|
|
74
|
+
p result
|
|
75
|
+
rescue ApiSdkRb::ApiError => e
|
|
76
|
+
puts "Exception when calling CanvasesApi->create_canvas_0: #{e}"
|
|
77
|
+
end
|
|
78
|
+
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Documentation for API Endpoints
|
|
82
|
+
|
|
83
|
+
All URIs are relative to *https://api.widgetic.com/v1*
|
|
84
|
+
|
|
85
|
+
Class | Method | HTTP request | Description
|
|
86
|
+
------------ | ------------- | ------------- | -------------
|
|
87
|
+
*ApiSdkRb::CanvasesApi* | [**create_canvas_0**](docs/CanvasesApi.md#create_canvas_0) | **POST** /canvases | Create Canvas
|
|
88
|
+
*ApiSdkRb::CanvasesApi* | [**delete_canvas_0**](docs/CanvasesApi.md#delete_canvas_0) | **DELETE** /canvases/{id} | Delete Canvas
|
|
89
|
+
*ApiSdkRb::CanvasesApi* | [**get_all_canvases_0**](docs/CanvasesApi.md#get_all_canvases_0) | **GET** /canvases | Get All Canvases
|
|
90
|
+
*ApiSdkRb::CanvasesApi* | [**get_canvas_0**](docs/CanvasesApi.md#get_canvas_0) | **GET** /canvases/{id} | Get Canvas
|
|
91
|
+
*ApiSdkRb::CanvasesApi* | [**update_canvas_0**](docs/CanvasesApi.md#update_canvas_0) | **PUT** /canvases/{id} | Update Canvas
|
|
92
|
+
*ApiSdkRb::CompositionsApi* | [**add_ai_answers_knowledge_document_0**](docs/CompositionsApi.md#add_ai_answers_knowledge_document_0) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents | Add a document for a widget's AI to answer from
|
|
93
|
+
*ApiSdkRb::CompositionsApi* | [**check_composition_access_0**](docs/CompositionsApi.md#check_composition_access_0) | **GET** /compositions/{id}/access | Check Composition Access
|
|
94
|
+
*ApiSdkRb::CompositionsApi* | [**create_composition_0**](docs/CompositionsApi.md#create_composition_0) | **POST** /compositions | Create Composition
|
|
95
|
+
*ApiSdkRb::CompositionsApi* | [**create_composition_content_item_0**](docs/CompositionsApi.md#create_composition_content_item_0) | **POST** /compositions/{id}/content/{list}/items | Add a content list item
|
|
96
|
+
*ApiSdkRb::CompositionsApi* | [**create_composition_database_record_0**](docs/CompositionsApi.md#create_composition_database_record_0) | **POST** /compositions/{id}/database/{table} | Create Record In Composition Database
|
|
97
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_0**](docs/CompositionsApi.md#delete_composition_0) | **DELETE** /compositions/{id} | Delete Composition
|
|
98
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_content_item_0**](docs/CompositionsApi.md#delete_composition_content_item_0) | **DELETE** /compositions/{id}/content/{list}/items/{itemId} | Delete a content list item
|
|
99
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_data_source_0**](docs/CompositionsApi.md#delete_composition_data_source_0) | **DELETE** /compositions/{id}/data-source | Remove the composition data source binding
|
|
100
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_database_record_0**](docs/CompositionsApi.md#delete_composition_database_record_0) | **DELETE** /compositions/{id}/database/{table}/{recordId} | Delete Record From Composition Database
|
|
101
|
+
*ApiSdkRb::CompositionsApi* | [**describe_composition_entries_0**](docs/CompositionsApi.md#describe_composition_entries_0) | **GET** /compositions/{id}/entries | Describe What a Composition Keeps
|
|
102
|
+
*ApiSdkRb::CompositionsApi* | [**duplicate_composition_0**](docs/CompositionsApi.md#duplicate_composition_0) | **POST** /compositions/{id}/duplicate | Duplicate Composition
|
|
103
|
+
*ApiSdkRb::CompositionsApi* | [**get_ai_answers_knowledge_0**](docs/CompositionsApi.md#get_ai_answers_knowledge_0) | **GET** /compositions/{id}/adapters/ai-answers/knowledge | See the documents a widget's AI answers from
|
|
104
|
+
*ApiSdkRb::CompositionsApi* | [**get_all_compositions_0**](docs/CompositionsApi.md#get_all_compositions_0) | **GET** /compositions | Get All Compositions
|
|
105
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_by_id_0**](docs/CompositionsApi.md#get_composition_by_id_0) | **GET** /compositions/{id} | Get Composition
|
|
106
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_content_0**](docs/CompositionsApi.md#get_composition_content_0) | **GET** /compositions/{id}/content | Get Current Content
|
|
107
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_content_schema_0**](docs/CompositionsApi.md#get_composition_content_schema_0) | **GET** /compositions/{id}/schema/content | Get Content Schema
|
|
108
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_data_source_0**](docs/CompositionsApi.md#get_composition_data_source_0) | **GET** /compositions/{id}/data-source | Read the composition data source binding
|
|
109
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_database_record_0**](docs/CompositionsApi.md#get_composition_database_record_0) | **GET** /compositions/{id}/database/{table}/{recordId} | Get Record From Composition Database
|
|
110
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_database_records_0**](docs/CompositionsApi.md#get_composition_database_records_0) | **GET** /compositions/{id}/database/{table} | Get All Records From Composition Database Table
|
|
111
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_design_0**](docs/CompositionsApi.md#get_composition_design_0) | **GET** /compositions/{id}/design | Get Composition Design
|
|
112
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_design_schema_0**](docs/CompositionsApi.md#get_composition_design_schema_0) | **GET** /compositions/{id}/schema/design | Get Design Schema
|
|
113
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_embed_schema_0**](docs/CompositionsApi.md#get_composition_embed_schema_0) | **GET** /compositions/{id}/schema/embed | Get Embed Schema
|
|
114
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_embed_settings_0**](docs/CompositionsApi.md#get_composition_embed_settings_0) | **GET** /compositions/{id}/embed-settings | Get Composition Embed Settings
|
|
115
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_preview_0**](docs/CompositionsApi.md#get_composition_preview_0) | **GET** /compositions/{id}/preview | Get Composition Preview
|
|
116
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_versions_0**](docs/CompositionsApi.md#get_composition_versions_0) | **GET** /compositions/{id}/versions | Get Composition Versions
|
|
117
|
+
*ApiSdkRb::CompositionsApi* | [**get_compositions_batch_0**](docs/CompositionsApi.md#get_compositions_batch_0) | **POST** /compositions/batch | Get Compositions Batch
|
|
118
|
+
*ApiSdkRb::CompositionsApi* | [**patch_composition_content_item_0**](docs/CompositionsApi.md#patch_composition_content_item_0) | **PATCH** /compositions/{id}/content/{list}/items/{itemId} | Update a content list item
|
|
119
|
+
*ApiSdkRb::CompositionsApi* | [**read_composition_entries_0**](docs/CompositionsApi.md#read_composition_entries_0) | **GET** /compositions/{id}/entries/{table} | Read the Entries of a Composition's Table
|
|
120
|
+
*ApiSdkRb::CompositionsApi* | [**remove_ai_answers_knowledge_document_0**](docs/CompositionsApi.md#remove_ai_answers_knowledge_document_0) | **DELETE** /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId} | Remove a document from a widget's knowledge base
|
|
121
|
+
*ApiSdkRb::CompositionsApi* | [**set_composition_data_source_0**](docs/CompositionsApi.md#set_composition_data_source_0) | **PUT** /compositions/{id}/data-source | Bind a public JSON data source for embed refresh
|
|
122
|
+
*ApiSdkRb::CompositionsApi* | [**set_dynamic_content_0**](docs/CompositionsApi.md#set_dynamic_content_0) | **PUT** /compositions/{id}/content | Set Dynamic Content
|
|
123
|
+
*ApiSdkRb::CompositionsApi* | [**update_composition_0**](docs/CompositionsApi.md#update_composition_0) | **PUT** /compositions/{id} | Update Composition
|
|
124
|
+
*ApiSdkRb::CompositionsApi* | [**update_composition_database_record_0**](docs/CompositionsApi.md#update_composition_database_record_0) | **PUT** /compositions/{id}/database/{table}/{recordId} | Update Record In Composition Database
|
|
125
|
+
*ApiSdkRb::CompositionsApi* | [**update_composition_status_0**](docs/CompositionsApi.md#update_composition_status_0) | **PUT** /compositions/{id}/status | Update Composition Status
|
|
126
|
+
*ApiSdkRb::CompositionsApi* | [**validate_composition_content_0**](docs/CompositionsApi.md#validate_composition_content_0) | **POST** /compositions/{id}/content/validate | Validate Content
|
|
127
|
+
*ApiSdkRb::CreditsApi* | [**get_user_credit_balance_0**](docs/CreditsApi.md#get_user_credit_balance_0) | **GET** /credits/user/{userId}/balance | Get an account's credit balance
|
|
128
|
+
*ApiSdkRb::CreditsApi* | [**get_user_credit_transactions_0**](docs/CreditsApi.md#get_user_credit_transactions_0) | **GET** /credits/user/{userId}/transactions | List an account's credit ledger
|
|
129
|
+
*ApiSdkRb::EntitlementsApi* | [**get_managed_user_entitlements_0**](docs/EntitlementsApi.md#get_managed_user_entitlements_0) | **GET** /entitlements/managed-users/{managedUserId} | Get managed user entitlements
|
|
130
|
+
*ApiSdkRb::EntitlementsApi* | [**get_partner_entitlements_0**](docs/EntitlementsApi.md#get_partner_entitlements_0) | **GET** /entitlements/partners/{partnerId} | Get partner entitlements
|
|
131
|
+
*ApiSdkRb::InvoicesApi* | [**get_invoices_by_partner_id_0**](docs/InvoicesApi.md#get_invoices_by_partner_id_0) | **GET** /invoices/partner/{partnerId} | List a partner's invoices
|
|
132
|
+
*ApiSdkRb::ManagedUsersApi* | [**copy_preset_for_managed_user_0**](docs/ManagedUsersApi.md#copy_preset_for_managed_user_0) | **POST** /managed-users/{id}/presets/{key}/copy | Give a managed user a copy of one of your presets
|
|
133
|
+
*ApiSdkRb::ManagedUsersApi* | [**create_composition_from_preset_0**](docs/ManagedUsersApi.md#create_composition_from_preset_0) | **POST** /managed-users/{id}/presets/{key}/composition | Create a composition from one of your presets in one call
|
|
134
|
+
*ApiSdkRb::ManagedUsersApi* | [**create_managed_user_0**](docs/ManagedUsersApi.md#create_managed_user_0) | **POST** /managed-users | Create Managed User
|
|
135
|
+
*ApiSdkRb::ManagedUsersApi* | [**create_managed_user_editor_session_0**](docs/ManagedUsersApi.md#create_managed_user_editor_session_0) | **POST** /managed-users/{id}/editor-sessions | Create an editor session for a managed user
|
|
136
|
+
*ApiSdkRb::ManagedUsersApi* | [**delete_managed_user_0**](docs/ManagedUsersApi.md#delete_managed_user_0) | **DELETE** /managed-users/{id} | Delete Managed User
|
|
137
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_all_managed_users_0**](docs/ManagedUsersApi.md#get_all_managed_users_0) | **GET** /managed-users | Get Managed Users
|
|
138
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_by_id_0**](docs/ManagedUsersApi.md#get_managed_user_by_id_0) | **GET** /managed-users/{id} | Get Managed User By ID
|
|
139
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_design_defaults_0**](docs/ManagedUsersApi.md#get_managed_user_design_defaults_0) | **GET** /managed-users/{id}/design-defaults | Read design defaults for one managed user
|
|
140
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_limits_0**](docs/ManagedUsersApi.md#get_managed_user_limits_0) | **GET** /managed-users/{id}/limits | Read monthly credit cap and usage for one managed user
|
|
141
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_storage_usage_0**](docs/ManagedUsersApi.md#get_managed_user_storage_usage_0) | **GET** /managed-users/{id}/storage-usage | Storage used by one managed user's uploads
|
|
142
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_usage_0**](docs/ManagedUsersApi.md#get_managed_user_usage_0) | **GET** /managed-users/{id}/usage | What a managed user's editor sessions spent
|
|
143
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_users_by_manager_id_0**](docs/ManagedUsersApi.md#get_managed_users_by_manager_id_0) | **GET** /users/{managerId}/managed-users | Get Managed Users By Manager
|
|
144
|
+
*ApiSdkRb::ManagedUsersApi* | [**revoke_managed_user_editor_session_0**](docs/ManagedUsersApi.md#revoke_managed_user_editor_session_0) | **DELETE** /managed-users/{id}/editor-sessions/{sessionId} | End one editor session of a managed user
|
|
145
|
+
*ApiSdkRb::ManagedUsersApi* | [**revoke_managed_user_editor_sessions_0**](docs/ManagedUsersApi.md#revoke_managed_user_editor_sessions_0) | **DELETE** /managed-users/{id}/editor-sessions | End every editor session of a managed user
|
|
146
|
+
*ApiSdkRb::ManagedUsersApi* | [**set_managed_user_design_defaults_0**](docs/ManagedUsersApi.md#set_managed_user_design_defaults_0) | **PUT** /managed-users/{id}/design-defaults | Set or clear design defaults for one managed user
|
|
147
|
+
*ApiSdkRb::ManagedUsersApi* | [**set_managed_user_limits_0**](docs/ManagedUsersApi.md#set_managed_user_limits_0) | **PUT** /managed-users/{id}/limits | Set or clear the monthly credit cap for one managed user
|
|
148
|
+
*ApiSdkRb::ManagedUsersApi* | [**update_managed_user_0**](docs/ManagedUsersApi.md#update_managed_user_0) | **PUT** /managed-users/{id} | Update Managed User
|
|
149
|
+
*ApiSdkRb::OperationsApi* | [**operations_id_get_0**](docs/OperationsApi.md#operations_id_get_0) | **GET** /operations/{id} | Get operation status
|
|
150
|
+
*ApiSdkRb::PartnerApi* | [**add_ai_answers_knowledge_document**](docs/PartnerApi.md#add_ai_answers_knowledge_document) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents | Add a document for a widget's AI to answer from
|
|
151
|
+
*ApiSdkRb::PartnerApi* | [**add_personal_workspace_domain**](docs/PartnerApi.md#add_personal_workspace_domain) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets
|
|
152
|
+
*ApiSdkRb::PartnerApi* | [**call_public_composition_adapter**](docs/PartnerApi.md#call_public_composition_adapter) | **POST** /embed/compositions/{compositionId}/adapters/{adapterId}/{operation} | Call a gateway operation of an adapter a published widget uses
|
|
153
|
+
*ApiSdkRb::PartnerApi* | [**check_composition_access**](docs/PartnerApi.md#check_composition_access) | **GET** /compositions/{id}/access | Check Composition Access
|
|
154
|
+
*ApiSdkRb::PartnerApi* | [**copy_preset_for_managed_user**](docs/PartnerApi.md#copy_preset_for_managed_user) | **POST** /managed-users/{id}/presets/{key}/copy | Give a managed user a copy of one of your presets
|
|
155
|
+
*ApiSdkRb::PartnerApi* | [**create_canvas**](docs/PartnerApi.md#create_canvas) | **POST** /canvases | Create Canvas
|
|
156
|
+
*ApiSdkRb::PartnerApi* | [**create_composition**](docs/PartnerApi.md#create_composition) | **POST** /compositions | Create Composition
|
|
157
|
+
*ApiSdkRb::PartnerApi* | [**create_composition_content_item**](docs/PartnerApi.md#create_composition_content_item) | **POST** /compositions/{id}/content/{list}/items | Add a content list item
|
|
158
|
+
*ApiSdkRb::PartnerApi* | [**create_composition_database_record**](docs/PartnerApi.md#create_composition_database_record) | **POST** /compositions/{id}/database/{table} | Create Record In Composition Database
|
|
159
|
+
*ApiSdkRb::PartnerApi* | [**create_composition_from_preset**](docs/PartnerApi.md#create_composition_from_preset) | **POST** /managed-users/{id}/presets/{key}/composition | Create a composition from one of your presets in one call
|
|
160
|
+
*ApiSdkRb::PartnerApi* | [**create_composition_from_widget**](docs/PartnerApi.md#create_composition_from_widget) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call
|
|
161
|
+
*ApiSdkRb::PartnerApi* | [**create_managed_user**](docs/PartnerApi.md#create_managed_user) | **POST** /managed-users | Create Managed User
|
|
162
|
+
*ApiSdkRb::PartnerApi* | [**create_managed_user_editor_session**](docs/PartnerApi.md#create_managed_user_editor_session) | **POST** /managed-users/{id}/editor-sessions | Create an editor session for a managed user
|
|
163
|
+
*ApiSdkRb::PartnerApi* | [**create_partner_extra_credits_invoice**](docs/PartnerApi.md#create_partner_extra_credits_invoice) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner
|
|
164
|
+
*ApiSdkRb::PartnerApi* | [**create_public_composition_entry**](docs/PartnerApi.md#create_public_composition_entry) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway
|
|
165
|
+
*ApiSdkRb::PartnerApi* | [**create_user_api_key**](docs/PartnerApi.md#create_user_api_key) | **POST** /users/{id}/keys | Create an API key
|
|
166
|
+
*ApiSdkRb::PartnerApi* | [**create_widget**](docs/PartnerApi.md#create_widget) | **POST** /widgets | Create Widget
|
|
167
|
+
*ApiSdkRb::PartnerApi* | [**delete_canvas**](docs/PartnerApi.md#delete_canvas) | **DELETE** /canvases/{id} | Delete Canvas
|
|
168
|
+
*ApiSdkRb::PartnerApi* | [**delete_composition**](docs/PartnerApi.md#delete_composition) | **DELETE** /compositions/{id} | Delete Composition
|
|
169
|
+
*ApiSdkRb::PartnerApi* | [**delete_composition_content_item**](docs/PartnerApi.md#delete_composition_content_item) | **DELETE** /compositions/{id}/content/{list}/items/{itemId} | Delete a content list item
|
|
170
|
+
*ApiSdkRb::PartnerApi* | [**delete_composition_data_source**](docs/PartnerApi.md#delete_composition_data_source) | **DELETE** /compositions/{id}/data-source | Remove the composition data source binding
|
|
171
|
+
*ApiSdkRb::PartnerApi* | [**delete_composition_database_record**](docs/PartnerApi.md#delete_composition_database_record) | **DELETE** /compositions/{id}/database/{table}/{recordId} | Delete Record From Composition Database
|
|
172
|
+
*ApiSdkRb::PartnerApi* | [**delete_composition_entry_items**](docs/PartnerApi.md#delete_composition_entry_items) | **DELETE** /compositions/{id}/entries/{table}/items | Delete composition entry items by id or host context
|
|
173
|
+
*ApiSdkRb::PartnerApi* | [**delete_managed_user**](docs/PartnerApi.md#delete_managed_user) | **DELETE** /managed-users/{id} | Delete Managed User
|
|
174
|
+
*ApiSdkRb::PartnerApi* | [**delete_personal_workspace_domain**](docs/PartnerApi.md#delete_personal_workspace_domain) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets
|
|
175
|
+
*ApiSdkRb::PartnerApi* | [**delete_user_api_key**](docs/PartnerApi.md#delete_user_api_key) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key
|
|
176
|
+
*ApiSdkRb::PartnerApi* | [**describe_composition_entries**](docs/PartnerApi.md#describe_composition_entries) | **GET** /compositions/{id}/entries | Describe What a Composition Keeps
|
|
177
|
+
*ApiSdkRb::PartnerApi* | [**duplicate_composition**](docs/PartnerApi.md#duplicate_composition) | **POST** /compositions/{id}/duplicate | Duplicate Composition
|
|
178
|
+
*ApiSdkRb::PartnerApi* | [**export_composition_entry_items**](docs/PartnerApi.md#export_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/export | Export composition entry items
|
|
179
|
+
*ApiSdkRb::PartnerApi* | [**get_ai_answers_knowledge**](docs/PartnerApi.md#get_ai_answers_knowledge) | **GET** /compositions/{id}/adapters/ai-answers/knowledge | See the documents a widget's AI answers from
|
|
180
|
+
*ApiSdkRb::PartnerApi* | [**get_all_canvases**](docs/PartnerApi.md#get_all_canvases) | **GET** /canvases | Get All Canvases
|
|
181
|
+
*ApiSdkRb::PartnerApi* | [**get_all_compositions**](docs/PartnerApi.md#get_all_compositions) | **GET** /compositions | Get All Compositions
|
|
182
|
+
*ApiSdkRb::PartnerApi* | [**get_all_managed_users**](docs/PartnerApi.md#get_all_managed_users) | **GET** /managed-users | Get Managed Users
|
|
183
|
+
*ApiSdkRb::PartnerApi* | [**get_canvas**](docs/PartnerApi.md#get_canvas) | **GET** /canvases/{id} | Get Canvas
|
|
184
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_by_id**](docs/PartnerApi.md#get_composition_by_id) | **GET** /compositions/{id} | Get Composition
|
|
185
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_content**](docs/PartnerApi.md#get_composition_content) | **GET** /compositions/{id}/content | Get Current Content
|
|
186
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_content_schema**](docs/PartnerApi.md#get_composition_content_schema) | **GET** /compositions/{id}/schema/content | Get Content Schema
|
|
187
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_data_source**](docs/PartnerApi.md#get_composition_data_source) | **GET** /compositions/{id}/data-source | Read the composition data source binding
|
|
188
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_database_record**](docs/PartnerApi.md#get_composition_database_record) | **GET** /compositions/{id}/database/{table}/{recordId} | Get Record From Composition Database
|
|
189
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_database_records**](docs/PartnerApi.md#get_composition_database_records) | **GET** /compositions/{id}/database/{table} | Get All Records From Composition Database Table
|
|
190
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_design**](docs/PartnerApi.md#get_composition_design) | **GET** /compositions/{id}/design | Get Composition Design
|
|
191
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_design_schema**](docs/PartnerApi.md#get_composition_design_schema) | **GET** /compositions/{id}/schema/design | Get Design Schema
|
|
192
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_embed_schema**](docs/PartnerApi.md#get_composition_embed_schema) | **GET** /compositions/{id}/schema/embed | Get Embed Schema
|
|
193
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_embed_settings**](docs/PartnerApi.md#get_composition_embed_settings) | **GET** /compositions/{id}/embed-settings | Get Composition Embed Settings
|
|
194
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_preview**](docs/PartnerApi.md#get_composition_preview) | **GET** /compositions/{id}/preview | Get Composition Preview
|
|
195
|
+
*ApiSdkRb::PartnerApi* | [**get_composition_versions**](docs/PartnerApi.md#get_composition_versions) | **GET** /compositions/{id}/versions | Get Composition Versions
|
|
196
|
+
*ApiSdkRb::PartnerApi* | [**get_compositions_batch**](docs/PartnerApi.md#get_compositions_batch) | **POST** /compositions/batch | Get Compositions Batch
|
|
197
|
+
*ApiSdkRb::PartnerApi* | [**get_invoices_by_partner_id**](docs/PartnerApi.md#get_invoices_by_partner_id) | **GET** /invoices/partner/{partnerId} | List a partner's invoices
|
|
198
|
+
*ApiSdkRb::PartnerApi* | [**get_managed_user_by_id**](docs/PartnerApi.md#get_managed_user_by_id) | **GET** /managed-users/{id} | Get Managed User By ID
|
|
199
|
+
*ApiSdkRb::PartnerApi* | [**get_managed_user_design_defaults**](docs/PartnerApi.md#get_managed_user_design_defaults) | **GET** /managed-users/{id}/design-defaults | Read design defaults for one managed user
|
|
200
|
+
*ApiSdkRb::PartnerApi* | [**get_managed_user_entitlements**](docs/PartnerApi.md#get_managed_user_entitlements) | **GET** /entitlements/managed-users/{managedUserId} | Get managed user entitlements
|
|
201
|
+
*ApiSdkRb::PartnerApi* | [**get_managed_user_limits**](docs/PartnerApi.md#get_managed_user_limits) | **GET** /managed-users/{id}/limits | Read monthly credit cap and usage for one managed user
|
|
202
|
+
*ApiSdkRb::PartnerApi* | [**get_managed_user_storage_usage**](docs/PartnerApi.md#get_managed_user_storage_usage) | **GET** /managed-users/{id}/storage-usage | Storage used by one managed user's uploads
|
|
203
|
+
*ApiSdkRb::PartnerApi* | [**get_managed_user_usage**](docs/PartnerApi.md#get_managed_user_usage) | **GET** /managed-users/{id}/usage | What a managed user's editor sessions spent
|
|
204
|
+
*ApiSdkRb::PartnerApi* | [**get_managed_users_by_manager_id**](docs/PartnerApi.md#get_managed_users_by_manager_id) | **GET** /users/{managerId}/managed-users | Get Managed Users By Manager
|
|
205
|
+
*ApiSdkRb::PartnerApi* | [**get_my_partners**](docs/PartnerApi.md#get_my_partners) | **GET** /partners/mine | Find the partner you administer
|
|
206
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_adapter_connections**](docs/PartnerApi.md#get_partner_adapter_connections) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected
|
|
207
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_analytics_by_managed_user**](docs/PartnerApi.md#get_partner_analytics_by_managed_user) | **GET** /partners/{partnerId}/analytics/managed-users | What each managed user's widgets did
|
|
208
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_analytics_summary**](docs/PartnerApi.md#get_partner_analytics_summary) | **GET** /partners/{partnerId}/analytics/summary | What was done with a partner's published widgets
|
|
209
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_analytics_timeline**](docs/PartnerApi.md#get_partner_analytics_timeline) | **GET** /partners/{partnerId}/analytics/timeline | What was done with a partner's widgets, day by day
|
|
210
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_analytics_top_widgets**](docs/PartnerApi.md#get_partner_analytics_top_widgets) | **GET** /partners/{partnerId}/analytics/top-widgets | Which widgets were viewed the most
|
|
211
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_billing_overview**](docs/PartnerApi.md#get_partner_billing_overview) | **GET** /partners/{partnerId}/billing-overview | Get comprehensive partner billing overview
|
|
212
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_contract**](docs/PartnerApi.md#get_partner_contract) | **GET** /partners/{partnerId}/contract | Get a partner's contract
|
|
213
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_credit_balance**](docs/PartnerApi.md#get_partner_credit_balance) | **GET** /partners/{partnerId}/credits/balance | Get partner credit balance
|
|
214
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_credit_transactions**](docs/PartnerApi.md#get_partner_credit_transactions) | **GET** /partners/{partnerId}/credits/transactions | Get partner credit transaction history
|
|
215
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_data_database**](docs/PartnerApi.md#get_partner_data_database) | **GET** /partners/{partnerId}/data-database | See the Neon database a partner keeps the data of its compositions in
|
|
216
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_design_defaults**](docs/PartnerApi.md#get_partner_design_defaults) | **GET** /partners/{partnerId}/design-defaults | Read partner-wide design defaults
|
|
217
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_entitlements**](docs/PartnerApi.md#get_partner_entitlements) | **GET** /entitlements/partners/{partnerId} | Get partner entitlements
|
|
218
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_entry_context_signing**](docs/PartnerApi.md#get_partner_entry_context_signing) | **GET** /partners/{partnerId}/entry-context-signing | See how the context of your embeds is signed
|
|
219
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_notification_settings**](docs/PartnerApi.md#get_partner_notification_settings) | **GET** /partners/{partnerId}/notifications/settings | Where your notifications go
|
|
220
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_storage_destination**](docs/PartnerApi.md#get_partner_storage_destination) | **GET** /partners/{partnerId}/storage | Get where a partner's uploaded files are stored
|
|
221
|
+
*ApiSdkRb::PartnerApi* | [**get_partner_storage_usage**](docs/PartnerApi.md#get_partner_storage_usage) | **GET** /partners/{partnerId}/storage/usage | What a partner's customers store
|
|
222
|
+
*ApiSdkRb::PartnerApi* | [**get_personal_workspace_domains**](docs/PartnerApi.md#get_personal_workspace_domains) | **GET** /users/{id}/workspace/domains | List the websites allowed to show your widgets
|
|
223
|
+
*ApiSdkRb::PartnerApi* | [**get_public_composition_embed**](docs/PartnerApi.md#get_public_composition_embed) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL
|
|
224
|
+
*ApiSdkRb::PartnerApi* | [**get_public_composition_iframe**](docs/PartnerApi.md#get_public_composition_iframe) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values
|
|
225
|
+
*ApiSdkRb::PartnerApi* | [**get_user_adapter_connections**](docs/PartnerApi.md#get_user_adapter_connections) | **GET** /users/{userId}/adapter-connections | See which adapter keys an account has connected
|
|
226
|
+
*ApiSdkRb::PartnerApi* | [**get_user_api_key_usage_logs**](docs/PartnerApi.md#get_user_api_key_usage_logs) | **GET** /users/{id}/api-keys/{keyId}/logs | Read what an API key was used for
|
|
227
|
+
*ApiSdkRb::PartnerApi* | [**get_user_api_keys**](docs/PartnerApi.md#get_user_api_keys) | **GET** /users/{id}/keys | List the API keys of an account
|
|
228
|
+
*ApiSdkRb::PartnerApi* | [**get_user_credit_balance**](docs/PartnerApi.md#get_user_credit_balance) | **GET** /credits/user/{userId}/balance | Get an account's credit balance
|
|
229
|
+
*ApiSdkRb::PartnerApi* | [**get_user_credit_transactions**](docs/PartnerApi.md#get_user_credit_transactions) | **GET** /credits/user/{userId}/transactions | List an account's credit ledger
|
|
230
|
+
*ApiSdkRb::PartnerApi* | [**get_widgets**](docs/PartnerApi.md#get_widgets) | **GET** /widgets | List Widgets
|
|
231
|
+
*ApiSdkRb::PartnerApi* | [**get_widgets_batch**](docs/PartnerApi.md#get_widgets_batch) | **POST** /widgets/batch | Get Widgets Batch
|
|
232
|
+
*ApiSdkRb::PartnerApi* | [**list_composition_entry_items**](docs/PartnerApi.md#list_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/items | List composition entry items with paging and filters
|
|
233
|
+
*ApiSdkRb::PartnerApi* | [**list_managed_user_entries**](docs/PartnerApi.md#list_managed_user_entries) | **GET** /managed-users/{id}/entries | List entries across a managed user's compositions
|
|
234
|
+
*ApiSdkRb::PartnerApi* | [**list_partner_notification_deliveries**](docs/PartnerApi.md#list_partner_notification_deliveries) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you
|
|
235
|
+
*ApiSdkRb::PartnerApi* | [**list_partner_notifications**](docs/PartnerApi.md#list_partner_notifications) | **GET** /partners/{partnerId}/notifications | What your partner account was told
|
|
236
|
+
*ApiSdkRb::PartnerApi* | [**list_partner_presets**](docs/PartnerApi.md#list_partner_presets) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets
|
|
237
|
+
*ApiSdkRb::PartnerApi* | [**operations_id_get**](docs/PartnerApi.md#operations_id_get) | **GET** /operations/{id} | Get operation status
|
|
238
|
+
*ApiSdkRb::PartnerApi* | [**patch_composition_content_item**](docs/PartnerApi.md#patch_composition_content_item) | **PATCH** /compositions/{id}/content/{list}/items/{itemId} | Update a content list item
|
|
239
|
+
*ApiSdkRb::PartnerApi* | [**post_public_composition_embed_status**](docs/PartnerApi.md#post_public_composition_embed_status) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed
|
|
240
|
+
*ApiSdkRb::PartnerApi* | [**read_composition_entries**](docs/PartnerApi.md#read_composition_entries) | **GET** /compositions/{id}/entries/{table} | Read the Entries of a Composition's Table
|
|
241
|
+
*ApiSdkRb::PartnerApi* | [**remove_ai_answers_knowledge_document**](docs/PartnerApi.md#remove_ai_answers_knowledge_document) | **DELETE** /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId} | Remove a document from a widget's knowledge base
|
|
242
|
+
*ApiSdkRb::PartnerApi* | [**remove_partner_adapter_connection**](docs/PartnerApi.md#remove_partner_adapter_connection) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner
|
|
243
|
+
*ApiSdkRb::PartnerApi* | [**remove_partner_data_database**](docs/PartnerApi.md#remove_partner_data_database) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database
|
|
244
|
+
*ApiSdkRb::PartnerApi* | [**remove_partner_preset**](docs/PartnerApi.md#remove_partner_preset) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets
|
|
245
|
+
*ApiSdkRb::PartnerApi* | [**remove_partner_storage_destination**](docs/PartnerApi.md#remove_partner_storage_destination) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket
|
|
246
|
+
*ApiSdkRb::PartnerApi* | [**remove_user_adapter_connection**](docs/PartnerApi.md#remove_user_adapter_connection) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account
|
|
247
|
+
*ApiSdkRb::PartnerApi* | [**replay_partner_notification_delivery**](docs/PartnerApi.md#replay_partner_notification_delivery) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again
|
|
248
|
+
*ApiSdkRb::PartnerApi* | [**revoke_managed_user_editor_session**](docs/PartnerApi.md#revoke_managed_user_editor_session) | **DELETE** /managed-users/{id}/editor-sessions/{sessionId} | End one editor session of a managed user
|
|
249
|
+
*ApiSdkRb::PartnerApi* | [**revoke_managed_user_editor_sessions**](docs/PartnerApi.md#revoke_managed_user_editor_sessions) | **DELETE** /managed-users/{id}/editor-sessions | End every editor session of a managed user
|
|
250
|
+
*ApiSdkRb::PartnerApi* | [**rotate_partner_entry_context_secret**](docs/PartnerApi.md#rotate_partner_entry_context_secret) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds
|
|
251
|
+
*ApiSdkRb::PartnerApi* | [**rotate_partner_webhook_secret**](docs/PartnerApi.md#rotate_partner_webhook_secret) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook
|
|
252
|
+
*ApiSdkRb::PartnerApi* | [**send_partner_notification_test_event**](docs/PartnerApi.md#send_partner_notification_test_event) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook
|
|
253
|
+
*ApiSdkRb::PartnerApi* | [**set_composition_data_source**](docs/PartnerApi.md#set_composition_data_source) | **PUT** /compositions/{id}/data-source | Bind a public JSON data source for embed refresh
|
|
254
|
+
*ApiSdkRb::PartnerApi* | [**set_dynamic_content**](docs/PartnerApi.md#set_dynamic_content) | **PUT** /compositions/{id}/content | Set Dynamic Content
|
|
255
|
+
*ApiSdkRb::PartnerApi* | [**set_managed_user_design_defaults**](docs/PartnerApi.md#set_managed_user_design_defaults) | **PUT** /managed-users/{id}/design-defaults | Set or clear design defaults for one managed user
|
|
256
|
+
*ApiSdkRb::PartnerApi* | [**set_managed_user_limits**](docs/PartnerApi.md#set_managed_user_limits) | **PUT** /managed-users/{id}/limits | Set or clear the monthly credit cap for one managed user
|
|
257
|
+
*ApiSdkRb::PartnerApi* | [**set_partner_adapter_connection**](docs/PartnerApi.md#set_partner_adapter_connection) | **PUT** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to a partner
|
|
258
|
+
*ApiSdkRb::PartnerApi* | [**set_partner_data_database**](docs/PartnerApi.md#set_partner_data_database) | **PUT** /partners/{partnerId}/data-database | Keep the data of a partner's compositions in a Neon database of its own
|
|
259
|
+
*ApiSdkRb::PartnerApi* | [**set_partner_design_defaults**](docs/PartnerApi.md#set_partner_design_defaults) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults
|
|
260
|
+
*ApiSdkRb::PartnerApi* | [**set_partner_preset**](docs/PartnerApi.md#set_partner_preset) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset
|
|
261
|
+
*ApiSdkRb::PartnerApi* | [**set_partner_storage_destination**](docs/PartnerApi.md#set_partner_storage_destination) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored
|
|
262
|
+
*ApiSdkRb::PartnerApi* | [**set_user_adapter_connection**](docs/PartnerApi.md#set_user_adapter_connection) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account
|
|
263
|
+
*ApiSdkRb::PartnerApi* | [**update_canvas**](docs/PartnerApi.md#update_canvas) | **PUT** /canvases/{id} | Update Canvas
|
|
264
|
+
*ApiSdkRb::PartnerApi* | [**update_composition**](docs/PartnerApi.md#update_composition) | **PUT** /compositions/{id} | Update Composition
|
|
265
|
+
*ApiSdkRb::PartnerApi* | [**update_composition_database_record**](docs/PartnerApi.md#update_composition_database_record) | **PUT** /compositions/{id}/database/{table}/{recordId} | Update Record In Composition Database
|
|
266
|
+
*ApiSdkRb::PartnerApi* | [**update_composition_status**](docs/PartnerApi.md#update_composition_status) | **PUT** /compositions/{id}/status | Update Composition Status
|
|
267
|
+
*ApiSdkRb::PartnerApi* | [**update_managed_user**](docs/PartnerApi.md#update_managed_user) | **PUT** /managed-users/{id} | Update Managed User
|
|
268
|
+
*ApiSdkRb::PartnerApi* | [**update_partner_entry_context_signing**](docs/PartnerApi.md#update_partner_entry_context_signing) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it
|
|
269
|
+
*ApiSdkRb::PartnerApi* | [**update_partner_notification_settings**](docs/PartnerApi.md#update_partner_notification_settings) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go
|
|
270
|
+
*ApiSdkRb::PartnerApi* | [**update_personal_workspace_domain**](docs/PartnerApi.md#update_personal_workspace_domain) | **PUT** /users/{id}/workspace/domains/{domainId} | Change a website on your list
|
|
271
|
+
*ApiSdkRb::PartnerApi* | [**update_user_api_key**](docs/PartnerApi.md#update_user_api_key) | **PUT** /users/{id}/keys/{keyId} | Rename an API key, or switch it off or on
|
|
272
|
+
*ApiSdkRb::PartnerApi* | [**upload_public_composition_adapter_file**](docs/PartnerApi.md#upload_public_composition_adapter_file) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget
|
|
273
|
+
*ApiSdkRb::PartnerApi* | [**uploads_get**](docs/PartnerApi.md#uploads_get) | **GET** /uploads | List the account's uploads
|
|
274
|
+
*ApiSdkRb::PartnerApi* | [**uploads_id_delete**](docs/PartnerApi.md#uploads_id_delete) | **DELETE** /uploads/{id} | Delete an upload
|
|
275
|
+
*ApiSdkRb::PartnerApi* | [**uploads_id_get**](docs/PartnerApi.md#uploads_id_get) | **GET** /uploads/{id} | Get an upload by id
|
|
276
|
+
*ApiSdkRb::PartnerApi* | [**uploads_limits_get**](docs/PartnerApi.md#uploads_limits_get) | **GET** /uploads/limits | Upload size limits and accepted file types
|
|
277
|
+
*ApiSdkRb::PartnerApi* | [**uploads_post**](docs/PartnerApi.md#uploads_post) | **POST** /uploads | Upload a file
|
|
278
|
+
*ApiSdkRb::PartnerApi* | [**validate_composition_content**](docs/PartnerApi.md#validate_composition_content) | **POST** /compositions/{id}/content/validate | Validate Content
|
|
279
|
+
*ApiSdkRb::PartnerApi* | [**validate_token**](docs/PartnerApi.md#validate_token) | **GET** /tokens/validate | Validate current authentication token
|
|
280
|
+
*ApiSdkRb::PartnerApi* | [**verify_partner_data_database**](docs/PartnerApi.md#verify_partner_data_database) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works
|
|
281
|
+
*ApiSdkRb::PartnerApi* | [**verify_partner_storage_destination**](docs/PartnerApi.md#verify_partner_storage_destination) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works
|
|
282
|
+
*ApiSdkRb::PartnersApi* | [**create_partner_extra_credits_invoice_0**](docs/PartnersApi.md#create_partner_extra_credits_invoice_0) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner
|
|
283
|
+
*ApiSdkRb::PartnersApi* | [**get_my_partners_0**](docs/PartnersApi.md#get_my_partners_0) | **GET** /partners/mine | Find the partner you administer
|
|
284
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_adapter_connections_0**](docs/PartnersApi.md#get_partner_adapter_connections_0) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected
|
|
285
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_by_managed_user_0**](docs/PartnersApi.md#get_partner_analytics_by_managed_user_0) | **GET** /partners/{partnerId}/analytics/managed-users | What each managed user's widgets did
|
|
286
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_summary_0**](docs/PartnersApi.md#get_partner_analytics_summary_0) | **GET** /partners/{partnerId}/analytics/summary | What was done with a partner's published widgets
|
|
287
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_timeline_0**](docs/PartnersApi.md#get_partner_analytics_timeline_0) | **GET** /partners/{partnerId}/analytics/timeline | What was done with a partner's widgets, day by day
|
|
288
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_top_widgets_0**](docs/PartnersApi.md#get_partner_analytics_top_widgets_0) | **GET** /partners/{partnerId}/analytics/top-widgets | Which widgets were viewed the most
|
|
289
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_billing_overview_0**](docs/PartnersApi.md#get_partner_billing_overview_0) | **GET** /partners/{partnerId}/billing-overview | Get comprehensive partner billing overview
|
|
290
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_contract_0**](docs/PartnersApi.md#get_partner_contract_0) | **GET** /partners/{partnerId}/contract | Get a partner's contract
|
|
291
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_credit_balance_0**](docs/PartnersApi.md#get_partner_credit_balance_0) | **GET** /partners/{partnerId}/credits/balance | Get partner credit balance
|
|
292
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_credit_transactions_0**](docs/PartnersApi.md#get_partner_credit_transactions_0) | **GET** /partners/{partnerId}/credits/transactions | Get partner credit transaction history
|
|
293
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_data_database_0**](docs/PartnersApi.md#get_partner_data_database_0) | **GET** /partners/{partnerId}/data-database | See the Neon database a partner keeps the data of its compositions in
|
|
294
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_design_defaults_0**](docs/PartnersApi.md#get_partner_design_defaults_0) | **GET** /partners/{partnerId}/design-defaults | Read partner-wide design defaults
|
|
295
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_entry_context_signing_0**](docs/PartnersApi.md#get_partner_entry_context_signing_0) | **GET** /partners/{partnerId}/entry-context-signing | See how the context of your embeds is signed
|
|
296
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_notification_settings_0**](docs/PartnersApi.md#get_partner_notification_settings_0) | **GET** /partners/{partnerId}/notifications/settings | Where your notifications go
|
|
297
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_storage_destination_0**](docs/PartnersApi.md#get_partner_storage_destination_0) | **GET** /partners/{partnerId}/storage | Get where a partner's uploaded files are stored
|
|
298
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_storage_usage_0**](docs/PartnersApi.md#get_partner_storage_usage_0) | **GET** /partners/{partnerId}/storage/usage | What a partner's customers store
|
|
299
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_notification_deliveries_0**](docs/PartnersApi.md#list_partner_notification_deliveries_0) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you
|
|
300
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_notifications_0**](docs/PartnersApi.md#list_partner_notifications_0) | **GET** /partners/{partnerId}/notifications | What your partner account was told
|
|
301
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_presets_0**](docs/PartnersApi.md#list_partner_presets_0) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets
|
|
302
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_adapter_connection_0**](docs/PartnersApi.md#remove_partner_adapter_connection_0) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner
|
|
303
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_data_database_0**](docs/PartnersApi.md#remove_partner_data_database_0) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database
|
|
304
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_preset_0**](docs/PartnersApi.md#remove_partner_preset_0) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets
|
|
305
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_storage_destination_0**](docs/PartnersApi.md#remove_partner_storage_destination_0) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket
|
|
306
|
+
*ApiSdkRb::PartnersApi* | [**replay_partner_notification_delivery_0**](docs/PartnersApi.md#replay_partner_notification_delivery_0) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again
|
|
307
|
+
*ApiSdkRb::PartnersApi* | [**rotate_partner_entry_context_secret_0**](docs/PartnersApi.md#rotate_partner_entry_context_secret_0) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds
|
|
308
|
+
*ApiSdkRb::PartnersApi* | [**rotate_partner_webhook_secret_0**](docs/PartnersApi.md#rotate_partner_webhook_secret_0) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook
|
|
309
|
+
*ApiSdkRb::PartnersApi* | [**send_partner_notification_test_event_0**](docs/PartnersApi.md#send_partner_notification_test_event_0) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook
|
|
310
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_adapter_connection_0**](docs/PartnersApi.md#set_partner_adapter_connection_0) | **PUT** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to a partner
|
|
311
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_data_database_0**](docs/PartnersApi.md#set_partner_data_database_0) | **PUT** /partners/{partnerId}/data-database | Keep the data of a partner's compositions in a Neon database of its own
|
|
312
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_design_defaults_0**](docs/PartnersApi.md#set_partner_design_defaults_0) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults
|
|
313
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_preset_0**](docs/PartnersApi.md#set_partner_preset_0) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset
|
|
314
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_storage_destination_0**](docs/PartnersApi.md#set_partner_storage_destination_0) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored
|
|
315
|
+
*ApiSdkRb::PartnersApi* | [**update_partner_entry_context_signing_0**](docs/PartnersApi.md#update_partner_entry_context_signing_0) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it
|
|
316
|
+
*ApiSdkRb::PartnersApi* | [**update_partner_notification_settings_0**](docs/PartnersApi.md#update_partner_notification_settings_0) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go
|
|
317
|
+
*ApiSdkRb::PartnersApi* | [**verify_partner_data_database_0**](docs/PartnersApi.md#verify_partner_data_database_0) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works
|
|
318
|
+
*ApiSdkRb::PartnersApi* | [**verify_partner_storage_destination_0**](docs/PartnersApi.md#verify_partner_storage_destination_0) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works
|
|
319
|
+
*ApiSdkRb::PublicEmbedApi* | [**call_public_composition_adapter_0**](docs/PublicEmbedApi.md#call_public_composition_adapter_0) | **POST** /embed/compositions/{compositionId}/adapters/{adapterId}/{operation} | Call a gateway operation of an adapter a published widget uses
|
|
320
|
+
*ApiSdkRb::PublicEmbedApi* | [**create_public_composition_entry_0**](docs/PublicEmbedApi.md#create_public_composition_entry_0) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway
|
|
321
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_embed_0**](docs/PublicEmbedApi.md#get_public_composition_embed_0) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL
|
|
322
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_iframe_0**](docs/PublicEmbedApi.md#get_public_composition_iframe_0) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values
|
|
323
|
+
*ApiSdkRb::PublicEmbedApi* | [**post_public_composition_embed_status_0**](docs/PublicEmbedApi.md#post_public_composition_embed_status_0) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed
|
|
324
|
+
*ApiSdkRb::PublicEmbedApi* | [**upload_public_composition_adapter_file_0**](docs/PublicEmbedApi.md#upload_public_composition_adapter_file_0) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget
|
|
325
|
+
*ApiSdkRb::TokensApi* | [**validate_token_0**](docs/TokensApi.md#validate_token_0) | **GET** /tokens/validate | Validate current authentication token
|
|
326
|
+
*ApiSdkRb::UploadsApi* | [**uploads_get_0**](docs/UploadsApi.md#uploads_get_0) | **GET** /uploads | List the account's uploads
|
|
327
|
+
*ApiSdkRb::UploadsApi* | [**uploads_id_delete_0**](docs/UploadsApi.md#uploads_id_delete_0) | **DELETE** /uploads/{id} | Delete an upload
|
|
328
|
+
*ApiSdkRb::UploadsApi* | [**uploads_id_get_0**](docs/UploadsApi.md#uploads_id_get_0) | **GET** /uploads/{id} | Get an upload by id
|
|
329
|
+
*ApiSdkRb::UploadsApi* | [**uploads_limits_get_0**](docs/UploadsApi.md#uploads_limits_get_0) | **GET** /uploads/limits | Upload size limits and accepted file types
|
|
330
|
+
*ApiSdkRb::UploadsApi* | [**uploads_post_0**](docs/UploadsApi.md#uploads_post_0) | **POST** /uploads | Upload a file
|
|
331
|
+
*ApiSdkRb::UsersApi* | [**add_personal_workspace_domain_0**](docs/UsersApi.md#add_personal_workspace_domain_0) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets
|
|
332
|
+
*ApiSdkRb::UsersApi* | [**create_user_api_key_0**](docs/UsersApi.md#create_user_api_key_0) | **POST** /users/{id}/keys | Create an API key
|
|
333
|
+
*ApiSdkRb::UsersApi* | [**delete_personal_workspace_domain_0**](docs/UsersApi.md#delete_personal_workspace_domain_0) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets
|
|
334
|
+
*ApiSdkRb::UsersApi* | [**delete_user_api_key_0**](docs/UsersApi.md#delete_user_api_key_0) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key
|
|
335
|
+
*ApiSdkRb::UsersApi* | [**get_personal_workspace_domains_0**](docs/UsersApi.md#get_personal_workspace_domains_0) | **GET** /users/{id}/workspace/domains | List the websites allowed to show your widgets
|
|
336
|
+
*ApiSdkRb::UsersApi* | [**get_user_adapter_connections_0**](docs/UsersApi.md#get_user_adapter_connections_0) | **GET** /users/{userId}/adapter-connections | See which adapter keys an account has connected
|
|
337
|
+
*ApiSdkRb::UsersApi* | [**get_user_api_key_usage_logs_0**](docs/UsersApi.md#get_user_api_key_usage_logs_0) | **GET** /users/{id}/api-keys/{keyId}/logs | Read what an API key was used for
|
|
338
|
+
*ApiSdkRb::UsersApi* | [**get_user_api_keys_0**](docs/UsersApi.md#get_user_api_keys_0) | **GET** /users/{id}/keys | List the API keys of an account
|
|
339
|
+
*ApiSdkRb::UsersApi* | [**remove_user_adapter_connection_0**](docs/UsersApi.md#remove_user_adapter_connection_0) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account
|
|
340
|
+
*ApiSdkRb::UsersApi* | [**set_user_adapter_connection_0**](docs/UsersApi.md#set_user_adapter_connection_0) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account
|
|
341
|
+
*ApiSdkRb::UsersApi* | [**update_personal_workspace_domain_0**](docs/UsersApi.md#update_personal_workspace_domain_0) | **PUT** /users/{id}/workspace/domains/{domainId} | Change a website on your list
|
|
342
|
+
*ApiSdkRb::UsersApi* | [**update_user_api_key_0**](docs/UsersApi.md#update_user_api_key_0) | **PUT** /users/{id}/keys/{keyId} | Rename an API key, or switch it off or on
|
|
343
|
+
*ApiSdkRb::WidgetsApi* | [**create_composition_from_widget_0**](docs/WidgetsApi.md#create_composition_from_widget_0) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call
|
|
344
|
+
*ApiSdkRb::WidgetsApi* | [**create_widget_0**](docs/WidgetsApi.md#create_widget_0) | **POST** /widgets | Create Widget
|
|
345
|
+
*ApiSdkRb::WidgetsApi* | [**get_widgets_0**](docs/WidgetsApi.md#get_widgets_0) | **GET** /widgets | List Widgets
|
|
346
|
+
*ApiSdkRb::WidgetsApi* | [**get_widgets_batch_0**](docs/WidgetsApi.md#get_widgets_batch_0) | **POST** /widgets/batch | Get Widgets Batch
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
## Documentation for Models
|
|
350
|
+
|
|
351
|
+
- [ApiSdkRb::AccountCreditBalance](docs/AccountCreditBalance.md)
|
|
352
|
+
- [ApiSdkRb::AccountCreditBalanceResponse](docs/AccountCreditBalanceResponse.md)
|
|
353
|
+
- [ApiSdkRb::AccountCreditTransaction](docs/AccountCreditTransaction.md)
|
|
354
|
+
- [ApiSdkRb::AdapterConnection](docs/AdapterConnection.md)
|
|
355
|
+
- [ApiSdkRb::AdapterConnectionRemoval](docs/AdapterConnectionRemoval.md)
|
|
356
|
+
- [ApiSdkRb::AddAiAnswersKnowledgeDocument201Response](docs/AddAiAnswersKnowledgeDocument201Response.md)
|
|
357
|
+
- [ApiSdkRb::AddAiAnswersKnowledgeDocumentRequest](docs/AddAiAnswersKnowledgeDocumentRequest.md)
|
|
358
|
+
- [ApiSdkRb::AddDomainRequest](docs/AddDomainRequest.md)
|
|
359
|
+
- [ApiSdkRb::AiAnswersKnowledge](docs/AiAnswersKnowledge.md)
|
|
360
|
+
- [ApiSdkRb::AiAnswersKnowledgeDocument](docs/AiAnswersKnowledgeDocument.md)
|
|
361
|
+
- [ApiSdkRb::AiAnswersKnowledgeRemoval](docs/AiAnswersKnowledgeRemoval.md)
|
|
362
|
+
- [ApiSdkRb::AiAnswersKnowledgeTotals](docs/AiAnswersKnowledgeTotals.md)
|
|
363
|
+
- [ApiSdkRb::ApiKeyScope](docs/ApiKeyScope.md)
|
|
364
|
+
- [ApiSdkRb::Canvas](docs/Canvas.md)
|
|
365
|
+
- [ApiSdkRb::CanvasResponse](docs/CanvasResponse.md)
|
|
366
|
+
- [ApiSdkRb::CheckCompositionAccessResponse](docs/CheckCompositionAccessResponse.md)
|
|
367
|
+
- [ApiSdkRb::CheckCompositionAccessResponseData](docs/CheckCompositionAccessResponseData.md)
|
|
368
|
+
- [ApiSdkRb::Composition](docs/Composition.md)
|
|
369
|
+
- [ApiSdkRb::CompositionDataSource](docs/CompositionDataSource.md)
|
|
370
|
+
- [ApiSdkRb::CompositionDataSourceResponse](docs/CompositionDataSourceResponse.md)
|
|
371
|
+
- [ApiSdkRb::CompositionEntriesDescription](docs/CompositionEntriesDescription.md)
|
|
372
|
+
- [ApiSdkRb::CompositionEntriesDescriptionResponse](docs/CompositionEntriesDescriptionResponse.md)
|
|
373
|
+
- [ApiSdkRb::CompositionEntriesReading](docs/CompositionEntriesReading.md)
|
|
374
|
+
- [ApiSdkRb::CompositionEntriesReadingResponse](docs/CompositionEntriesReadingResponse.md)
|
|
375
|
+
- [ApiSdkRb::CompositionEntryAggregateTally](docs/CompositionEntryAggregateTally.md)
|
|
376
|
+
- [ApiSdkRb::CompositionEntryAggregatesBlock](docs/CompositionEntryAggregatesBlock.md)
|
|
377
|
+
- [ApiSdkRb::CompositionEntryColumn](docs/CompositionEntryColumn.md)
|
|
378
|
+
- [ApiSdkRb::CompositionEntryDeleteSuccess](docs/CompositionEntryDeleteSuccess.md)
|
|
379
|
+
- [ApiSdkRb::CompositionEntryDeleteSuccessData](docs/CompositionEntryDeleteSuccessData.md)
|
|
380
|
+
- [ApiSdkRb::CompositionEntryItem](docs/CompositionEntryItem.md)
|
|
381
|
+
- [ApiSdkRb::CompositionEntryItemsMeta](docs/CompositionEntryItemsMeta.md)
|
|
382
|
+
- [ApiSdkRb::CompositionEntryItemsPageSuccess](docs/CompositionEntryItemsPageSuccess.md)
|
|
383
|
+
- [ApiSdkRb::CompositionEntryTable](docs/CompositionEntryTable.md)
|
|
384
|
+
- [ApiSdkRb::CompositionEntryTally](docs/CompositionEntryTally.md)
|
|
385
|
+
- [ApiSdkRb::CompositionResponse](docs/CompositionResponse.md)
|
|
386
|
+
- [ApiSdkRb::CompositionVersion](docs/CompositionVersion.md)
|
|
387
|
+
- [ApiSdkRb::ContentCheckFinding](docs/ContentCheckFinding.md)
|
|
388
|
+
- [ApiSdkRb::ContentItemWriteResult](docs/ContentItemWriteResult.md)
|
|
389
|
+
- [ApiSdkRb::ContentItemWriteResultValidationResult](docs/ContentItemWriteResultValidationResult.md)
|
|
390
|
+
- [ApiSdkRb::CopyPartnerPresetRequest](docs/CopyPartnerPresetRequest.md)
|
|
391
|
+
- [ApiSdkRb::CreateCanvasRequest](docs/CreateCanvasRequest.md)
|
|
392
|
+
- [ApiSdkRb::CreateCompositionContentItem201Response](docs/CreateCompositionContentItem201Response.md)
|
|
393
|
+
- [ApiSdkRb::CreateCompositionContentItemRequest](docs/CreateCompositionContentItemRequest.md)
|
|
394
|
+
- [ApiSdkRb::CreateCompositionDatabaseRecord201Response](docs/CreateCompositionDatabaseRecord201Response.md)
|
|
395
|
+
- [ApiSdkRb::CreateCompositionFromPresetRequest](docs/CreateCompositionFromPresetRequest.md)
|
|
396
|
+
- [ApiSdkRb::CreateCompositionFromWidget201Response](docs/CreateCompositionFromWidget201Response.md)
|
|
397
|
+
- [ApiSdkRb::CreateCompositionFromWidgetRequest](docs/CreateCompositionFromWidgetRequest.md)
|
|
398
|
+
- [ApiSdkRb::CreateUserApiKeyRequest](docs/CreateUserApiKeyRequest.md)
|
|
399
|
+
- [ApiSdkRb::CreateWidget201Response](docs/CreateWidget201Response.md)
|
|
400
|
+
- [ApiSdkRb::CreateWidget201ResponseData](docs/CreateWidget201ResponseData.md)
|
|
401
|
+
- [ApiSdkRb::CreatedUserApiKey](docs/CreatedUserApiKey.md)
|
|
402
|
+
- [ApiSdkRb::CreatedUserApiKeyResponse](docs/CreatedUserApiKeyResponse.md)
|
|
403
|
+
- [ApiSdkRb::DeleteCompositionContentItemResponse](docs/DeleteCompositionContentItemResponse.md)
|
|
404
|
+
- [ApiSdkRb::DeleteCompositionContentItemResponseData](docs/DeleteCompositionContentItemResponseData.md)
|
|
405
|
+
- [ApiSdkRb::DeleteCompositionDataSourceResponse](docs/DeleteCompositionDataSourceResponse.md)
|
|
406
|
+
- [ApiSdkRb::DeleteCompositionDataSourceResponseData](docs/DeleteCompositionDataSourceResponseData.md)
|
|
407
|
+
- [ApiSdkRb::DeleteManagedUser200Response](docs/DeleteManagedUser200Response.md)
|
|
408
|
+
- [ApiSdkRb::DeletePersonalWorkspaceDomainResponse](docs/DeletePersonalWorkspaceDomainResponse.md)
|
|
409
|
+
- [ApiSdkRb::DeletePersonalWorkspaceDomainResponseData](docs/DeletePersonalWorkspaceDomainResponseData.md)
|
|
410
|
+
- [ApiSdkRb::DeleteUserApiKeyResponse](docs/DeleteUserApiKeyResponse.md)
|
|
411
|
+
- [ApiSdkRb::DeleteUserApiKeyResponseData](docs/DeleteUserApiKeyResponseData.md)
|
|
412
|
+
- [ApiSdkRb::DesignDefaults](docs/DesignDefaults.md)
|
|
413
|
+
- [ApiSdkRb::DuplicateComposition202Response](docs/DuplicateComposition202Response.md)
|
|
414
|
+
- [ApiSdkRb::DuplicateComposition202ResponseData](docs/DuplicateComposition202ResponseData.md)
|
|
415
|
+
- [ApiSdkRb::DuplicateCompositionRequest](docs/DuplicateCompositionRequest.md)
|
|
416
|
+
- [ApiSdkRb::EditorSession](docs/EditorSession.md)
|
|
417
|
+
- [ApiSdkRb::EditorSessionResponse](docs/EditorSessionResponse.md)
|
|
418
|
+
- [ApiSdkRb::Entitlement](docs/Entitlement.md)
|
|
419
|
+
- [ApiSdkRb::ErrorDetail](docs/ErrorDetail.md)
|
|
420
|
+
- [ApiSdkRb::ErrorResponse](docs/ErrorResponse.md)
|
|
421
|
+
- [ApiSdkRb::ExportCompositionEntryItems200Response](docs/ExportCompositionEntryItems200Response.md)
|
|
422
|
+
- [ApiSdkRb::ExportCompositionEntryItems200ResponseMeta](docs/ExportCompositionEntryItems200ResponseMeta.md)
|
|
423
|
+
- [ApiSdkRb::GetAiAnswersKnowledge200Response](docs/GetAiAnswersKnowledge200Response.md)
|
|
424
|
+
- [ApiSdkRb::GetAllCanvasesResponse](docs/GetAllCanvasesResponse.md)
|
|
425
|
+
- [ApiSdkRb::GetAllCanvasesResponseData](docs/GetAllCanvasesResponseData.md)
|
|
426
|
+
- [ApiSdkRb::GetAllCompositions200Response](docs/GetAllCompositions200Response.md)
|
|
427
|
+
- [ApiSdkRb::GetAllManagedUsers200Response](docs/GetAllManagedUsers200Response.md)
|
|
428
|
+
- [ApiSdkRb::GetCompositionContentResponse](docs/GetCompositionContentResponse.md)
|
|
429
|
+
- [ApiSdkRb::GetCompositionContentSchemaResponse](docs/GetCompositionContentSchemaResponse.md)
|
|
430
|
+
- [ApiSdkRb::GetCompositionContentSchemaResponseData](docs/GetCompositionContentSchemaResponseData.md)
|
|
431
|
+
- [ApiSdkRb::GetCompositionDataSourceResponse](docs/GetCompositionDataSourceResponse.md)
|
|
432
|
+
- [ApiSdkRb::GetCompositionDatabaseRecords200Response](docs/GetCompositionDatabaseRecords200Response.md)
|
|
433
|
+
- [ApiSdkRb::GetCompositionDesignResponse](docs/GetCompositionDesignResponse.md)
|
|
434
|
+
- [ApiSdkRb::GetCompositionDesignSchemaResponse](docs/GetCompositionDesignSchemaResponse.md)
|
|
435
|
+
- [ApiSdkRb::GetCompositionDesignSchemaResponseData](docs/GetCompositionDesignSchemaResponseData.md)
|
|
436
|
+
- [ApiSdkRb::GetCompositionEmbedSchemaResponse](docs/GetCompositionEmbedSchemaResponse.md)
|
|
437
|
+
- [ApiSdkRb::GetCompositionEmbedSchemaResponseData](docs/GetCompositionEmbedSchemaResponseData.md)
|
|
438
|
+
- [ApiSdkRb::GetCompositionEmbedSettingsResponse](docs/GetCompositionEmbedSettingsResponse.md)
|
|
439
|
+
- [ApiSdkRb::GetCompositionPreviewResponse](docs/GetCompositionPreviewResponse.md)
|
|
440
|
+
- [ApiSdkRb::GetCompositionPreviewResponseData](docs/GetCompositionPreviewResponseData.md)
|
|
441
|
+
- [ApiSdkRb::GetCompositionVersions200Response](docs/GetCompositionVersions200Response.md)
|
|
442
|
+
- [ApiSdkRb::GetCompositionsBatchRequest](docs/GetCompositionsBatchRequest.md)
|
|
443
|
+
- [ApiSdkRb::GetCompositionsBatchResponse](docs/GetCompositionsBatchResponse.md)
|
|
444
|
+
- [ApiSdkRb::GetCompositionsBatchResponseData](docs/GetCompositionsBatchResponseData.md)
|
|
445
|
+
- [ApiSdkRb::GetInvoicesByPartnerId200Response](docs/GetInvoicesByPartnerId200Response.md)
|
|
446
|
+
- [ApiSdkRb::GetManagedUserEntitlementsResponse](docs/GetManagedUserEntitlementsResponse.md)
|
|
447
|
+
- [ApiSdkRb::GetManagedUserEntitlementsResponseData](docs/GetManagedUserEntitlementsResponseData.md)
|
|
448
|
+
- [ApiSdkRb::GetManagedUserLimits200Response](docs/GetManagedUserLimits200Response.md)
|
|
449
|
+
- [ApiSdkRb::GetManagedUserStorageUsage200Response](docs/GetManagedUserStorageUsage200Response.md)
|
|
450
|
+
- [ApiSdkRb::GetManagedUserStorageUsage200ResponseData](docs/GetManagedUserStorageUsage200ResponseData.md)
|
|
451
|
+
- [ApiSdkRb::GetManagedUserStorageUsage200ResponseDataByPurpose](docs/GetManagedUserStorageUsage200ResponseDataByPurpose.md)
|
|
452
|
+
- [ApiSdkRb::GetManagedUsersByManagerIdResponse](docs/GetManagedUsersByManagerIdResponse.md)
|
|
453
|
+
- [ApiSdkRb::GetManagedUsersByManagerIdResponseData](docs/GetManagedUsersByManagerIdResponseData.md)
|
|
454
|
+
- [ApiSdkRb::GetPartnerBillingOverview200Response](docs/GetPartnerBillingOverview200Response.md)
|
|
455
|
+
- [ApiSdkRb::GetPartnerCreditTransactions200Response](docs/GetPartnerCreditTransactions200Response.md)
|
|
456
|
+
- [ApiSdkRb::GetPartnerDesignDefaults200Response](docs/GetPartnerDesignDefaults200Response.md)
|
|
457
|
+
- [ApiSdkRb::GetPartnerEntitlementsResponse](docs/GetPartnerEntitlementsResponse.md)
|
|
458
|
+
- [ApiSdkRb::GetPartnerEntitlementsResponseData](docs/GetPartnerEntitlementsResponseData.md)
|
|
459
|
+
- [ApiSdkRb::GetPersonalWorkspaceDomains200Response](docs/GetPersonalWorkspaceDomains200Response.md)
|
|
460
|
+
- [ApiSdkRb::GetPublicCompositionEmbed200Response](docs/GetPublicCompositionEmbed200Response.md)
|
|
461
|
+
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseDataSource](docs/GetPublicCompositionEmbed200ResponseDataSource.md)
|
|
462
|
+
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseDirect](docs/GetPublicCompositionEmbed200ResponseDirect.md)
|
|
463
|
+
- [ApiSdkRb::GetUserAdapterConnections200Response](docs/GetUserAdapterConnections200Response.md)
|
|
464
|
+
- [ApiSdkRb::GetUserApiKeyUsageLogsResponse](docs/GetUserApiKeyUsageLogsResponse.md)
|
|
465
|
+
- [ApiSdkRb::GetUserApiKeyUsageLogsResponseData](docs/GetUserApiKeyUsageLogsResponseData.md)
|
|
466
|
+
- [ApiSdkRb::GetUserApiKeys200Response](docs/GetUserApiKeys200Response.md)
|
|
467
|
+
- [ApiSdkRb::GetWidgets200Response](docs/GetWidgets200Response.md)
|
|
468
|
+
- [ApiSdkRb::GetWidgetsBatchRequest](docs/GetWidgetsBatchRequest.md)
|
|
469
|
+
- [ApiSdkRb::GetWidgetsBatchResponse](docs/GetWidgetsBatchResponse.md)
|
|
470
|
+
- [ApiSdkRb::GetWidgetsBatchResponseData](docs/GetWidgetsBatchResponseData.md)
|
|
471
|
+
- [ApiSdkRb::GetWidgetsBatchResponseDataErrorsInner](docs/GetWidgetsBatchResponseDataErrorsInner.md)
|
|
472
|
+
- [ApiSdkRb::ListPartnerPresets200Response](docs/ListPartnerPresets200Response.md)
|
|
473
|
+
- [ApiSdkRb::ManagedUser](docs/ManagedUser.md)
|
|
474
|
+
- [ApiSdkRb::ManagedUserEntriesMeta](docs/ManagedUserEntriesMeta.md)
|
|
475
|
+
- [ApiSdkRb::ManagedUserEntriesPageSuccess](docs/ManagedUserEntriesPageSuccess.md)
|
|
476
|
+
- [ApiSdkRb::ManagedUserEntryItem](docs/ManagedUserEntryItem.md)
|
|
477
|
+
- [ApiSdkRb::ManagedUserLimits](docs/ManagedUserLimits.md)
|
|
478
|
+
- [ApiSdkRb::ManagedUserOperationUsage](docs/ManagedUserOperationUsage.md)
|
|
479
|
+
- [ApiSdkRb::ManagedUserRemoval](docs/ManagedUserRemoval.md)
|
|
480
|
+
- [ApiSdkRb::ManagedUserResponse](docs/ManagedUserResponse.md)
|
|
481
|
+
- [ApiSdkRb::ManagedUserUsage](docs/ManagedUserUsage.md)
|
|
482
|
+
- [ApiSdkRb::ManagedUserUsageResponse](docs/ManagedUserUsageResponse.md)
|
|
483
|
+
- [ApiSdkRb::ManagedUserUsageTotals](docs/ManagedUserUsageTotals.md)
|
|
484
|
+
- [ApiSdkRb::MyPartner](docs/MyPartner.md)
|
|
485
|
+
- [ApiSdkRb::MyPartners](docs/MyPartners.md)
|
|
486
|
+
- [ApiSdkRb::MyPartnersResponse](docs/MyPartnersResponse.md)
|
|
487
|
+
- [ApiSdkRb::NewComposition](docs/NewComposition.md)
|
|
488
|
+
- [ApiSdkRb::NewEditorSession](docs/NewEditorSession.md)
|
|
489
|
+
- [ApiSdkRb::NewManagedUser](docs/NewManagedUser.md)
|
|
490
|
+
- [ApiSdkRb::NewWidget](docs/NewWidget.md)
|
|
491
|
+
- [ApiSdkRb::OperationsIdGetResponse](docs/OperationsIdGetResponse.md)
|
|
492
|
+
- [ApiSdkRb::OperationsIdGetResponseData](docs/OperationsIdGetResponseData.md)
|
|
493
|
+
- [ApiSdkRb::PartnerAnalyticsByManagedUser](docs/PartnerAnalyticsByManagedUser.md)
|
|
494
|
+
- [ApiSdkRb::PartnerAnalyticsByManagedUserResponse](docs/PartnerAnalyticsByManagedUserResponse.md)
|
|
495
|
+
- [ApiSdkRb::PartnerAnalyticsOfDay](docs/PartnerAnalyticsOfDay.md)
|
|
496
|
+
- [ApiSdkRb::PartnerAnalyticsOfManagedUser](docs/PartnerAnalyticsOfManagedUser.md)
|
|
497
|
+
- [ApiSdkRb::PartnerAnalyticsOfWidget](docs/PartnerAnalyticsOfWidget.md)
|
|
498
|
+
- [ApiSdkRb::PartnerAnalyticsSummary](docs/PartnerAnalyticsSummary.md)
|
|
499
|
+
- [ApiSdkRb::PartnerAnalyticsSummaryResponse](docs/PartnerAnalyticsSummaryResponse.md)
|
|
500
|
+
- [ApiSdkRb::PartnerAnalyticsTimeline](docs/PartnerAnalyticsTimeline.md)
|
|
501
|
+
- [ApiSdkRb::PartnerAnalyticsTimelineResponse](docs/PartnerAnalyticsTimelineResponse.md)
|
|
502
|
+
- [ApiSdkRb::PartnerAnalyticsTopWidgets](docs/PartnerAnalyticsTopWidgets.md)
|
|
503
|
+
- [ApiSdkRb::PartnerAnalyticsTopWidgetsResponse](docs/PartnerAnalyticsTopWidgetsResponse.md)
|
|
504
|
+
- [ApiSdkRb::PartnerBillingOverview](docs/PartnerBillingOverview.md)
|
|
505
|
+
- [ApiSdkRb::PartnerBillingOverviewBillingIntegration](docs/PartnerBillingOverviewBillingIntegration.md)
|
|
506
|
+
- [ApiSdkRb::PartnerBillingOverviewOperationalCredits](docs/PartnerBillingOverviewOperationalCredits.md)
|
|
507
|
+
- [ApiSdkRb::PartnerBillingOverviewPartner](docs/PartnerBillingOverviewPartner.md)
|
|
508
|
+
- [ApiSdkRb::PartnerContract](docs/PartnerContract.md)
|
|
509
|
+
- [ApiSdkRb::PartnerContractResponse](docs/PartnerContractResponse.md)
|
|
510
|
+
- [ApiSdkRb::PartnerCustomization](docs/PartnerCustomization.md)
|
|
511
|
+
- [ApiSdkRb::PartnerDataDatabase](docs/PartnerDataDatabase.md)
|
|
512
|
+
- [ApiSdkRb::PartnerDataDatabaseRemoval](docs/PartnerDataDatabaseRemoval.md)
|
|
513
|
+
- [ApiSdkRb::PartnerDataDatabaseRemovalResponse](docs/PartnerDataDatabaseRemovalResponse.md)
|
|
514
|
+
- [ApiSdkRb::PartnerDataDatabaseResponse](docs/PartnerDataDatabaseResponse.md)
|
|
515
|
+
- [ApiSdkRb::PartnerEntryContextSecret](docs/PartnerEntryContextSecret.md)
|
|
516
|
+
- [ApiSdkRb::PartnerEntryContextSecretResponse](docs/PartnerEntryContextSecretResponse.md)
|
|
517
|
+
- [ApiSdkRb::PartnerEntryContextSigning](docs/PartnerEntryContextSigning.md)
|
|
518
|
+
- [ApiSdkRb::PartnerEntryContextSigningResponse](docs/PartnerEntryContextSigningResponse.md)
|
|
519
|
+
- [ApiSdkRb::PartnerExtraCreditsInvoice](docs/PartnerExtraCreditsInvoice.md)
|
|
520
|
+
- [ApiSdkRb::PartnerExtraCreditsInvoiceResponse](docs/PartnerExtraCreditsInvoiceResponse.md)
|
|
521
|
+
- [ApiSdkRb::PartnerInvoice](docs/PartnerInvoice.md)
|
|
522
|
+
- [ApiSdkRb::PartnerNotification](docs/PartnerNotification.md)
|
|
523
|
+
- [ApiSdkRb::PartnerNotificationDefaultRecipients](docs/PartnerNotificationDefaultRecipients.md)
|
|
524
|
+
- [ApiSdkRb::PartnerNotificationDelivery](docs/PartnerNotificationDelivery.md)
|
|
525
|
+
- [ApiSdkRb::PartnerNotificationDeliveryLog](docs/PartnerNotificationDeliveryLog.md)
|
|
526
|
+
- [ApiSdkRb::PartnerNotificationDeliveryLogResponse](docs/PartnerNotificationDeliveryLogResponse.md)
|
|
527
|
+
- [ApiSdkRb::PartnerNotificationDeliveryResponse](docs/PartnerNotificationDeliveryResponse.md)
|
|
528
|
+
- [ApiSdkRb::PartnerNotificationEvent](docs/PartnerNotificationEvent.md)
|
|
529
|
+
- [ApiSdkRb::PartnerNotificationEventType](docs/PartnerNotificationEventType.md)
|
|
530
|
+
- [ApiSdkRb::PartnerNotificationPage](docs/PartnerNotificationPage.md)
|
|
531
|
+
- [ApiSdkRb::PartnerNotificationPageResponse](docs/PartnerNotificationPageResponse.md)
|
|
532
|
+
- [ApiSdkRb::PartnerNotificationSettings](docs/PartnerNotificationSettings.md)
|
|
533
|
+
- [ApiSdkRb::PartnerNotificationSettingsChange](docs/PartnerNotificationSettingsChange.md)
|
|
534
|
+
- [ApiSdkRb::PartnerNotificationSettingsChangeResponse](docs/PartnerNotificationSettingsChangeResponse.md)
|
|
535
|
+
- [ApiSdkRb::PartnerNotificationSettingsResponse](docs/PartnerNotificationSettingsResponse.md)
|
|
536
|
+
- [ApiSdkRb::PartnerNotificationTestEventRequest](docs/PartnerNotificationTestEventRequest.md)
|
|
537
|
+
- [ApiSdkRb::PartnerNotificationTestEventResult](docs/PartnerNotificationTestEventResult.md)
|
|
538
|
+
- [ApiSdkRb::PartnerNotificationTestEventResultResponse](docs/PartnerNotificationTestEventResultResponse.md)
|
|
539
|
+
- [ApiSdkRb::PartnerPreset](docs/PartnerPreset.md)
|
|
540
|
+
- [ApiSdkRb::PartnerPresetCopy](docs/PartnerPresetCopy.md)
|
|
541
|
+
- [ApiSdkRb::PartnerPresetCopyResponse](docs/PartnerPresetCopyResponse.md)
|
|
542
|
+
- [ApiSdkRb::PartnerPresetRemoval](docs/PartnerPresetRemoval.md)
|
|
543
|
+
- [ApiSdkRb::PartnerPresetRemovalResponse](docs/PartnerPresetRemovalResponse.md)
|
|
544
|
+
- [ApiSdkRb::PartnerPresetResponse](docs/PartnerPresetResponse.md)
|
|
545
|
+
- [ApiSdkRb::PartnerReportPage](docs/PartnerReportPage.md)
|
|
546
|
+
- [ApiSdkRb::PartnerReportPeriod](docs/PartnerReportPeriod.md)
|
|
547
|
+
- [ApiSdkRb::PartnerStorageDestination](docs/PartnerStorageDestination.md)
|
|
548
|
+
- [ApiSdkRb::PartnerStorageDestinationResponse](docs/PartnerStorageDestinationResponse.md)
|
|
549
|
+
- [ApiSdkRb::PartnerStorageRemoval](docs/PartnerStorageRemoval.md)
|
|
550
|
+
- [ApiSdkRb::PartnerStorageRemovalResponse](docs/PartnerStorageRemovalResponse.md)
|
|
551
|
+
- [ApiSdkRb::PartnerStorageUsage](docs/PartnerStorageUsage.md)
|
|
552
|
+
- [ApiSdkRb::PartnerStorageUsageOfManagedUser](docs/PartnerStorageUsageOfManagedUser.md)
|
|
553
|
+
- [ApiSdkRb::PartnerStorageUsageResponse](docs/PartnerStorageUsageResponse.md)
|
|
554
|
+
- [ApiSdkRb::PartnerStorageUsageTotals](docs/PartnerStorageUsageTotals.md)
|
|
555
|
+
- [ApiSdkRb::PersonalWorkspaceDomain](docs/PersonalWorkspaceDomain.md)
|
|
556
|
+
- [ApiSdkRb::PersonalWorkspaceDomainResult](docs/PersonalWorkspaceDomainResult.md)
|
|
557
|
+
- [ApiSdkRb::PersonalWorkspaceDomainResultResponse](docs/PersonalWorkspaceDomainResultResponse.md)
|
|
558
|
+
- [ApiSdkRb::PostPublicCompositionEmbedStatus200Response](docs/PostPublicCompositionEmbedStatus200Response.md)
|
|
559
|
+
- [ApiSdkRb::PostPublicCompositionEmbedStatus200ResponseData](docs/PostPublicCompositionEmbedStatus200ResponseData.md)
|
|
560
|
+
- [ApiSdkRb::PostPublicCompositionEmbedStatusRequest](docs/PostPublicCompositionEmbedStatusRequest.md)
|
|
561
|
+
- [ApiSdkRb::PublicAdapterCallError](docs/PublicAdapterCallError.md)
|
|
562
|
+
- [ApiSdkRb::PublicAdapterCallRequest](docs/PublicAdapterCallRequest.md)
|
|
563
|
+
- [ApiSdkRb::PublicAdapterCallResult](docs/PublicAdapterCallResult.md)
|
|
564
|
+
- [ApiSdkRb::PublicAdapterCallResultData](docs/PublicAdapterCallResultData.md)
|
|
565
|
+
- [ApiSdkRb::PublicAdapterFileResult](docs/PublicAdapterFileResult.md)
|
|
566
|
+
- [ApiSdkRb::PublicAdapterFileResultData](docs/PublicAdapterFileResultData.md)
|
|
567
|
+
- [ApiSdkRb::PublicAdapterFileResultDataFile](docs/PublicAdapterFileResultDataFile.md)
|
|
568
|
+
- [ApiSdkRb::PublicCompositionEntryCreated](docs/PublicCompositionEntryCreated.md)
|
|
569
|
+
- [ApiSdkRb::PublicCompositionEntryCreatedData](docs/PublicCompositionEntryCreatedData.md)
|
|
570
|
+
- [ApiSdkRb::PublicCompositionEntryRequest](docs/PublicCompositionEntryRequest.md)
|
|
571
|
+
- [ApiSdkRb::PublicEmbedFailure](docs/PublicEmbedFailure.md)
|
|
572
|
+
- [ApiSdkRb::PublicEmbedFailureDetails](docs/PublicEmbedFailureDetails.md)
|
|
573
|
+
- [ApiSdkRb::PublicEmbedFailureError](docs/PublicEmbedFailureError.md)
|
|
574
|
+
- [ApiSdkRb::PurposeStorageBucket](docs/PurposeStorageBucket.md)
|
|
575
|
+
- [ApiSdkRb::RemoveAiAnswersKnowledgeDocument200Response](docs/RemoveAiAnswersKnowledgeDocument200Response.md)
|
|
576
|
+
- [ApiSdkRb::RemoveUserAdapterConnection200Response](docs/RemoveUserAdapterConnection200Response.md)
|
|
577
|
+
- [ApiSdkRb::RequestExtraCredits](docs/RequestExtraCredits.md)
|
|
578
|
+
- [ApiSdkRb::ResponseMeta](docs/ResponseMeta.md)
|
|
579
|
+
- [ApiSdkRb::RevokeManagedUserEditorSessionsResponse](docs/RevokeManagedUserEditorSessionsResponse.md)
|
|
580
|
+
- [ApiSdkRb::RevokeManagedUserEditorSessionsResponseData](docs/RevokeManagedUserEditorSessionsResponseData.md)
|
|
581
|
+
- [ApiSdkRb::SetAdapterConnectionRequest](docs/SetAdapterConnectionRequest.md)
|
|
582
|
+
- [ApiSdkRb::SetCompositionDataSourceRequest](docs/SetCompositionDataSourceRequest.md)
|
|
583
|
+
- [ApiSdkRb::SetDynamicContentRequest](docs/SetDynamicContentRequest.md)
|
|
584
|
+
- [ApiSdkRb::SetDynamicContentResponse](docs/SetDynamicContentResponse.md)
|
|
585
|
+
- [ApiSdkRb::SetDynamicContentResponseData](docs/SetDynamicContentResponseData.md)
|
|
586
|
+
- [ApiSdkRb::SetDynamicContentResponseDataValidationResult](docs/SetDynamicContentResponseDataValidationResult.md)
|
|
587
|
+
- [ApiSdkRb::SetManagedUserLimitsRequest](docs/SetManagedUserLimitsRequest.md)
|
|
588
|
+
- [ApiSdkRb::SetPartnerDataDatabaseRequest](docs/SetPartnerDataDatabaseRequest.md)
|
|
589
|
+
- [ApiSdkRb::SetPartnerDesignDefaultsRequest](docs/SetPartnerDesignDefaultsRequest.md)
|
|
590
|
+
- [ApiSdkRb::SetPartnerPresetRequest](docs/SetPartnerPresetRequest.md)
|
|
591
|
+
- [ApiSdkRb::SetPartnerStorageDestinationRequest](docs/SetPartnerStorageDestinationRequest.md)
|
|
592
|
+
- [ApiSdkRb::SetUserAdapterConnection200Response](docs/SetUserAdapterConnection200Response.md)
|
|
593
|
+
- [ApiSdkRb::SuccessResponse](docs/SuccessResponse.md)
|
|
594
|
+
- [ApiSdkRb::UpdateCanvasRequest](docs/UpdateCanvasRequest.md)
|
|
595
|
+
- [ApiSdkRb::UpdateComposition](docs/UpdateComposition.md)
|
|
596
|
+
- [ApiSdkRb::UpdateCompositionStatusRequest](docs/UpdateCompositionStatusRequest.md)
|
|
597
|
+
- [ApiSdkRb::UpdateDomainRequest](docs/UpdateDomainRequest.md)
|
|
598
|
+
- [ApiSdkRb::UpdateManagedUser](docs/UpdateManagedUser.md)
|
|
599
|
+
- [ApiSdkRb::UpdatePartnerEntryContextSigningRequest](docs/UpdatePartnerEntryContextSigningRequest.md)
|
|
600
|
+
- [ApiSdkRb::UpdatePartnerNotificationSettingsRequest](docs/UpdatePartnerNotificationSettingsRequest.md)
|
|
601
|
+
- [ApiSdkRb::UpdateUserApiKeyRequest](docs/UpdateUserApiKeyRequest.md)
|
|
602
|
+
- [ApiSdkRb::Upload](docs/Upload.md)
|
|
603
|
+
- [ApiSdkRb::UploadLimits](docs/UploadLimits.md)
|
|
604
|
+
- [ApiSdkRb::UploadLimitsResponse](docs/UploadLimitsResponse.md)
|
|
605
|
+
- [ApiSdkRb::UploadResponse](docs/UploadResponse.md)
|
|
606
|
+
- [ApiSdkRb::UploadsGet200Response](docs/UploadsGet200Response.md)
|
|
607
|
+
- [ApiSdkRb::UploadsIdDelete200Response](docs/UploadsIdDelete200Response.md)
|
|
608
|
+
- [ApiSdkRb::UploadsIdDelete200ResponseData](docs/UploadsIdDelete200ResponseData.md)
|
|
609
|
+
- [ApiSdkRb::UserApiKey](docs/UserApiKey.md)
|
|
610
|
+
- [ApiSdkRb::UserApiKeyResponse](docs/UserApiKeyResponse.md)
|
|
611
|
+
- [ApiSdkRb::UserApiKeyUsageLog](docs/UserApiKeyUsageLog.md)
|
|
612
|
+
- [ApiSdkRb::ValidateCompositionContentResponse](docs/ValidateCompositionContentResponse.md)
|
|
613
|
+
- [ApiSdkRb::ValidateCompositionContentResponseData](docs/ValidateCompositionContentResponseData.md)
|
|
614
|
+
- [ApiSdkRb::ValidateToken200Response](docs/ValidateToken200Response.md)
|
|
615
|
+
- [ApiSdkRb::ValidateToken200ResponseData](docs/ValidateToken200ResponseData.md)
|
|
616
|
+
- [ApiSdkRb::Widget](docs/Widget.md)
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
## Documentation for Authorization
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
Authentication schemes defined for the API:
|
|
623
|
+
### apiKeyAuth
|
|
624
|
+
|
|
625
|
+
- **Type**: Bearer authentication (JWT)
|
|
626
|
+
|
|
627
|
+
### bearerAuth
|
|
628
|
+
|
|
629
|
+
- **Type**: Bearer authentication (JWT)
|
|
630
|
+
|
|
631
|
+
### BearerAuth
|
|
632
|
+
|
|
633
|
+
- **Type**: Bearer authentication (JWT)
|
|
634
|
+
|
|
635
|
+
### ApiKeyAuth
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
- **Type**: API key
|
|
639
|
+
- **API key parameter name**: Authorization
|
|
640
|
+
- **Location**: HTTP header
|
|
641
|
+
|
|
642
|
+
### webhookSignature
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
- **Type**: API key
|
|
646
|
+
- **API key parameter name**: X-Webhook-Signature
|
|
647
|
+
- **Location**: HTTP header
|
|
648
|
+
|