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
|
@@ -0,0 +1,1239 @@
|
|
|
1
|
+
# ApiSdkRb::ManagedUsersApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.widgetic.com/v1*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**copy_preset_for_managed_user_0**](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 |
|
|
8
|
+
| [**create_composition_from_preset_0**](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 |
|
|
9
|
+
| [**create_managed_user_0**](ManagedUsersApi.md#create_managed_user_0) | **POST** /managed-users | Create Managed User |
|
|
10
|
+
| [**create_managed_user_editor_session_0**](ManagedUsersApi.md#create_managed_user_editor_session_0) | **POST** /managed-users/{id}/editor-sessions | Create an editor session for a managed user |
|
|
11
|
+
| [**delete_managed_user_0**](ManagedUsersApi.md#delete_managed_user_0) | **DELETE** /managed-users/{id} | Delete Managed User |
|
|
12
|
+
| [**get_all_managed_users_0**](ManagedUsersApi.md#get_all_managed_users_0) | **GET** /managed-users | Get Managed Users |
|
|
13
|
+
| [**get_managed_user_by_id_0**](ManagedUsersApi.md#get_managed_user_by_id_0) | **GET** /managed-users/{id} | Get Managed User By ID |
|
|
14
|
+
| [**get_managed_user_design_defaults_0**](ManagedUsersApi.md#get_managed_user_design_defaults_0) | **GET** /managed-users/{id}/design-defaults | Read design defaults for one managed user |
|
|
15
|
+
| [**get_managed_user_limits_0**](ManagedUsersApi.md#get_managed_user_limits_0) | **GET** /managed-users/{id}/limits | Read monthly credit cap and usage for one managed user |
|
|
16
|
+
| [**get_managed_user_storage_usage_0**](ManagedUsersApi.md#get_managed_user_storage_usage_0) | **GET** /managed-users/{id}/storage-usage | Storage used by one managed user's uploads |
|
|
17
|
+
| [**get_managed_user_usage_0**](ManagedUsersApi.md#get_managed_user_usage_0) | **GET** /managed-users/{id}/usage | What a managed user's editor sessions spent |
|
|
18
|
+
| [**get_managed_users_by_manager_id_0**](ManagedUsersApi.md#get_managed_users_by_manager_id_0) | **GET** /users/{managerId}/managed-users | Get Managed Users By Manager |
|
|
19
|
+
| [**revoke_managed_user_editor_session_0**](ManagedUsersApi.md#revoke_managed_user_editor_session_0) | **DELETE** /managed-users/{id}/editor-sessions/{sessionId} | End one editor session of a managed user |
|
|
20
|
+
| [**revoke_managed_user_editor_sessions_0**](ManagedUsersApi.md#revoke_managed_user_editor_sessions_0) | **DELETE** /managed-users/{id}/editor-sessions | End every editor session of a managed user |
|
|
21
|
+
| [**set_managed_user_design_defaults_0**](ManagedUsersApi.md#set_managed_user_design_defaults_0) | **PUT** /managed-users/{id}/design-defaults | Set or clear design defaults for one managed user |
|
|
22
|
+
| [**set_managed_user_limits_0**](ManagedUsersApi.md#set_managed_user_limits_0) | **PUT** /managed-users/{id}/limits | Set or clear the monthly credit cap for one managed user |
|
|
23
|
+
| [**update_managed_user_0**](ManagedUsersApi.md#update_managed_user_0) | **PUT** /managed-users/{id} | Update Managed User |
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
## copy_preset_for_managed_user_0
|
|
27
|
+
|
|
28
|
+
> <PartnerPresetCopyResponse> copy_preset_for_managed_user_0(id, key, idempotency_key, opts)
|
|
29
|
+
|
|
30
|
+
Give a managed user a copy of one of your presets
|
|
31
|
+
|
|
32
|
+
Copies the preset `key` (see `setPartnerPreset`) onto a new canvas for one of your managed users, so their widget creator opens on a widget of their own that starts from yours. The copy is a draft widget in your account, filed under the managed user: `getAllWidgets` with `managedUserId` lists it, and no other managed user's editor can reach it. The copy carries the preset's code, design and content schemas, and thumbnail, and starts from a fork of its code repository, so the user's chat edits begin where yours left off. It does not carry the preset's database or its compositions. It is not a preset itself, and changing or removing the preset afterwards never touches it. To start a composition (the content and design editor) instead, you do not need a copy: call `createComposition` with the preset's `widgetId` (from `listPartnerPresets`) and the managed user. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one copy is made, not two. A copy that could not be made leaves nothing behind (503 `PRESET_COPY_FAILED`). The managed user must be yours and active.
|
|
33
|
+
|
|
34
|
+
### Examples
|
|
35
|
+
|
|
36
|
+
```ruby
|
|
37
|
+
require 'time'
|
|
38
|
+
require 'api-sdk-rb'
|
|
39
|
+
# setup authorization
|
|
40
|
+
ApiSdkRb.configure do |config|
|
|
41
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
42
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
46
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The managed user to give the copy to (Widgetic's id for the user)
|
|
47
|
+
key = 'key_example' # String | The key of the preset to copy
|
|
48
|
+
idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
|
|
49
|
+
opts = {
|
|
50
|
+
copy_partner_preset_request: ApiSdkRb::CopyPartnerPresetRequest.new # CopyPartnerPresetRequest |
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
begin
|
|
54
|
+
# Give a managed user a copy of one of your presets
|
|
55
|
+
result = api_instance.copy_preset_for_managed_user_0(id, key, idempotency_key, opts)
|
|
56
|
+
p result
|
|
57
|
+
rescue ApiSdkRb::ApiError => e
|
|
58
|
+
puts "Error when calling ManagedUsersApi->copy_preset_for_managed_user_0: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
#### Using the copy_preset_for_managed_user_0_with_http_info variant
|
|
63
|
+
|
|
64
|
+
This returns an Array which contains the response data, status code and headers.
|
|
65
|
+
|
|
66
|
+
> <Array(<PartnerPresetCopyResponse>, Integer, Hash)> copy_preset_for_managed_user_0_with_http_info(id, key, idempotency_key, opts)
|
|
67
|
+
|
|
68
|
+
```ruby
|
|
69
|
+
begin
|
|
70
|
+
# Give a managed user a copy of one of your presets
|
|
71
|
+
data, status_code, headers = api_instance.copy_preset_for_managed_user_0_with_http_info(id, key, idempotency_key, opts)
|
|
72
|
+
p status_code # => 2xx
|
|
73
|
+
p headers # => { ... }
|
|
74
|
+
p data # => <PartnerPresetCopyResponse>
|
|
75
|
+
rescue ApiSdkRb::ApiError => e
|
|
76
|
+
puts "Error when calling ManagedUsersApi->copy_preset_for_managed_user_0_with_http_info: #{e}"
|
|
77
|
+
end
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### Parameters
|
|
81
|
+
|
|
82
|
+
| Name | Type | Description | Notes |
|
|
83
|
+
| ---- | ---- | ----------- | ----- |
|
|
84
|
+
| **id** | **String** | The managed user to give the copy to (Widgetic's id for the user) | |
|
|
85
|
+
| **key** | **String** | The key of the preset to copy | |
|
|
86
|
+
| **idempotency_key** | **String** | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`). | |
|
|
87
|
+
| **copy_partner_preset_request** | [**CopyPartnerPresetRequest**](CopyPartnerPresetRequest.md) | | [optional] |
|
|
88
|
+
|
|
89
|
+
### Return type
|
|
90
|
+
|
|
91
|
+
[**PartnerPresetCopyResponse**](PartnerPresetCopyResponse.md)
|
|
92
|
+
|
|
93
|
+
### Authorization
|
|
94
|
+
|
|
95
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
96
|
+
|
|
97
|
+
### HTTP request headers
|
|
98
|
+
|
|
99
|
+
- **Content-Type**: application/json
|
|
100
|
+
- **Accept**: application/json
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
## create_composition_from_preset_0
|
|
104
|
+
|
|
105
|
+
> <CreateCompositionFromWidget201Response> create_composition_from_preset_0(id, key, idempotency_key, create_composition_from_preset_request)
|
|
106
|
+
|
|
107
|
+
Create a composition from one of your presets in one call
|
|
108
|
+
|
|
109
|
+
Validates the name, optional content, design, embed settings and locale, then creates a draft composition filed under the managed user, built on the preset's widget, in a single insert. A failure never leaves a half-made composition. The preset's widget must be published. The managed user must be yours and active. A widget that keeps what visitors send (a form, a vote, a rating) declares its tables in its own source (`src/lib/meta/database.json`); they are made for the composition here, in a schema of its own, as the widget was when it was last published. A widget that keeps nothing leaves the composition without tables. If the tables cannot be made just now, or the widget's file cannot be used, the composition is still created (`201`) and `meta.warnings` says why; the tables are made the next time the widget is generated. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one composition is created, not two.
|
|
110
|
+
|
|
111
|
+
### Examples
|
|
112
|
+
|
|
113
|
+
```ruby
|
|
114
|
+
require 'time'
|
|
115
|
+
require 'api-sdk-rb'
|
|
116
|
+
# setup authorization
|
|
117
|
+
ApiSdkRb.configure do |config|
|
|
118
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
119
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
120
|
+
end
|
|
121
|
+
|
|
122
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
123
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
124
|
+
key = 'key_example' # String |
|
|
125
|
+
idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
|
|
126
|
+
create_composition_from_preset_request = ApiSdkRb::CreateCompositionFromPresetRequest.new({name: 'name_example'}) # CreateCompositionFromPresetRequest |
|
|
127
|
+
|
|
128
|
+
begin
|
|
129
|
+
# Create a composition from one of your presets in one call
|
|
130
|
+
result = api_instance.create_composition_from_preset_0(id, key, idempotency_key, create_composition_from_preset_request)
|
|
131
|
+
p result
|
|
132
|
+
rescue ApiSdkRb::ApiError => e
|
|
133
|
+
puts "Error when calling ManagedUsersApi->create_composition_from_preset_0: #{e}"
|
|
134
|
+
end
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
#### Using the create_composition_from_preset_0_with_http_info variant
|
|
138
|
+
|
|
139
|
+
This returns an Array which contains the response data, status code and headers.
|
|
140
|
+
|
|
141
|
+
> <Array(<CreateCompositionFromWidget201Response>, Integer, Hash)> create_composition_from_preset_0_with_http_info(id, key, idempotency_key, create_composition_from_preset_request)
|
|
142
|
+
|
|
143
|
+
```ruby
|
|
144
|
+
begin
|
|
145
|
+
# Create a composition from one of your presets in one call
|
|
146
|
+
data, status_code, headers = api_instance.create_composition_from_preset_0_with_http_info(id, key, idempotency_key, create_composition_from_preset_request)
|
|
147
|
+
p status_code # => 2xx
|
|
148
|
+
p headers # => { ... }
|
|
149
|
+
p data # => <CreateCompositionFromWidget201Response>
|
|
150
|
+
rescue ApiSdkRb::ApiError => e
|
|
151
|
+
puts "Error when calling ManagedUsersApi->create_composition_from_preset_0_with_http_info: #{e}"
|
|
152
|
+
end
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### Parameters
|
|
156
|
+
|
|
157
|
+
| Name | Type | Description | Notes |
|
|
158
|
+
| ---- | ---- | ----------- | ----- |
|
|
159
|
+
| **id** | **String** | | |
|
|
160
|
+
| **key** | **String** | | |
|
|
161
|
+
| **idempotency_key** | **String** | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`). | |
|
|
162
|
+
| **create_composition_from_preset_request** | [**CreateCompositionFromPresetRequest**](CreateCompositionFromPresetRequest.md) | | |
|
|
163
|
+
|
|
164
|
+
### Return type
|
|
165
|
+
|
|
166
|
+
[**CreateCompositionFromWidget201Response**](CreateCompositionFromWidget201Response.md)
|
|
167
|
+
|
|
168
|
+
### Authorization
|
|
169
|
+
|
|
170
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
171
|
+
|
|
172
|
+
### HTTP request headers
|
|
173
|
+
|
|
174
|
+
- **Content-Type**: application/json
|
|
175
|
+
- **Accept**: application/json
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
## create_managed_user_0
|
|
179
|
+
|
|
180
|
+
> <ManagedUserResponse> create_managed_user_0(idempotency_key, new_managed_user)
|
|
181
|
+
|
|
182
|
+
Create Managed User
|
|
183
|
+
|
|
184
|
+
Creates a new managed user for a partner account. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry, so one managed user is created, not two.
|
|
185
|
+
|
|
186
|
+
### Examples
|
|
187
|
+
|
|
188
|
+
```ruby
|
|
189
|
+
require 'time'
|
|
190
|
+
require 'api-sdk-rb'
|
|
191
|
+
# setup authorization
|
|
192
|
+
ApiSdkRb.configure do |config|
|
|
193
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
194
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
195
|
+
end
|
|
196
|
+
|
|
197
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
198
|
+
idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
|
|
199
|
+
new_managed_user = ApiSdkRb::NewManagedUser.new({external_id: 'external-user-123'}) # NewManagedUser |
|
|
200
|
+
|
|
201
|
+
begin
|
|
202
|
+
# Create Managed User
|
|
203
|
+
result = api_instance.create_managed_user_0(idempotency_key, new_managed_user)
|
|
204
|
+
p result
|
|
205
|
+
rescue ApiSdkRb::ApiError => e
|
|
206
|
+
puts "Error when calling ManagedUsersApi->create_managed_user_0: #{e}"
|
|
207
|
+
end
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
#### Using the create_managed_user_0_with_http_info variant
|
|
211
|
+
|
|
212
|
+
This returns an Array which contains the response data, status code and headers.
|
|
213
|
+
|
|
214
|
+
> <Array(<ManagedUserResponse>, Integer, Hash)> create_managed_user_0_with_http_info(idempotency_key, new_managed_user)
|
|
215
|
+
|
|
216
|
+
```ruby
|
|
217
|
+
begin
|
|
218
|
+
# Create Managed User
|
|
219
|
+
data, status_code, headers = api_instance.create_managed_user_0_with_http_info(idempotency_key, new_managed_user)
|
|
220
|
+
p status_code # => 2xx
|
|
221
|
+
p headers # => { ... }
|
|
222
|
+
p data # => <ManagedUserResponse>
|
|
223
|
+
rescue ApiSdkRb::ApiError => e
|
|
224
|
+
puts "Error when calling ManagedUsersApi->create_managed_user_0_with_http_info: #{e}"
|
|
225
|
+
end
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
### Parameters
|
|
229
|
+
|
|
230
|
+
| Name | Type | Description | Notes |
|
|
231
|
+
| ---- | ---- | ----------- | ----- |
|
|
232
|
+
| **idempotency_key** | **String** | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`). | |
|
|
233
|
+
| **new_managed_user** | [**NewManagedUser**](NewManagedUser.md) | | |
|
|
234
|
+
|
|
235
|
+
### Return type
|
|
236
|
+
|
|
237
|
+
[**ManagedUserResponse**](ManagedUserResponse.md)
|
|
238
|
+
|
|
239
|
+
### Authorization
|
|
240
|
+
|
|
241
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
242
|
+
|
|
243
|
+
### HTTP request headers
|
|
244
|
+
|
|
245
|
+
- **Content-Type**: application/json
|
|
246
|
+
- **Accept**: application/json
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
## create_managed_user_editor_session_0
|
|
250
|
+
|
|
251
|
+
> <EditorSessionResponse> create_managed_user_editor_session_0(id, new_editor_session)
|
|
252
|
+
|
|
253
|
+
Create an editor session for a managed user
|
|
254
|
+
|
|
255
|
+
Makes a short-lived credential that lets the browser of ONE of your managed users use Widgetic's editor pieces, such as the File Browser and the composition editor, without your API key ever reaching that browser. Call this from your server when the page that hosts the editor opens, and hand the `token` in the answer to that page. The token is shown once. It starts with `wgt_ses_` and the browser sends it as `Authorization: Bearer <token>`. It can do only what the `surfaces` you name allow, and only for this managed user: - `files`: upload a file (`uploadsPost`) and list the files uploaded for this user (`uploadsGet`). Every file is filed for this user and stored in your own storage destination, never in Widgetic's: a file a customer uploads is yours to keep, and takes none of your storage allowance. Partner storage is not optional, so no session, whatever its surfaces, can be made until you have set a destination (`setPartnerStorageDestination`); until then it is refused with 409 and `PARTNER_STORAGE_REQUIRED`, and when the destination cannot be used with 503 and `STORAGE_DESTINATION_UNAVAILABLE`. A destination you remove after the session was made stops its uploads too (the same 409; the browser is only told that the feature is not available right now). To keep a customer from uploading, leave `files` out of the session and hand the editors your own media library instead (`mediaLibrary`). - `editor`: edit one of this user's compositions: read it (`getCompositionById`, its content, design, embed settings and schemas), check a content change (`validateCompositionContent`), and change its name, content, design and embed settings (`updateComposition`, `setDynamicContent`). It can reach only compositions you created for this managed user (tag them with `managedUserId` when you create them); any other composition, including another of your users', answers 404. - `creator`: use Widgetic's widget creator for this user, including its AI. Draw on canvases and save them (`getAllCanvases`, `getCanvas`, `createCanvas`, `updateCanvas`, `previewDeleteCanvas`, `deleteCanvas`); make, change, copy and delete the widgets on them (`createWidget`, `getWidgets`, `getWidgetsBatch`, `updateWidget`, `uploadWidgetThumbnail`, `duplicateWidget`, `deleteWidget`); list and make the compositions of a widget it built (`getAllCompositions`, `createComposition`), which is how it shows the widget with sample values; keep the conversation of each widget (`getConversationsByWidgetId`, `createConversationForWidget`, `updateConversation`, `getMessages`, `createMessage`, `updateMessage`, `restoreCheckpoint`); and read a widget's schemas and give it its repository (`getWidgetContentSchema`, `getWidgetDesignSchema`, `updateWidgetRepository`). The AI that builds a widget is part of it: list the models (`agentModelsGet`), open the widget's repository (`agentRepositoriesPost`, `agentRepositoriesRepoIdGet`), start a generation and follow or cancel it (`agentCodeGeneratePost`, `operationsStreamGet`, `operationsIdGet`, `operationsIdCancelPost`), build and preview the result (`agentWidgetBuilderRepoHeadWidgetIdGet`, `buildWidgetFromRepo`, `previewWidgetVersion`), publish a version of the widget and move between its versions (`agentWidgetBuilderPublishWidgetIdPost`, `getWidgetPublishHistory`, `setWidgetPublishHistoryLive`, `renameWidgetPublishHistoryTitle`), and turn a stroke or a sentence into a decision (`agentShapeRecognizePost`, `agentDesignResolvePost`). It can also offer the customer your presets as starting points: read them and ask for a copy for this customer (`listMyPresets`, `copyMyPreset`; you choose the presets with `setPartnerPreset`). What the session makes is filed for this managed user, and the lists it reads hold only this user's canvases, widgets and compositions. It can reach only canvases, widgets, compositions, repositories, uploaded files and operations made for this managed user (tag the canvases and widgets you create with `managedUserId`); any other canvas, widget, composition, conversation, message, repository, file or operation, including another of your users', answers 404. The creator also saves the composition it is editing (`updateComposition`, from the `editor` surface) and attaches pictures to its chat (`uploadsPost`, from the `files` surface), and the surfaces do not imply one another: to open the whole creator for a user, ask for `creator`, `editor` and `files` together. A generation or a build one user starts can be followed and cancelled by that user and by you, never by another of your users. The AI is paid for by your account, as your own calls are: its credits and allowances are yours. A session cannot make a widget public (publishing a version does not), file one under a project or an organization, or set anything the creator does not set: a body with another field is refused with 403 and `EDITOR_SESSION_FIELD_NOT_ALLOWED`. Everything else is refused with 403 and `EDITOR_SESSION_ROUTE_NOT_ALLOWED`: a session cannot read your account, make more sessions, change your presets or delete a composition, and a session without the `creator` surface cannot create or list compositions. Create the composition yourself with your API key, then open the editor on it. A session ends at `expiresAt` (at most four hours), when you end it (`revokeManagedUserEditorSession`), or when the managed user is switched off or deleted. A managed user can have at most 100 live sessions at once (`429 EDITOR_SESSION_LIMIT_REACHED`). A session that is bound to a web page (`allowedOrigin`) is refused from any other origin. The AI the session runs is paid for with your credits. Set `maxCredits` to hold the session to a number of them: once its generations have taken that many (a generation that fails is refunded and does not count), the next one is refused with 402 and `EDITOR_SESSION_CREDIT_LIMIT_REACHED`, and the browser is told only that the feature is not available right now. Without it, the limit Widgetic has set for your account applies when it has set one (the same limit for every session you make, and `maxCredits: null` asks for none), and otherwise the credits of your account are the only ceiling. What each of your users' sessions has spent is in `getManagedUserUsage`. Each call makes a new session. It does not take an `Idempotency-Key`: the answer holds the token, and the token is never stored where a retry could read it back. The answer is sent with `Cache-Control: no-store`.
|
|
256
|
+
|
|
257
|
+
### Examples
|
|
258
|
+
|
|
259
|
+
```ruby
|
|
260
|
+
require 'time'
|
|
261
|
+
require 'api-sdk-rb'
|
|
262
|
+
# setup authorization
|
|
263
|
+
ApiSdkRb.configure do |config|
|
|
264
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
265
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
266
|
+
end
|
|
267
|
+
|
|
268
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
269
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The managed user the session is for (Widgetic's id for the user)
|
|
270
|
+
new_editor_session = ApiSdkRb::NewEditorSession.new({surfaces: ["files", "editor"]}) # NewEditorSession |
|
|
271
|
+
|
|
272
|
+
begin
|
|
273
|
+
# Create an editor session for a managed user
|
|
274
|
+
result = api_instance.create_managed_user_editor_session_0(id, new_editor_session)
|
|
275
|
+
p result
|
|
276
|
+
rescue ApiSdkRb::ApiError => e
|
|
277
|
+
puts "Error when calling ManagedUsersApi->create_managed_user_editor_session_0: #{e}"
|
|
278
|
+
end
|
|
279
|
+
```
|
|
280
|
+
|
|
281
|
+
#### Using the create_managed_user_editor_session_0_with_http_info variant
|
|
282
|
+
|
|
283
|
+
This returns an Array which contains the response data, status code and headers.
|
|
284
|
+
|
|
285
|
+
> <Array(<EditorSessionResponse>, Integer, Hash)> create_managed_user_editor_session_0_with_http_info(id, new_editor_session)
|
|
286
|
+
|
|
287
|
+
```ruby
|
|
288
|
+
begin
|
|
289
|
+
# Create an editor session for a managed user
|
|
290
|
+
data, status_code, headers = api_instance.create_managed_user_editor_session_0_with_http_info(id, new_editor_session)
|
|
291
|
+
p status_code # => 2xx
|
|
292
|
+
p headers # => { ... }
|
|
293
|
+
p data # => <EditorSessionResponse>
|
|
294
|
+
rescue ApiSdkRb::ApiError => e
|
|
295
|
+
puts "Error when calling ManagedUsersApi->create_managed_user_editor_session_0_with_http_info: #{e}"
|
|
296
|
+
end
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Parameters
|
|
300
|
+
|
|
301
|
+
| Name | Type | Description | Notes |
|
|
302
|
+
| ---- | ---- | ----------- | ----- |
|
|
303
|
+
| **id** | **String** | The managed user the session is for (Widgetic's id for the user) | |
|
|
304
|
+
| **new_editor_session** | [**NewEditorSession**](NewEditorSession.md) | | |
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
[**EditorSessionResponse**](EditorSessionResponse.md)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: application/json
|
|
317
|
+
- **Accept**: application/json
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
## delete_managed_user_0
|
|
321
|
+
|
|
322
|
+
> <DeleteManagedUser200Response> delete_managed_user_0(id)
|
|
323
|
+
|
|
324
|
+
Delete Managed User
|
|
325
|
+
|
|
326
|
+
Deletes a managed user by ID. Its editor sessions end with it. What was filed under it (compositions, widgets, uploads) stays in your account, untagged.
|
|
327
|
+
|
|
328
|
+
### Examples
|
|
329
|
+
|
|
330
|
+
```ruby
|
|
331
|
+
require 'time'
|
|
332
|
+
require 'api-sdk-rb'
|
|
333
|
+
# setup authorization
|
|
334
|
+
ApiSdkRb.configure do |config|
|
|
335
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
336
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
337
|
+
end
|
|
338
|
+
|
|
339
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
340
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the managed user to delete
|
|
341
|
+
|
|
342
|
+
begin
|
|
343
|
+
# Delete Managed User
|
|
344
|
+
result = api_instance.delete_managed_user_0(id)
|
|
345
|
+
p result
|
|
346
|
+
rescue ApiSdkRb::ApiError => e
|
|
347
|
+
puts "Error when calling ManagedUsersApi->delete_managed_user_0: #{e}"
|
|
348
|
+
end
|
|
349
|
+
```
|
|
350
|
+
|
|
351
|
+
#### Using the delete_managed_user_0_with_http_info variant
|
|
352
|
+
|
|
353
|
+
This returns an Array which contains the response data, status code and headers.
|
|
354
|
+
|
|
355
|
+
> <Array(<DeleteManagedUser200Response>, Integer, Hash)> delete_managed_user_0_with_http_info(id)
|
|
356
|
+
|
|
357
|
+
```ruby
|
|
358
|
+
begin
|
|
359
|
+
# Delete Managed User
|
|
360
|
+
data, status_code, headers = api_instance.delete_managed_user_0_with_http_info(id)
|
|
361
|
+
p status_code # => 2xx
|
|
362
|
+
p headers # => { ... }
|
|
363
|
+
p data # => <DeleteManagedUser200Response>
|
|
364
|
+
rescue ApiSdkRb::ApiError => e
|
|
365
|
+
puts "Error when calling ManagedUsersApi->delete_managed_user_0_with_http_info: #{e}"
|
|
366
|
+
end
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### Parameters
|
|
370
|
+
|
|
371
|
+
| Name | Type | Description | Notes |
|
|
372
|
+
| ---- | ---- | ----------- | ----- |
|
|
373
|
+
| **id** | **String** | ID of the managed user to delete | |
|
|
374
|
+
|
|
375
|
+
### Return type
|
|
376
|
+
|
|
377
|
+
[**DeleteManagedUser200Response**](DeleteManagedUser200Response.md)
|
|
378
|
+
|
|
379
|
+
### Authorization
|
|
380
|
+
|
|
381
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
382
|
+
|
|
383
|
+
### HTTP request headers
|
|
384
|
+
|
|
385
|
+
- **Content-Type**: Not defined
|
|
386
|
+
- **Accept**: application/json
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
## get_all_managed_users_0
|
|
390
|
+
|
|
391
|
+
> <GetAllManagedUsers200Response> get_all_managed_users_0(opts)
|
|
392
|
+
|
|
393
|
+
Get Managed Users
|
|
394
|
+
|
|
395
|
+
Retrieve the managed users you manage, with pagination support. (Admins see every partner's managed users.)
|
|
396
|
+
|
|
397
|
+
### Examples
|
|
398
|
+
|
|
399
|
+
```ruby
|
|
400
|
+
require 'time'
|
|
401
|
+
require 'api-sdk-rb'
|
|
402
|
+
# setup authorization
|
|
403
|
+
ApiSdkRb.configure do |config|
|
|
404
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
405
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
406
|
+
end
|
|
407
|
+
|
|
408
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
409
|
+
opts = {
|
|
410
|
+
page: 56, # Integer | Page number for pagination
|
|
411
|
+
size: 56, # Integer | Number of items per page
|
|
412
|
+
sort: 'sort_example' # String | Sort field and direction, `<field>:<asc|desc>`. The field is `createdAt`, `updatedAt` or `externalId` (the snake_case spellings `created_at`, `updated_at` and `external_id` work too); `asc` or `desc` alone sorts by `createdAt`. Any other field is a 400.
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
begin
|
|
416
|
+
# Get Managed Users
|
|
417
|
+
result = api_instance.get_all_managed_users_0(opts)
|
|
418
|
+
p result
|
|
419
|
+
rescue ApiSdkRb::ApiError => e
|
|
420
|
+
puts "Error when calling ManagedUsersApi->get_all_managed_users_0: #{e}"
|
|
421
|
+
end
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
#### Using the get_all_managed_users_0_with_http_info variant
|
|
425
|
+
|
|
426
|
+
This returns an Array which contains the response data, status code and headers.
|
|
427
|
+
|
|
428
|
+
> <Array(<GetAllManagedUsers200Response>, Integer, Hash)> get_all_managed_users_0_with_http_info(opts)
|
|
429
|
+
|
|
430
|
+
```ruby
|
|
431
|
+
begin
|
|
432
|
+
# Get Managed Users
|
|
433
|
+
data, status_code, headers = api_instance.get_all_managed_users_0_with_http_info(opts)
|
|
434
|
+
p status_code # => 2xx
|
|
435
|
+
p headers # => { ... }
|
|
436
|
+
p data # => <GetAllManagedUsers200Response>
|
|
437
|
+
rescue ApiSdkRb::ApiError => e
|
|
438
|
+
puts "Error when calling ManagedUsersApi->get_all_managed_users_0_with_http_info: #{e}"
|
|
439
|
+
end
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
### Parameters
|
|
443
|
+
|
|
444
|
+
| Name | Type | Description | Notes |
|
|
445
|
+
| ---- | ---- | ----------- | ----- |
|
|
446
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
447
|
+
| **size** | **Integer** | Number of items per page | [optional][default to 10] |
|
|
448
|
+
| **sort** | **String** | Sort field and direction, `<field>:<asc|desc>`. The field is `createdAt`, `updatedAt` or `externalId` (the snake_case spellings `created_at`, `updated_at` and `external_id` work too); `asc` or `desc` alone sorts by `createdAt`. Any other field is a 400. | [optional][default to 'createdAt:desc'] |
|
|
449
|
+
|
|
450
|
+
### Return type
|
|
451
|
+
|
|
452
|
+
[**GetAllManagedUsers200Response**](GetAllManagedUsers200Response.md)
|
|
453
|
+
|
|
454
|
+
### Authorization
|
|
455
|
+
|
|
456
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
457
|
+
|
|
458
|
+
### HTTP request headers
|
|
459
|
+
|
|
460
|
+
- **Content-Type**: Not defined
|
|
461
|
+
- **Accept**: application/json
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
## get_managed_user_by_id_0
|
|
465
|
+
|
|
466
|
+
> <ManagedUserResponse> get_managed_user_by_id_0(id)
|
|
467
|
+
|
|
468
|
+
Get Managed User By ID
|
|
469
|
+
|
|
470
|
+
Retrieves a specific managed user by ID.
|
|
471
|
+
|
|
472
|
+
### Examples
|
|
473
|
+
|
|
474
|
+
```ruby
|
|
475
|
+
require 'time'
|
|
476
|
+
require 'api-sdk-rb'
|
|
477
|
+
# setup authorization
|
|
478
|
+
ApiSdkRb.configure do |config|
|
|
479
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
480
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
481
|
+
end
|
|
482
|
+
|
|
483
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
484
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the managed user to retrieve
|
|
485
|
+
|
|
486
|
+
begin
|
|
487
|
+
# Get Managed User By ID
|
|
488
|
+
result = api_instance.get_managed_user_by_id_0(id)
|
|
489
|
+
p result
|
|
490
|
+
rescue ApiSdkRb::ApiError => e
|
|
491
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_by_id_0: #{e}"
|
|
492
|
+
end
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
#### Using the get_managed_user_by_id_0_with_http_info variant
|
|
496
|
+
|
|
497
|
+
This returns an Array which contains the response data, status code and headers.
|
|
498
|
+
|
|
499
|
+
> <Array(<ManagedUserResponse>, Integer, Hash)> get_managed_user_by_id_0_with_http_info(id)
|
|
500
|
+
|
|
501
|
+
```ruby
|
|
502
|
+
begin
|
|
503
|
+
# Get Managed User By ID
|
|
504
|
+
data, status_code, headers = api_instance.get_managed_user_by_id_0_with_http_info(id)
|
|
505
|
+
p status_code # => 2xx
|
|
506
|
+
p headers # => { ... }
|
|
507
|
+
p data # => <ManagedUserResponse>
|
|
508
|
+
rescue ApiSdkRb::ApiError => e
|
|
509
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_by_id_0_with_http_info: #{e}"
|
|
510
|
+
end
|
|
511
|
+
```
|
|
512
|
+
|
|
513
|
+
### Parameters
|
|
514
|
+
|
|
515
|
+
| Name | Type | Description | Notes |
|
|
516
|
+
| ---- | ---- | ----------- | ----- |
|
|
517
|
+
| **id** | **String** | ID of the managed user to retrieve | |
|
|
518
|
+
|
|
519
|
+
### Return type
|
|
520
|
+
|
|
521
|
+
[**ManagedUserResponse**](ManagedUserResponse.md)
|
|
522
|
+
|
|
523
|
+
### Authorization
|
|
524
|
+
|
|
525
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
526
|
+
|
|
527
|
+
### HTTP request headers
|
|
528
|
+
|
|
529
|
+
- **Content-Type**: Not defined
|
|
530
|
+
- **Accept**: application/json
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
## get_managed_user_design_defaults_0
|
|
534
|
+
|
|
535
|
+
> <GetPartnerDesignDefaults200Response> get_managed_user_design_defaults_0(id)
|
|
536
|
+
|
|
537
|
+
Read design defaults for one managed user
|
|
538
|
+
|
|
539
|
+
### Examples
|
|
540
|
+
|
|
541
|
+
```ruby
|
|
542
|
+
require 'time'
|
|
543
|
+
require 'api-sdk-rb'
|
|
544
|
+
# setup authorization
|
|
545
|
+
ApiSdkRb.configure do |config|
|
|
546
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
547
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
548
|
+
end
|
|
549
|
+
|
|
550
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
551
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
552
|
+
|
|
553
|
+
begin
|
|
554
|
+
# Read design defaults for one managed user
|
|
555
|
+
result = api_instance.get_managed_user_design_defaults_0(id)
|
|
556
|
+
p result
|
|
557
|
+
rescue ApiSdkRb::ApiError => e
|
|
558
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_design_defaults_0: #{e}"
|
|
559
|
+
end
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
#### Using the get_managed_user_design_defaults_0_with_http_info variant
|
|
563
|
+
|
|
564
|
+
This returns an Array which contains the response data, status code and headers.
|
|
565
|
+
|
|
566
|
+
> <Array(<GetPartnerDesignDefaults200Response>, Integer, Hash)> get_managed_user_design_defaults_0_with_http_info(id)
|
|
567
|
+
|
|
568
|
+
```ruby
|
|
569
|
+
begin
|
|
570
|
+
# Read design defaults for one managed user
|
|
571
|
+
data, status_code, headers = api_instance.get_managed_user_design_defaults_0_with_http_info(id)
|
|
572
|
+
p status_code # => 2xx
|
|
573
|
+
p headers # => { ... }
|
|
574
|
+
p data # => <GetPartnerDesignDefaults200Response>
|
|
575
|
+
rescue ApiSdkRb::ApiError => e
|
|
576
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_design_defaults_0_with_http_info: #{e}"
|
|
577
|
+
end
|
|
578
|
+
```
|
|
579
|
+
|
|
580
|
+
### Parameters
|
|
581
|
+
|
|
582
|
+
| Name | Type | Description | Notes |
|
|
583
|
+
| ---- | ---- | ----------- | ----- |
|
|
584
|
+
| **id** | **String** | | |
|
|
585
|
+
|
|
586
|
+
### Return type
|
|
587
|
+
|
|
588
|
+
[**GetPartnerDesignDefaults200Response**](GetPartnerDesignDefaults200Response.md)
|
|
589
|
+
|
|
590
|
+
### Authorization
|
|
591
|
+
|
|
592
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
593
|
+
|
|
594
|
+
### HTTP request headers
|
|
595
|
+
|
|
596
|
+
- **Content-Type**: Not defined
|
|
597
|
+
- **Accept**: application/json
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
## get_managed_user_limits_0
|
|
601
|
+
|
|
602
|
+
> <GetManagedUserLimits200Response> get_managed_user_limits_0(id)
|
|
603
|
+
|
|
604
|
+
Read monthly credit cap and usage for one managed user
|
|
605
|
+
|
|
606
|
+
### Examples
|
|
607
|
+
|
|
608
|
+
```ruby
|
|
609
|
+
require 'time'
|
|
610
|
+
require 'api-sdk-rb'
|
|
611
|
+
# setup authorization
|
|
612
|
+
ApiSdkRb.configure do |config|
|
|
613
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
614
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
615
|
+
end
|
|
616
|
+
|
|
617
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
618
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
619
|
+
|
|
620
|
+
begin
|
|
621
|
+
# Read monthly credit cap and usage for one managed user
|
|
622
|
+
result = api_instance.get_managed_user_limits_0(id)
|
|
623
|
+
p result
|
|
624
|
+
rescue ApiSdkRb::ApiError => e
|
|
625
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_limits_0: #{e}"
|
|
626
|
+
end
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
#### Using the get_managed_user_limits_0_with_http_info variant
|
|
630
|
+
|
|
631
|
+
This returns an Array which contains the response data, status code and headers.
|
|
632
|
+
|
|
633
|
+
> <Array(<GetManagedUserLimits200Response>, Integer, Hash)> get_managed_user_limits_0_with_http_info(id)
|
|
634
|
+
|
|
635
|
+
```ruby
|
|
636
|
+
begin
|
|
637
|
+
# Read monthly credit cap and usage for one managed user
|
|
638
|
+
data, status_code, headers = api_instance.get_managed_user_limits_0_with_http_info(id)
|
|
639
|
+
p status_code # => 2xx
|
|
640
|
+
p headers # => { ... }
|
|
641
|
+
p data # => <GetManagedUserLimits200Response>
|
|
642
|
+
rescue ApiSdkRb::ApiError => e
|
|
643
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_limits_0_with_http_info: #{e}"
|
|
644
|
+
end
|
|
645
|
+
```
|
|
646
|
+
|
|
647
|
+
### Parameters
|
|
648
|
+
|
|
649
|
+
| Name | Type | Description | Notes |
|
|
650
|
+
| ---- | ---- | ----------- | ----- |
|
|
651
|
+
| **id** | **String** | | |
|
|
652
|
+
|
|
653
|
+
### Return type
|
|
654
|
+
|
|
655
|
+
[**GetManagedUserLimits200Response**](GetManagedUserLimits200Response.md)
|
|
656
|
+
|
|
657
|
+
### Authorization
|
|
658
|
+
|
|
659
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
660
|
+
|
|
661
|
+
### HTTP request headers
|
|
662
|
+
|
|
663
|
+
- **Content-Type**: Not defined
|
|
664
|
+
- **Accept**: application/json
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
## get_managed_user_storage_usage_0
|
|
668
|
+
|
|
669
|
+
> <GetManagedUserStorageUsage200Response> get_managed_user_storage_usage_0(id)
|
|
670
|
+
|
|
671
|
+
Storage used by one managed user's uploads
|
|
672
|
+
|
|
673
|
+
### Examples
|
|
674
|
+
|
|
675
|
+
```ruby
|
|
676
|
+
require 'time'
|
|
677
|
+
require 'api-sdk-rb'
|
|
678
|
+
# setup authorization
|
|
679
|
+
ApiSdkRb.configure do |config|
|
|
680
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
681
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
682
|
+
end
|
|
683
|
+
|
|
684
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
685
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
686
|
+
|
|
687
|
+
begin
|
|
688
|
+
# Storage used by one managed user's uploads
|
|
689
|
+
result = api_instance.get_managed_user_storage_usage_0(id)
|
|
690
|
+
p result
|
|
691
|
+
rescue ApiSdkRb::ApiError => e
|
|
692
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_storage_usage_0: #{e}"
|
|
693
|
+
end
|
|
694
|
+
```
|
|
695
|
+
|
|
696
|
+
#### Using the get_managed_user_storage_usage_0_with_http_info variant
|
|
697
|
+
|
|
698
|
+
This returns an Array which contains the response data, status code and headers.
|
|
699
|
+
|
|
700
|
+
> <Array(<GetManagedUserStorageUsage200Response>, Integer, Hash)> get_managed_user_storage_usage_0_with_http_info(id)
|
|
701
|
+
|
|
702
|
+
```ruby
|
|
703
|
+
begin
|
|
704
|
+
# Storage used by one managed user's uploads
|
|
705
|
+
data, status_code, headers = api_instance.get_managed_user_storage_usage_0_with_http_info(id)
|
|
706
|
+
p status_code # => 2xx
|
|
707
|
+
p headers # => { ... }
|
|
708
|
+
p data # => <GetManagedUserStorageUsage200Response>
|
|
709
|
+
rescue ApiSdkRb::ApiError => e
|
|
710
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_storage_usage_0_with_http_info: #{e}"
|
|
711
|
+
end
|
|
712
|
+
```
|
|
713
|
+
|
|
714
|
+
### Parameters
|
|
715
|
+
|
|
716
|
+
| Name | Type | Description | Notes |
|
|
717
|
+
| ---- | ---- | ----------- | ----- |
|
|
718
|
+
| **id** | **String** | | |
|
|
719
|
+
|
|
720
|
+
### Return type
|
|
721
|
+
|
|
722
|
+
[**GetManagedUserStorageUsage200Response**](GetManagedUserStorageUsage200Response.md)
|
|
723
|
+
|
|
724
|
+
### Authorization
|
|
725
|
+
|
|
726
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
727
|
+
|
|
728
|
+
### HTTP request headers
|
|
729
|
+
|
|
730
|
+
- **Content-Type**: Not defined
|
|
731
|
+
- **Accept**: application/json
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
## get_managed_user_usage_0
|
|
735
|
+
|
|
736
|
+
> <ManagedUserUsageResponse> get_managed_user_usage_0(id, opts)
|
|
737
|
+
|
|
738
|
+
What a managed user's editor sessions spent
|
|
739
|
+
|
|
740
|
+
Says how many credits the editor sessions of one of your managed users took from your account over a period, in total and for each operation. A generation costs one credit, taken from your account when it starts; one that fails is refunded and is counted as refunded, not as spent. Only what was spent through editor sessions is here, and only since usage was first recorded: what you spend with your API key, and anything from before, is not. Use it to see which of your users spend the most, or to charge them for it. To hold one session to a number of credits, set `max_credits` when you make it (`createManagedUserEditorSession`). The period runs from `startDate` (included) to `endDate` (not included): the 30 days before now when you give neither, and at most 366 days. A date without a time is midnight UTC at the start of that day, so for all of October give `startDate=2026-10-01` and `endDate=2026-11-01`.
|
|
741
|
+
|
|
742
|
+
### Examples
|
|
743
|
+
|
|
744
|
+
```ruby
|
|
745
|
+
require 'time'
|
|
746
|
+
require 'api-sdk-rb'
|
|
747
|
+
# setup authorization
|
|
748
|
+
ApiSdkRb.configure do |config|
|
|
749
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
750
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
751
|
+
end
|
|
752
|
+
|
|
753
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
754
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The managed user whose usage you want (Widgetic's id for the user)
|
|
755
|
+
opts = {
|
|
756
|
+
start_date: 'start_date_example', # String | Start of the period, included: an ISO 8601 date (`2026-10-01`) or date-time with its offset (`2026-10-01T08:00:00Z`). Default: 30 days before `endDate`.
|
|
757
|
+
end_date: 'end_date_example' # String | End of the period, not included, in the same forms. Default: now. It must be after `startDate`, by at most 366 days.
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
begin
|
|
761
|
+
# What a managed user's editor sessions spent
|
|
762
|
+
result = api_instance.get_managed_user_usage_0(id, opts)
|
|
763
|
+
p result
|
|
764
|
+
rescue ApiSdkRb::ApiError => e
|
|
765
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_usage_0: #{e}"
|
|
766
|
+
end
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
#### Using the get_managed_user_usage_0_with_http_info variant
|
|
770
|
+
|
|
771
|
+
This returns an Array which contains the response data, status code and headers.
|
|
772
|
+
|
|
773
|
+
> <Array(<ManagedUserUsageResponse>, Integer, Hash)> get_managed_user_usage_0_with_http_info(id, opts)
|
|
774
|
+
|
|
775
|
+
```ruby
|
|
776
|
+
begin
|
|
777
|
+
# What a managed user's editor sessions spent
|
|
778
|
+
data, status_code, headers = api_instance.get_managed_user_usage_0_with_http_info(id, opts)
|
|
779
|
+
p status_code # => 2xx
|
|
780
|
+
p headers # => { ... }
|
|
781
|
+
p data # => <ManagedUserUsageResponse>
|
|
782
|
+
rescue ApiSdkRb::ApiError => e
|
|
783
|
+
puts "Error when calling ManagedUsersApi->get_managed_user_usage_0_with_http_info: #{e}"
|
|
784
|
+
end
|
|
785
|
+
```
|
|
786
|
+
|
|
787
|
+
### Parameters
|
|
788
|
+
|
|
789
|
+
| Name | Type | Description | Notes |
|
|
790
|
+
| ---- | ---- | ----------- | ----- |
|
|
791
|
+
| **id** | **String** | The managed user whose usage you want (Widgetic's id for the user) | |
|
|
792
|
+
| **start_date** | **String** | Start of the period, included: an ISO 8601 date (`2026-10-01`) or date-time with its offset (`2026-10-01T08:00:00Z`). Default: 30 days before `endDate`. | [optional] |
|
|
793
|
+
| **end_date** | **String** | End of the period, not included, in the same forms. Default: now. It must be after `startDate`, by at most 366 days. | [optional] |
|
|
794
|
+
|
|
795
|
+
### Return type
|
|
796
|
+
|
|
797
|
+
[**ManagedUserUsageResponse**](ManagedUserUsageResponse.md)
|
|
798
|
+
|
|
799
|
+
### Authorization
|
|
800
|
+
|
|
801
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
802
|
+
|
|
803
|
+
### HTTP request headers
|
|
804
|
+
|
|
805
|
+
- **Content-Type**: Not defined
|
|
806
|
+
- **Accept**: application/json
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
## get_managed_users_by_manager_id_0
|
|
810
|
+
|
|
811
|
+
> <GetManagedUsersByManagerIdResponse> get_managed_users_by_manager_id_0(manager_id, opts)
|
|
812
|
+
|
|
813
|
+
Get Managed Users By Manager
|
|
814
|
+
|
|
815
|
+
Retrieve managed users for a specific manager with pagination support.
|
|
816
|
+
|
|
817
|
+
### Examples
|
|
818
|
+
|
|
819
|
+
```ruby
|
|
820
|
+
require 'time'
|
|
821
|
+
require 'api-sdk-rb'
|
|
822
|
+
# setup authorization
|
|
823
|
+
ApiSdkRb.configure do |config|
|
|
824
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
825
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
826
|
+
end
|
|
827
|
+
|
|
828
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
829
|
+
manager_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the manager
|
|
830
|
+
opts = {
|
|
831
|
+
page: 56, # Integer | Page number for pagination
|
|
832
|
+
size: 56, # Integer | Number of items per page
|
|
833
|
+
sort: 'sort_example' # String | Sort field and direction, `<field>:<asc|desc>`. The field is `createdAt`, `updatedAt` or `externalId` (the snake_case spellings `created_at`, `updated_at` and `external_id` work too); `asc` or `desc` alone sorts by `createdAt`. Any other field is a 400.
|
|
834
|
+
}
|
|
835
|
+
|
|
836
|
+
begin
|
|
837
|
+
# Get Managed Users By Manager
|
|
838
|
+
result = api_instance.get_managed_users_by_manager_id_0(manager_id, opts)
|
|
839
|
+
p result
|
|
840
|
+
rescue ApiSdkRb::ApiError => e
|
|
841
|
+
puts "Error when calling ManagedUsersApi->get_managed_users_by_manager_id_0: #{e}"
|
|
842
|
+
end
|
|
843
|
+
```
|
|
844
|
+
|
|
845
|
+
#### Using the get_managed_users_by_manager_id_0_with_http_info variant
|
|
846
|
+
|
|
847
|
+
This returns an Array which contains the response data, status code and headers.
|
|
848
|
+
|
|
849
|
+
> <Array(<GetManagedUsersByManagerIdResponse>, Integer, Hash)> get_managed_users_by_manager_id_0_with_http_info(manager_id, opts)
|
|
850
|
+
|
|
851
|
+
```ruby
|
|
852
|
+
begin
|
|
853
|
+
# Get Managed Users By Manager
|
|
854
|
+
data, status_code, headers = api_instance.get_managed_users_by_manager_id_0_with_http_info(manager_id, opts)
|
|
855
|
+
p status_code # => 2xx
|
|
856
|
+
p headers # => { ... }
|
|
857
|
+
p data # => <GetManagedUsersByManagerIdResponse>
|
|
858
|
+
rescue ApiSdkRb::ApiError => e
|
|
859
|
+
puts "Error when calling ManagedUsersApi->get_managed_users_by_manager_id_0_with_http_info: #{e}"
|
|
860
|
+
end
|
|
861
|
+
```
|
|
862
|
+
|
|
863
|
+
### Parameters
|
|
864
|
+
|
|
865
|
+
| Name | Type | Description | Notes |
|
|
866
|
+
| ---- | ---- | ----------- | ----- |
|
|
867
|
+
| **manager_id** | **String** | ID of the manager | |
|
|
868
|
+
| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
|
|
869
|
+
| **size** | **Integer** | Number of items per page | [optional][default to 10] |
|
|
870
|
+
| **sort** | **String** | Sort field and direction, `<field>:<asc|desc>`. The field is `createdAt`, `updatedAt` or `externalId` (the snake_case spellings `created_at`, `updated_at` and `external_id` work too); `asc` or `desc` alone sorts by `createdAt`. Any other field is a 400. | [optional][default to 'createdAt:desc'] |
|
|
871
|
+
|
|
872
|
+
### Return type
|
|
873
|
+
|
|
874
|
+
[**GetManagedUsersByManagerIdResponse**](GetManagedUsersByManagerIdResponse.md)
|
|
875
|
+
|
|
876
|
+
### Authorization
|
|
877
|
+
|
|
878
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
879
|
+
|
|
880
|
+
### HTTP request headers
|
|
881
|
+
|
|
882
|
+
- **Content-Type**: Not defined
|
|
883
|
+
- **Accept**: application/json
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
## revoke_managed_user_editor_session_0
|
|
887
|
+
|
|
888
|
+
> <DeleteManagedUser200Response> revoke_managed_user_editor_session_0(id, session_id)
|
|
889
|
+
|
|
890
|
+
End one editor session of a managed user
|
|
891
|
+
|
|
892
|
+
Ends the session at once: its token stops working on the next request (on another server of ours, within a few seconds). Ending a session that has already ended is fine.
|
|
893
|
+
|
|
894
|
+
### Examples
|
|
895
|
+
|
|
896
|
+
```ruby
|
|
897
|
+
require 'time'
|
|
898
|
+
require 'api-sdk-rb'
|
|
899
|
+
# setup authorization
|
|
900
|
+
ApiSdkRb.configure do |config|
|
|
901
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
902
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
903
|
+
end
|
|
904
|
+
|
|
905
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
906
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The managed user the session is for
|
|
907
|
+
session_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The `sessionId` of the session, from `createManagedUserEditorSession`
|
|
908
|
+
|
|
909
|
+
begin
|
|
910
|
+
# End one editor session of a managed user
|
|
911
|
+
result = api_instance.revoke_managed_user_editor_session_0(id, session_id)
|
|
912
|
+
p result
|
|
913
|
+
rescue ApiSdkRb::ApiError => e
|
|
914
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_session_0: #{e}"
|
|
915
|
+
end
|
|
916
|
+
```
|
|
917
|
+
|
|
918
|
+
#### Using the revoke_managed_user_editor_session_0_with_http_info variant
|
|
919
|
+
|
|
920
|
+
This returns an Array which contains the response data, status code and headers.
|
|
921
|
+
|
|
922
|
+
> <Array(<DeleteManagedUser200Response>, Integer, Hash)> revoke_managed_user_editor_session_0_with_http_info(id, session_id)
|
|
923
|
+
|
|
924
|
+
```ruby
|
|
925
|
+
begin
|
|
926
|
+
# End one editor session of a managed user
|
|
927
|
+
data, status_code, headers = api_instance.revoke_managed_user_editor_session_0_with_http_info(id, session_id)
|
|
928
|
+
p status_code # => 2xx
|
|
929
|
+
p headers # => { ... }
|
|
930
|
+
p data # => <DeleteManagedUser200Response>
|
|
931
|
+
rescue ApiSdkRb::ApiError => e
|
|
932
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_session_0_with_http_info: #{e}"
|
|
933
|
+
end
|
|
934
|
+
```
|
|
935
|
+
|
|
936
|
+
### Parameters
|
|
937
|
+
|
|
938
|
+
| Name | Type | Description | Notes |
|
|
939
|
+
| ---- | ---- | ----------- | ----- |
|
|
940
|
+
| **id** | **String** | The managed user the session is for | |
|
|
941
|
+
| **session_id** | **String** | The `sessionId` of the session, from `createManagedUserEditorSession` | |
|
|
942
|
+
|
|
943
|
+
### Return type
|
|
944
|
+
|
|
945
|
+
[**DeleteManagedUser200Response**](DeleteManagedUser200Response.md)
|
|
946
|
+
|
|
947
|
+
### Authorization
|
|
948
|
+
|
|
949
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
950
|
+
|
|
951
|
+
### HTTP request headers
|
|
952
|
+
|
|
953
|
+
- **Content-Type**: Not defined
|
|
954
|
+
- **Accept**: application/json
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
## revoke_managed_user_editor_sessions_0
|
|
958
|
+
|
|
959
|
+
> <RevokeManagedUserEditorSessionsResponse> revoke_managed_user_editor_sessions_0(id)
|
|
960
|
+
|
|
961
|
+
End every editor session of a managed user
|
|
962
|
+
|
|
963
|
+
Ends all of the managed user's live editor sessions at once, for example when the user signs out of your platform. Their tokens stop working on the next request (on another server of ours, within a few seconds). It is fine to call it for a user who has none.
|
|
964
|
+
|
|
965
|
+
### Examples
|
|
966
|
+
|
|
967
|
+
```ruby
|
|
968
|
+
require 'time'
|
|
969
|
+
require 'api-sdk-rb'
|
|
970
|
+
# setup authorization
|
|
971
|
+
ApiSdkRb.configure do |config|
|
|
972
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
973
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
974
|
+
end
|
|
975
|
+
|
|
976
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
977
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The managed user whose sessions end
|
|
978
|
+
|
|
979
|
+
begin
|
|
980
|
+
# End every editor session of a managed user
|
|
981
|
+
result = api_instance.revoke_managed_user_editor_sessions_0(id)
|
|
982
|
+
p result
|
|
983
|
+
rescue ApiSdkRb::ApiError => e
|
|
984
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_sessions_0: #{e}"
|
|
985
|
+
end
|
|
986
|
+
```
|
|
987
|
+
|
|
988
|
+
#### Using the revoke_managed_user_editor_sessions_0_with_http_info variant
|
|
989
|
+
|
|
990
|
+
This returns an Array which contains the response data, status code and headers.
|
|
991
|
+
|
|
992
|
+
> <Array(<RevokeManagedUserEditorSessionsResponse>, Integer, Hash)> revoke_managed_user_editor_sessions_0_with_http_info(id)
|
|
993
|
+
|
|
994
|
+
```ruby
|
|
995
|
+
begin
|
|
996
|
+
# End every editor session of a managed user
|
|
997
|
+
data, status_code, headers = api_instance.revoke_managed_user_editor_sessions_0_with_http_info(id)
|
|
998
|
+
p status_code # => 2xx
|
|
999
|
+
p headers # => { ... }
|
|
1000
|
+
p data # => <RevokeManagedUserEditorSessionsResponse>
|
|
1001
|
+
rescue ApiSdkRb::ApiError => e
|
|
1002
|
+
puts "Error when calling ManagedUsersApi->revoke_managed_user_editor_sessions_0_with_http_info: #{e}"
|
|
1003
|
+
end
|
|
1004
|
+
```
|
|
1005
|
+
|
|
1006
|
+
### Parameters
|
|
1007
|
+
|
|
1008
|
+
| Name | Type | Description | Notes |
|
|
1009
|
+
| ---- | ---- | ----------- | ----- |
|
|
1010
|
+
| **id** | **String** | The managed user whose sessions end | |
|
|
1011
|
+
|
|
1012
|
+
### Return type
|
|
1013
|
+
|
|
1014
|
+
[**RevokeManagedUserEditorSessionsResponse**](RevokeManagedUserEditorSessionsResponse.md)
|
|
1015
|
+
|
|
1016
|
+
### Authorization
|
|
1017
|
+
|
|
1018
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1019
|
+
|
|
1020
|
+
### HTTP request headers
|
|
1021
|
+
|
|
1022
|
+
- **Content-Type**: Not defined
|
|
1023
|
+
- **Accept**: application/json
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
## set_managed_user_design_defaults_0
|
|
1027
|
+
|
|
1028
|
+
> <GetPartnerDesignDefaults200Response> set_managed_user_design_defaults_0(id, set_partner_design_defaults_request)
|
|
1029
|
+
|
|
1030
|
+
Set or clear design defaults for one managed user
|
|
1031
|
+
|
|
1032
|
+
Send `{ \"design\": { ... } }` to store a JSON object (at most 64 KB, nesting depth 32), or `{ \"design\": null }` to remove the override. New compositions for this customer merge this layer over the partner default and under the request body.
|
|
1033
|
+
|
|
1034
|
+
### Examples
|
|
1035
|
+
|
|
1036
|
+
```ruby
|
|
1037
|
+
require 'time'
|
|
1038
|
+
require 'api-sdk-rb'
|
|
1039
|
+
# setup authorization
|
|
1040
|
+
ApiSdkRb.configure do |config|
|
|
1041
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1042
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1043
|
+
end
|
|
1044
|
+
|
|
1045
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
1046
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
1047
|
+
set_partner_design_defaults_request = ApiSdkRb::SetPartnerDesignDefaultsRequest.new({design: 3.56}) # SetPartnerDesignDefaultsRequest |
|
|
1048
|
+
|
|
1049
|
+
begin
|
|
1050
|
+
# Set or clear design defaults for one managed user
|
|
1051
|
+
result = api_instance.set_managed_user_design_defaults_0(id, set_partner_design_defaults_request)
|
|
1052
|
+
p result
|
|
1053
|
+
rescue ApiSdkRb::ApiError => e
|
|
1054
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_design_defaults_0: #{e}"
|
|
1055
|
+
end
|
|
1056
|
+
```
|
|
1057
|
+
|
|
1058
|
+
#### Using the set_managed_user_design_defaults_0_with_http_info variant
|
|
1059
|
+
|
|
1060
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1061
|
+
|
|
1062
|
+
> <Array(<GetPartnerDesignDefaults200Response>, Integer, Hash)> set_managed_user_design_defaults_0_with_http_info(id, set_partner_design_defaults_request)
|
|
1063
|
+
|
|
1064
|
+
```ruby
|
|
1065
|
+
begin
|
|
1066
|
+
# Set or clear design defaults for one managed user
|
|
1067
|
+
data, status_code, headers = api_instance.set_managed_user_design_defaults_0_with_http_info(id, set_partner_design_defaults_request)
|
|
1068
|
+
p status_code # => 2xx
|
|
1069
|
+
p headers # => { ... }
|
|
1070
|
+
p data # => <GetPartnerDesignDefaults200Response>
|
|
1071
|
+
rescue ApiSdkRb::ApiError => e
|
|
1072
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_design_defaults_0_with_http_info: #{e}"
|
|
1073
|
+
end
|
|
1074
|
+
```
|
|
1075
|
+
|
|
1076
|
+
### Parameters
|
|
1077
|
+
|
|
1078
|
+
| Name | Type | Description | Notes |
|
|
1079
|
+
| ---- | ---- | ----------- | ----- |
|
|
1080
|
+
| **id** | **String** | | |
|
|
1081
|
+
| **set_partner_design_defaults_request** | [**SetPartnerDesignDefaultsRequest**](SetPartnerDesignDefaultsRequest.md) | | |
|
|
1082
|
+
|
|
1083
|
+
### Return type
|
|
1084
|
+
|
|
1085
|
+
[**GetPartnerDesignDefaults200Response**](GetPartnerDesignDefaults200Response.md)
|
|
1086
|
+
|
|
1087
|
+
### Authorization
|
|
1088
|
+
|
|
1089
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1090
|
+
|
|
1091
|
+
### HTTP request headers
|
|
1092
|
+
|
|
1093
|
+
- **Content-Type**: application/json
|
|
1094
|
+
- **Accept**: application/json
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
## set_managed_user_limits_0
|
|
1098
|
+
|
|
1099
|
+
> <GetManagedUserLimits200Response> set_managed_user_limits_0(id, set_managed_user_limits_request)
|
|
1100
|
+
|
|
1101
|
+
Set or clear the monthly credit cap for one managed user
|
|
1102
|
+
|
|
1103
|
+
Send monthlyCredits as a whole number from 0 up to 2147483647 to cap what this customer's editor sessions may spend in a UTC calendar month, or null to remove the cap. The cap counts the credits the customer's sessions spent that month (refunded credits do not count) and applies to all of the customer's sessions together, beside any `max_credits` a single session was given. A cap of 0 stops all paid work by this customer until you raise it. The cap starts counting from the first of the month (UTC); a cap set below what was already spent this month stops further work at once.
|
|
1104
|
+
|
|
1105
|
+
### Examples
|
|
1106
|
+
|
|
1107
|
+
```ruby
|
|
1108
|
+
require 'time'
|
|
1109
|
+
require 'api-sdk-rb'
|
|
1110
|
+
# setup authorization
|
|
1111
|
+
ApiSdkRb.configure do |config|
|
|
1112
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1113
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1114
|
+
end
|
|
1115
|
+
|
|
1116
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
1117
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
1118
|
+
set_managed_user_limits_request = ApiSdkRb::SetManagedUserLimitsRequest.new({monthly_credits: 37}) # SetManagedUserLimitsRequest |
|
|
1119
|
+
|
|
1120
|
+
begin
|
|
1121
|
+
# Set or clear the monthly credit cap for one managed user
|
|
1122
|
+
result = api_instance.set_managed_user_limits_0(id, set_managed_user_limits_request)
|
|
1123
|
+
p result
|
|
1124
|
+
rescue ApiSdkRb::ApiError => e
|
|
1125
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_limits_0: #{e}"
|
|
1126
|
+
end
|
|
1127
|
+
```
|
|
1128
|
+
|
|
1129
|
+
#### Using the set_managed_user_limits_0_with_http_info variant
|
|
1130
|
+
|
|
1131
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1132
|
+
|
|
1133
|
+
> <Array(<GetManagedUserLimits200Response>, Integer, Hash)> set_managed_user_limits_0_with_http_info(id, set_managed_user_limits_request)
|
|
1134
|
+
|
|
1135
|
+
```ruby
|
|
1136
|
+
begin
|
|
1137
|
+
# Set or clear the monthly credit cap for one managed user
|
|
1138
|
+
data, status_code, headers = api_instance.set_managed_user_limits_0_with_http_info(id, set_managed_user_limits_request)
|
|
1139
|
+
p status_code # => 2xx
|
|
1140
|
+
p headers # => { ... }
|
|
1141
|
+
p data # => <GetManagedUserLimits200Response>
|
|
1142
|
+
rescue ApiSdkRb::ApiError => e
|
|
1143
|
+
puts "Error when calling ManagedUsersApi->set_managed_user_limits_0_with_http_info: #{e}"
|
|
1144
|
+
end
|
|
1145
|
+
```
|
|
1146
|
+
|
|
1147
|
+
### Parameters
|
|
1148
|
+
|
|
1149
|
+
| Name | Type | Description | Notes |
|
|
1150
|
+
| ---- | ---- | ----------- | ----- |
|
|
1151
|
+
| **id** | **String** | | |
|
|
1152
|
+
| **set_managed_user_limits_request** | [**SetManagedUserLimitsRequest**](SetManagedUserLimitsRequest.md) | | |
|
|
1153
|
+
|
|
1154
|
+
### Return type
|
|
1155
|
+
|
|
1156
|
+
[**GetManagedUserLimits200Response**](GetManagedUserLimits200Response.md)
|
|
1157
|
+
|
|
1158
|
+
### Authorization
|
|
1159
|
+
|
|
1160
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1161
|
+
|
|
1162
|
+
### HTTP request headers
|
|
1163
|
+
|
|
1164
|
+
- **Content-Type**: application/json
|
|
1165
|
+
- **Accept**: application/json
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
## update_managed_user_0
|
|
1169
|
+
|
|
1170
|
+
> <ManagedUserResponse> update_managed_user_0(id, idempotency_key, update_managed_user)
|
|
1171
|
+
|
|
1172
|
+
Update Managed User
|
|
1173
|
+
|
|
1174
|
+
Updates an existing managed user. Only `externalId`, `metadata` and `isActive` can change, and `metadata` is replaced as a whole, so send all of it. `isActive: false` switches the managed user off: what it already has stays, and nothing new can be filed under it until you send `isActive: true`. Switching it off also ends all of its editor sessions, and they do not come back when you switch it on again. The `Idempotency-Key` header is required (`400` without it).
|
|
1175
|
+
|
|
1176
|
+
### Examples
|
|
1177
|
+
|
|
1178
|
+
```ruby
|
|
1179
|
+
require 'time'
|
|
1180
|
+
require 'api-sdk-rb'
|
|
1181
|
+
# setup authorization
|
|
1182
|
+
ApiSdkRb.configure do |config|
|
|
1183
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1184
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1185
|
+
end
|
|
1186
|
+
|
|
1187
|
+
api_instance = ApiSdkRb::ManagedUsersApi.new
|
|
1188
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the managed user to update
|
|
1189
|
+
idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
|
|
1190
|
+
update_managed_user = ApiSdkRb::UpdateManagedUser.new # UpdateManagedUser |
|
|
1191
|
+
|
|
1192
|
+
begin
|
|
1193
|
+
# Update Managed User
|
|
1194
|
+
result = api_instance.update_managed_user_0(id, idempotency_key, update_managed_user)
|
|
1195
|
+
p result
|
|
1196
|
+
rescue ApiSdkRb::ApiError => e
|
|
1197
|
+
puts "Error when calling ManagedUsersApi->update_managed_user_0: #{e}"
|
|
1198
|
+
end
|
|
1199
|
+
```
|
|
1200
|
+
|
|
1201
|
+
#### Using the update_managed_user_0_with_http_info variant
|
|
1202
|
+
|
|
1203
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1204
|
+
|
|
1205
|
+
> <Array(<ManagedUserResponse>, Integer, Hash)> update_managed_user_0_with_http_info(id, idempotency_key, update_managed_user)
|
|
1206
|
+
|
|
1207
|
+
```ruby
|
|
1208
|
+
begin
|
|
1209
|
+
# Update Managed User
|
|
1210
|
+
data, status_code, headers = api_instance.update_managed_user_0_with_http_info(id, idempotency_key, update_managed_user)
|
|
1211
|
+
p status_code # => 2xx
|
|
1212
|
+
p headers # => { ... }
|
|
1213
|
+
p data # => <ManagedUserResponse>
|
|
1214
|
+
rescue ApiSdkRb::ApiError => e
|
|
1215
|
+
puts "Error when calling ManagedUsersApi->update_managed_user_0_with_http_info: #{e}"
|
|
1216
|
+
end
|
|
1217
|
+
```
|
|
1218
|
+
|
|
1219
|
+
### Parameters
|
|
1220
|
+
|
|
1221
|
+
| Name | Type | Description | Notes |
|
|
1222
|
+
| ---- | ---- | ----------- | ----- |
|
|
1223
|
+
| **id** | **String** | ID of the managed user to update | |
|
|
1224
|
+
| **idempotency_key** | **String** | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`). | |
|
|
1225
|
+
| **update_managed_user** | [**UpdateManagedUser**](UpdateManagedUser.md) | | |
|
|
1226
|
+
|
|
1227
|
+
### Return type
|
|
1228
|
+
|
|
1229
|
+
[**ManagedUserResponse**](ManagedUserResponse.md)
|
|
1230
|
+
|
|
1231
|
+
### Authorization
|
|
1232
|
+
|
|
1233
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1234
|
+
|
|
1235
|
+
### HTTP request headers
|
|
1236
|
+
|
|
1237
|
+
- **Content-Type**: application/json
|
|
1238
|
+
- **Accept**: application/json
|
|
1239
|
+
|