api-sdk-rb 1.11.66 → 1.11.133
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 +4 -4
- data/README.md +294 -285
- data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
- data/docs/AdapterConnection.md +7 -1
- data/docs/{GetUserAdapterConnections200Response.md → AdapterConnectionListResponse.md} +2 -2
- data/docs/{RemoveUserAdapterConnection200Response.md → AdapterConnectionRemovalResponse.md} +2 -2
- data/docs/{SetUserAdapterConnection200Response.md → AdapterConnectionResponse.md} +2 -2
- data/docs/{AddAiAnswersKnowledgeDocument201Response.md → AiAnswersKnowledgeDocumentResponse.md} +2 -2
- data/docs/BrandColor.md +22 -0
- data/docs/BrandFont.md +24 -0
- data/docs/BrandKitApi.md +593 -0
- data/docs/BrandKitAssetView.md +42 -0
- data/docs/BrandKitFigmaSource.md +26 -0
- data/docs/BrandKitTokens.md +26 -0
- data/docs/BrandKitTokensFonts.md +24 -0
- data/docs/BrandKitView.md +36 -0
- data/docs/BrandKitViewOwner.md +20 -0
- data/docs/{OperationsIdGetResponse.md → BrandKitViewResponse.md} +3 -3
- data/docs/BrandSpacing.md +32 -0
- data/docs/BrandTextStyle.md +22 -0
- data/docs/CanvasesApi.md +45 -45
- data/docs/Composition.md +5 -1
- data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
- data/docs/CompositionLastEditedBy.md +20 -0
- data/docs/CompositionsApi.md +821 -473
- data/docs/ConfirmAdapterConnectionRequest.md +18 -0
- data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
- data/docs/CreateWidget201ResponseData.md +2 -4
- data/docs/CreateWorkspaceWorkflowFromPresetRequest.md +20 -0
- data/docs/CreateWorkspaceWorkflowRequest.md +22 -0
- data/docs/CreditsApi.md +20 -20
- data/docs/DeleteUpload200Response.md +22 -0
- data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
- data/docs/DeleteWorkspaceWorkflow200Response.md +22 -0
- data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
- data/docs/EntitlementsApi.md +18 -18
- data/docs/GetOperationResponse.md +22 -0
- data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
- data/docs/GetOperationResponseDataMetadata.md +24 -0
- data/docs/GetPublicCompositionEmbed200Response.md +7 -1
- data/docs/GetPublicCompositionEmbed200ResponseAdapters.md +20 -0
- data/docs/GetPublicCompositionEmbed200ResponseAdaptersCaptcha.md +18 -0
- data/docs/GetPublicCompositionEmbed200ResponseEntries.md +20 -0
- data/docs/GetPublicCompositionEmbed200ResponseMedia.md +18 -0
- data/docs/GetWorkspaceWorkflowStats200Response.md +22 -0
- data/docs/GetWorkspaceWorkflowVersion200Response.md +22 -0
- data/docs/InvoicesApi.md +9 -9
- data/docs/ListPartnerWorkflowPresets200Response.md +22 -0
- data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
- data/docs/ListWorkspaceWorkflowCompositionOptions200Response.md +22 -0
- data/docs/ListWorkspaceWorkflowPresets200Response.md +22 -0
- data/docs/ListWorkspaceWorkflowVersions200Response.md +22 -0
- data/docs/ListWorkspaceWorkflows200Response.md +22 -0
- data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
- data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
- data/docs/ManagedUsersApi.md +261 -171
- data/docs/NewComposition.md +1 -1
- data/docs/NewEditorSession.md +1 -1
- data/docs/OfferWorkflowPresetRequest.md +24 -0
- data/docs/OfferedWorkflowPreset.md +40 -0
- data/docs/OfferedWorkflowPresetList.md +18 -0
- data/docs/OfferedWorkflowPresetWidget.md +22 -0
- data/docs/OperationsApi.md +11 -11
- data/docs/PartnerCustomization.md +2 -2
- data/docs/PartnerNotification.md +1 -1
- data/docs/PartnersApi.md +644 -352
- data/docs/PatchBrandKitAssetRequest.md +24 -0
- data/docs/PatchBrandKitRequest.md +30 -0
- data/docs/PatchBrandKitRequestFonts.md +24 -0
- data/docs/PatchBrandKitRequestSpacing.md +32 -0
- data/docs/PostBrandKitIconRequest.md +20 -0
- data/docs/PublicEmbedApi.md +324 -58
- data/docs/PublicWorkflow.md +36 -0
- data/docs/PublicWorkflowEventsAccepted.md +22 -0
- data/docs/PublicWorkflowEventsRequest.md +24 -0
- data/docs/PublicWorkflowEventsRequestEventsInner.md +24 -0
- data/docs/PublicWorkflowEventsRequestHeightsInner.md +20 -0
- data/docs/{CreateCompositionFromWidget201Response.md → PublicWorkflowResponse.md} +3 -3
- data/docs/PublicWorkflowTranslation.md +20 -0
- data/docs/PublishWorkspaceWorkflow200Response.md +22 -0
- data/docs/PublishWorkspaceWorkflowRequest.md +18 -0
- data/docs/PutBrandKitRequest.md +22 -0
- data/docs/RemovePartnerWorkflowPreset200Response.md +22 -0
- data/docs/ReportPublicWorkflowEvents200Response.md +22 -0
- data/docs/SaveWorkspaceWorkflowRequest.md +24 -0
- data/docs/SetAdapterConnectionRequest.md +1 -1
- data/docs/SetPartnerWorkflowPreset200Response.md +22 -0
- data/docs/TokensApi.md +11 -9
- data/docs/UpdateComposition.md +1 -1
- data/docs/Upload.md +1 -1
- data/docs/UploadLimits.md +3 -3
- data/docs/UploadsApi.md +85 -85
- data/docs/UsersApi.md +191 -115
- data/docs/Widget.md +2 -4
- data/docs/WidgetClarification.md +22 -0
- data/docs/WidgetClarificationOption.md +22 -0
- data/docs/WidgetClarificationQuestion.md +26 -0
- data/docs/WidgetNextStep.md +24 -0
- data/docs/WidgetPlan.md +26 -0
- data/docs/WidgetPlanDecisions.md +32 -0
- data/docs/WidgetPlanDecisionsAdaptersInner.md +20 -0
- data/docs/WidgetPlanDecisionsLibrariesInner.md +22 -0
- data/docs/WidgetPlanDecisionsResponsive.md +22 -0
- data/docs/WidgetPlanTask.md +24 -0
- data/docs/WidgetsApi.md +38 -38
- data/docs/Workflow.md +50 -0
- data/docs/WorkflowCompositionAction.md +24 -0
- data/docs/WorkflowCompositionField.md +24 -0
- data/docs/WorkflowCompositionOption.md +30 -0
- data/docs/WorkflowCompositionOptionActions.md +22 -0
- data/docs/WorkflowCompositionOptionInputs.md +24 -0
- data/docs/WorkflowCompositionOptions.md +24 -0
- data/docs/WorkflowConditionCase.md +24 -0
- data/docs/WorkflowConditionTest.md +22 -0
- data/docs/WorkflowCounter.md +20 -0
- data/docs/WorkflowDetail.md +60 -0
- data/docs/WorkflowDetailAllOfLastEditedBy.md +20 -0
- data/docs/WorkflowDetailResponse.md +22 -0
- data/docs/WorkflowEdge.md +24 -0
- data/docs/WorkflowFailureReason.md +15 -0
- data/docs/WorkflowFailureReasonCounter.md +22 -0
- data/docs/WorkflowFieldReference.md +22 -0
- data/docs/WorkflowGraph.md +22 -0
- data/docs/WorkflowIssue.md +28 -0
- data/docs/WorkflowList.md +24 -0
- data/docs/WorkflowNode.md +30 -0
- data/docs/WorkflowNodePosition.md +20 -0
- data/docs/WorkflowPresetChoice.md +26 -0
- data/docs/WorkflowPresetChoices.md +18 -0
- data/docs/WorkflowPresetRemoval.md +18 -0
- data/docs/WorkflowPresetWidget.md +20 -0
- data/docs/WorkflowPublishResult.md +22 -0
- data/docs/WorkflowRemoved.md +18 -0
- data/docs/WorkflowResponse.md +22 -0
- data/docs/WorkflowSchedule.md +24 -0
- data/docs/WorkflowStats.md +34 -0
- data/docs/WorkflowStatus.md +15 -0
- data/docs/WorkflowTrigger.md +28 -0
- data/docs/WorkflowTriggerValuesInner.md +20 -0
- data/docs/WorkflowVersion.md +28 -0
- data/docs/WorkflowVersionDetail.md +32 -0
- data/docs/WorkflowVersionList.md +18 -0
- data/docs/WorkflowVersionPublishedBy.md +20 -0
- data/docs/WorkflowsApi.md +1527 -0
- data/lib/api-sdk-rb/api/brand_kit_api.rb +581 -0
- data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
- data/lib/api-sdk-rb/api/compositions_api.rb +993 -565
- data/lib/api-sdk-rb/api/credits_api.rb +20 -20
- data/lib/api-sdk-rb/api/entitlements_api.rb +14 -14
- data/lib/api-sdk-rb/api/invoices_api.rb +10 -10
- data/lib/api-sdk-rb/api/managed_users_api.rb +278 -172
- data/lib/api-sdk-rb/api/operations_api.rb +10 -10
- data/lib/api-sdk-rb/api/partners_api.rb +668 -352
- data/lib/api-sdk-rb/api/public_embed_api.rb +339 -62
- data/lib/api-sdk-rb/api/tokens_api.rb +8 -6
- data/lib/api-sdk-rb/api/uploads_api.rb +96 -96
- data/lib/api-sdk-rb/api/users_api.rb +213 -119
- data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
- data/lib/api-sdk-rb/api/workflows_api.rb +1775 -0
- data/lib/api-sdk-rb/configuration.rb +11 -23
- data/lib/api-sdk-rb/models/{get_user_adapter_connections200_response.rb → account_credit_transaction_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/adapter_connection.rb +48 -5
- data/lib/api-sdk-rb/models/{get_partner_credit_transactions200_response.rb → adapter_connection_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/adapter_connection_removal_response.rb +246 -0
- data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → adapter_connection_response.rb} +4 -4
- data/lib/api-sdk-rb/models/ai_answers_knowledge_document_response.rb +246 -0
- data/lib/api-sdk-rb/models/brand_color.rb +329 -0
- data/lib/api-sdk-rb/models/brand_font.rb +357 -0
- data/lib/api-sdk-rb/models/brand_kit_asset_view.rb +409 -0
- data/lib/api-sdk-rb/models/brand_kit_figma_source.rb +277 -0
- data/lib/api-sdk-rb/models/brand_kit_tokens.rb +335 -0
- data/lib/api-sdk-rb/models/brand_kit_tokens_fonts.rb +241 -0
- data/lib/api-sdk-rb/models/brand_kit_view.rb +344 -0
- data/lib/api-sdk-rb/models/brand_kit_view_owner.rb +267 -0
- data/lib/api-sdk-rb/models/brand_kit_view_response.rb +247 -0
- data/lib/api-sdk-rb/models/brand_spacing.rb +557 -0
- data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
- data/lib/api-sdk-rb/models/composition.rb +26 -5
- data/lib/api-sdk-rb/models/{create_composition_database_record201_response.rb → composition_database_record_response.rb} +3 -3
- data/lib/api-sdk-rb/models/composition_last_edited_by.rb +242 -0
- data/lib/api-sdk-rb/models/confirm_adapter_connection_request.rb +241 -0
- data/lib/api-sdk-rb/models/content_item_write_result_response.rb +246 -0
- data/lib/api-sdk-rb/models/create_widget201_response_data.rb +9 -20
- data/lib/api-sdk-rb/models/create_workspace_workflow_from_preset_request.rb +278 -0
- data/lib/api-sdk-rb/models/create_workspace_workflow_request.rb +271 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response.rb → delete_upload200_response.rb} +4 -5
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response_data.rb → delete_upload200_response_data.rb} +3 -3
- data/lib/api-sdk-rb/models/delete_workspace_workflow200_response.rb +246 -0
- data/lib/api-sdk-rb/models/design_defaults_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_operation_response.rb +247 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response_data.rb → get_operation_response_data.rb} +5 -8
- data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb +283 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response.rb +29 -2
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_adapters.rb +225 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_adapters_captcha.rb +216 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_entries.rb +224 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_media.rb +216 -0
- data/lib/api-sdk-rb/models/get_workspace_workflow_stats200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → get_workspace_workflow_version200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/list_partner_workflow_presets200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
- data/lib/api-sdk-rb/models/list_workspace_workflow_composition_options200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → list_workspace_workflow_presets200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → list_workspace_workflow_versions200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/list_workspace_workflows200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/new_composition.rb +1 -1
- data/lib/api-sdk-rb/models/new_editor_session.rb +1 -1
- data/lib/api-sdk-rb/models/offer_workflow_preset_request.rb +322 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset.rb +423 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset_list.rb +223 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset_widget.rb +251 -0
- data/lib/api-sdk-rb/models/partner_notification.rb +1 -1
- data/lib/api-sdk-rb/models/partner_notification_event_type.rb +5 -1
- data/lib/api-sdk-rb/models/patch_brand_kit_asset_request.rb +289 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +363 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request_fonts.rb +242 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request_spacing.rb +502 -0
- data/lib/api-sdk-rb/models/post_brand_kit_icon_request.rb +237 -0
- data/lib/api-sdk-rb/models/public_workflow.rb +351 -0
- data/lib/api-sdk-rb/models/public_workflow_events_accepted.rb +242 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request.rb +301 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +354 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_heights_inner.rb +267 -0
- data/lib/api-sdk-rb/models/public_workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/public_workflow_translation.rb +242 -0
- data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → publish_workspace_workflow200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/publish_workspace_workflow_request.rb +240 -0
- data/lib/api-sdk-rb/models/put_brand_kit_request.rb +239 -0
- data/lib/api-sdk-rb/models/{remove_user_adapter_connection200_response.rb → remove_partner_workflow_preset200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/report_public_workflow_events200_response.rb +246 -0
- data/lib/api-sdk-rb/models/save_workspace_workflow_request.rb +296 -0
- data/lib/api-sdk-rb/models/set_adapter_connection_request.rb +1 -1
- data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → set_partner_workflow_preset200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/update_composition.rb +1 -1
- data/lib/api-sdk-rb/models/upload.rb +1 -1
- data/lib/api-sdk-rb/models/upload_limits.rb +3 -3
- data/lib/api-sdk-rb/models/widget.rb +9 -20
- data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
- data/lib/api-sdk-rb/models/widget_clarification_option.rb +256 -0
- data/lib/api-sdk-rb/models/widget_clarification_question.rb +329 -0
- data/lib/api-sdk-rb/models/widget_next_step.rb +307 -0
- data/lib/api-sdk-rb/models/widget_plan.rb +306 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions.rb +346 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_adapters_inner.rb +237 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_libraries_inner.rb +255 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_responsive.rb +311 -0
- data/lib/api-sdk-rb/models/widget_plan_task.rb +320 -0
- data/lib/api-sdk-rb/models/workflow.rb +509 -0
- data/lib/api-sdk-rb/models/workflow_composition_action.rb +266 -0
- data/lib/api-sdk-rb/models/workflow_composition_field.rb +303 -0
- data/lib/api-sdk-rb/models/workflow_composition_option.rb +316 -0
- data/lib/api-sdk-rb/models/workflow_composition_option_actions.rb +284 -0
- data/lib/api-sdk-rb/models/workflow_composition_option_inputs.rb +304 -0
- data/lib/api-sdk-rb/models/workflow_composition_options.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_condition_case.rb +322 -0
- data/lib/api-sdk-rb/models/workflow_condition_test.rb +284 -0
- data/lib/api-sdk-rb/models/workflow_counter.rb +238 -0
- data/lib/api-sdk-rb/models/workflow_detail.rb +580 -0
- data/lib/api-sdk-rb/models/workflow_detail_all_of_last_edited_by.rb +242 -0
- data/lib/api-sdk-rb/models/workflow_detail_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_edge.rb +292 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason_counter.rb +277 -0
- data/lib/api-sdk-rb/models/workflow_field_reference.rb +300 -0
- data/lib/api-sdk-rb/models/workflow_graph.rb +330 -0
- data/lib/api-sdk-rb/models/workflow_issue.rb +309 -0
- data/lib/api-sdk-rb/models/workflow_list.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_node.rb +343 -0
- data/lib/api-sdk-rb/models/workflow_node_position.rb +238 -0
- data/lib/api-sdk-rb/models/workflow_preset_choice.rb +288 -0
- data/lib/api-sdk-rb/models/workflow_preset_choices.rb +224 -0
- data/lib/api-sdk-rb/models/workflow_preset_removal.rb +222 -0
- data/lib/api-sdk-rb/models/workflow_preset_widget.rb +234 -0
- data/lib/api-sdk-rb/models/workflow_publish_result.rb +256 -0
- data/lib/api-sdk-rb/models/workflow_removed.rb +221 -0
- data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_schedule.rb +298 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +347 -0
- data/lib/api-sdk-rb/models/workflow_status.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_trigger.rb +303 -0
- data/lib/api-sdk-rb/models/workflow_trigger_values_inner.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_version.rb +316 -0
- data/lib/api-sdk-rb/models/workflow_version_detail.rb +354 -0
- data/lib/api-sdk-rb/models/workflow_version_list.rb +224 -0
- data/lib/api-sdk-rb/models/workflow_version_published_by.rb +225 -0
- data/lib/api-sdk-rb/version.rb +1 -1
- data/lib/api-sdk-rb.rb +116 -17
- data/spec/api/brand_kit_api_spec.rb +136 -0
- data/spec/api/canvases_api_spec.rb +10 -10
- data/spec/api/compositions_api_spec.rb +227 -149
- data/spec/api/credits_api_spec.rb +5 -5
- data/spec/api/entitlements_api_spec.rb +4 -4
- data/spec/api/invoices_api_spec.rb +2 -2
- data/spec/api/managed_users_api_spec.rb +63 -42
- data/spec/api/operations_api_spec.rb +3 -3
- data/spec/api/partners_api_spec.rb +138 -84
- data/spec/api/public_embed_api_spec.rb +66 -15
- data/spec/api/tokens_api_spec.rb +3 -2
- data/spec/api/uploads_api_spec.rb +24 -24
- data/spec/api/users_api_spec.rb +43 -28
- data/spec/api/widgets_api_spec.rb +9 -9
- data/spec/api/workflows_api_spec.rb +339 -0
- data/spec/models/account_credit_transaction_list_response_spec.rb +48 -0
- data/spec/models/adapter_connection_list_response_spec.rb +48 -0
- data/spec/models/{get_managed_user_limits200_response_spec.rb → adapter_connection_removal_response_spec.rb} +6 -6
- data/spec/models/{delete_managed_user200_response_spec.rb → adapter_connection_response_spec.rb} +6 -6
- data/spec/models/adapter_connection_spec.rb +18 -0
- data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
- data/spec/models/brand_color_spec.rb +52 -0
- data/spec/models/brand_font_spec.rb +62 -0
- data/spec/models/brand_kit_asset_view_spec.rb +120 -0
- data/spec/models/brand_kit_figma_source_spec.rb +60 -0
- data/spec/models/brand_kit_tokens_fonts_spec.rb +54 -0
- data/spec/models/brand_kit_tokens_spec.rb +60 -0
- data/spec/models/brand_kit_view_owner_spec.rb +46 -0
- data/spec/models/{uploads_get200_response_spec.rb → brand_kit_view_response_spec.rb} +6 -6
- data/spec/models/brand_kit_view_spec.rb +90 -0
- data/spec/models/brand_spacing_spec.rb +78 -0
- data/spec/models/brand_text_style_spec.rb +52 -0
- data/spec/models/composition_database_record_response_spec.rb +48 -0
- data/spec/models/composition_last_edited_by_spec.rb +42 -0
- data/spec/models/composition_spec.rb +12 -0
- data/spec/models/confirm_adapter_connection_request_spec.rb +36 -0
- data/spec/models/content_item_write_result_response_spec.rb +48 -0
- data/spec/models/create_widget201_response_data_spec.rb +1 -7
- data/spec/models/create_workspace_workflow_from_preset_request_spec.rb +42 -0
- data/spec/models/create_workspace_workflow_request_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_data_spec.rb → delete_upload200_response_data_spec.rb} +6 -6
- data/spec/models/{operations_id_get_response_spec.rb → delete_upload200_response_spec.rb} +6 -6
- data/spec/models/delete_workspace_workflow200_response_spec.rb +48 -0
- data/spec/models/design_defaults_response_spec.rb +48 -0
- data/spec/models/editor_session_spec.rb +1 -1
- data/spec/models/get_operation_response_data_metadata_spec.rb +58 -0
- data/spec/models/{operations_id_get_response_data_spec.rb → get_operation_response_data_spec.rb} +6 -6
- data/spec/models/get_operation_response_spec.rb +48 -0
- data/spec/models/get_public_composition_embed200_response_adapters_captcha_spec.rb +36 -0
- data/spec/models/get_public_composition_embed200_response_adapters_spec.rb +42 -0
- data/spec/models/get_public_composition_embed200_response_entries_spec.rb +42 -0
- data/spec/models/get_public_composition_embed200_response_media_spec.rb +36 -0
- data/spec/models/get_public_composition_embed200_response_spec.rb +18 -0
- data/spec/models/{get_user_adapter_connections200_response_spec.rb → get_workspace_workflow_stats200_response_spec.rb} +6 -6
- data/spec/models/{remove_user_adapter_connection200_response_spec.rb → get_workspace_workflow_version200_response_spec.rb} +6 -6
- data/spec/models/list_partner_workflow_presets200_response_spec.rb +48 -0
- data/spec/models/list_uploads200_response_spec.rb +48 -0
- data/spec/models/{create_composition_database_record201_response_spec.rb → list_workspace_workflow_composition_options200_response_spec.rb} +6 -6
- data/spec/models/{get_partner_credit_transactions200_response_spec.rb → list_workspace_workflow_presets200_response_spec.rb} +6 -6
- data/spec/models/{add_ai_answers_knowledge_document201_response_spec.rb → list_workspace_workflow_versions200_response_spec.rb} +6 -6
- data/spec/models/list_workspace_workflows200_response_spec.rb +48 -0
- data/spec/models/managed_user_limits_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_spec.rb → managed_user_removal_response_spec.rb} +6 -6
- data/spec/models/new_editor_session_spec.rb +1 -1
- data/spec/models/offer_workflow_preset_request_spec.rb +54 -0
- data/spec/models/offered_workflow_preset_list_spec.rb +36 -0
- data/spec/models/offered_workflow_preset_spec.rb +106 -0
- data/spec/models/offered_workflow_preset_widget_spec.rb +48 -0
- data/spec/models/patch_brand_kit_asset_request_spec.rb +62 -0
- data/spec/models/patch_brand_kit_request_fonts_spec.rb +54 -0
- data/spec/models/patch_brand_kit_request_spacing_spec.rb +78 -0
- data/spec/models/patch_brand_kit_request_spec.rb +72 -0
- data/spec/models/post_brand_kit_icon_request_spec.rb +42 -0
- data/spec/models/public_workflow_events_accepted_spec.rb +48 -0
- data/spec/models/public_workflow_events_request_events_inner_spec.rb +62 -0
- data/spec/models/public_workflow_events_request_heights_inner_spec.rb +42 -0
- data/spec/models/public_workflow_events_request_spec.rb +54 -0
- data/spec/models/public_workflow_response_spec.rb +48 -0
- data/spec/models/public_workflow_spec.rb +94 -0
- data/spec/models/public_workflow_translation_spec.rb +42 -0
- data/spec/models/{get_partner_design_defaults200_response_spec.rb → publish_workspace_workflow200_response_spec.rb} +6 -6
- data/spec/models/publish_workspace_workflow_request_spec.rb +36 -0
- data/spec/models/put_brand_kit_request_spec.rb +48 -0
- data/spec/models/{create_composition_from_widget201_response_spec.rb → remove_partner_workflow_preset200_response_spec.rb} +6 -6
- data/spec/models/report_public_workflow_events200_response_spec.rb +48 -0
- data/spec/models/save_workspace_workflow_request_spec.rb +54 -0
- data/spec/models/{set_user_adapter_connection200_response_spec.rb → set_partner_workflow_preset200_response_spec.rb} +6 -6
- data/spec/models/widget_clarification_option_spec.rb +48 -0
- data/spec/models/widget_clarification_question_spec.rb +60 -0
- data/spec/models/widget_clarification_spec.rb +48 -0
- data/spec/models/widget_next_step_spec.rb +58 -0
- data/spec/models/widget_plan_decisions_adapters_inner_spec.rb +42 -0
- data/spec/models/widget_plan_decisions_libraries_inner_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_responsive_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_spec.rb +78 -0
- data/spec/models/widget_plan_spec.rb +60 -0
- data/spec/models/widget_plan_task_spec.rb +62 -0
- data/spec/models/widget_spec.rb +1 -7
- data/spec/models/workflow_composition_action_spec.rb +54 -0
- data/spec/models/workflow_composition_field_spec.rb +58 -0
- data/spec/models/workflow_composition_option_actions_spec.rb +52 -0
- data/spec/models/workflow_composition_option_inputs_spec.rb +58 -0
- data/spec/models/workflow_composition_option_spec.rb +72 -0
- data/spec/models/workflow_composition_options_spec.rb +54 -0
- data/spec/models/workflow_condition_case_spec.rb +58 -0
- data/spec/models/workflow_condition_test_spec.rb +52 -0
- data/spec/models/workflow_counter_spec.rb +42 -0
- data/spec/models/workflow_detail_all_of_last_edited_by_spec.rb +42 -0
- data/spec/models/workflow_detail_response_spec.rb +48 -0
- data/spec/models/workflow_detail_spec.rb +162 -0
- data/spec/models/workflow_edge_spec.rb +54 -0
- data/spec/models/workflow_failure_reason_counter_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_spec.rb +30 -0
- data/spec/models/workflow_field_reference_spec.rb +56 -0
- data/spec/models/workflow_graph_spec.rb +52 -0
- data/spec/models/workflow_issue_spec.rb +70 -0
- data/spec/models/{create_composition_content_item201_response_spec.rb → workflow_list_spec.rb} +15 -9
- data/spec/models/workflow_node_position_spec.rb +42 -0
- data/spec/models/workflow_node_spec.rb +76 -0
- data/spec/models/workflow_preset_choice_spec.rb +60 -0
- data/spec/models/workflow_preset_choices_spec.rb +36 -0
- data/spec/models/workflow_preset_removal_spec.rb +36 -0
- data/spec/models/workflow_preset_widget_spec.rb +42 -0
- data/spec/models/workflow_publish_result_spec.rb +48 -0
- data/spec/models/workflow_removed_spec.rb +36 -0
- data/spec/models/workflow_response_spec.rb +48 -0
- data/spec/models/workflow_schedule_spec.rb +62 -0
- data/spec/models/workflow_spec.rb +132 -0
- data/spec/models/workflow_stats_spec.rb +84 -0
- data/spec/models/workflow_status_spec.rb +30 -0
- data/spec/models/workflow_trigger_spec.rb +70 -0
- data/spec/models/workflow_trigger_values_inner_spec.rb +46 -0
- data/spec/models/workflow_version_detail_spec.rb +78 -0
- data/spec/models/workflow_version_list_spec.rb +36 -0
- data/spec/models/workflow_version_published_by_spec.rb +42 -0
- data/spec/models/workflow_version_spec.rb +66 -0
- metadata +476 -80
- data/docs/PartnerApi.md +0 -9892
- data/docs/UploadsIdDelete200Response.md +0 -22
- data/lib/api-sdk-rb/api/partner_api.rb +0 -10693
- data/spec/api/partner_api_spec.rb +0 -1895
data/docs/CompositionsApi.md
CHANGED
|
@@ -4,50 +4,54 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
15
|
-
| [**
|
|
16
|
-
| [**
|
|
17
|
-
| [**
|
|
18
|
-
| [**
|
|
19
|
-
| [**
|
|
20
|
-
| [**
|
|
21
|
-
| [**
|
|
22
|
-
| [**
|
|
23
|
-
| [**
|
|
24
|
-
| [**
|
|
25
|
-
| [**
|
|
26
|
-
| [**
|
|
27
|
-
| [**
|
|
28
|
-
| [**
|
|
29
|
-
| [**
|
|
30
|
-
| [**
|
|
31
|
-
| [**
|
|
32
|
-
| [**
|
|
33
|
-
| [**
|
|
34
|
-
| [**
|
|
35
|
-
| [**
|
|
36
|
-
| [**
|
|
37
|
-
| [**
|
|
38
|
-
| [**
|
|
39
|
-
| [**
|
|
40
|
-
| [**
|
|
41
|
-
| [**
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
7
|
+
| [**add_ai_answers_knowledge_document**](CompositionsApi.md#add_ai_answers_knowledge_document) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents | Add a document for a widget's AI to answer from |
|
|
8
|
+
| [**add_ai_answers_knowledge_file**](CompositionsApi.md#add_ai_answers_knowledge_file) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents/file | Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from |
|
|
9
|
+
| [**check_composition_access**](CompositionsApi.md#check_composition_access) | **GET** /compositions/{id}/access | Check Composition Access |
|
|
10
|
+
| [**create_composition**](CompositionsApi.md#create_composition) | **POST** /compositions | Create Composition |
|
|
11
|
+
| [**create_composition_content_item**](CompositionsApi.md#create_composition_content_item) | **POST** /compositions/{id}/content/{list}/items | Add a content list item |
|
|
12
|
+
| [**create_composition_database_record**](CompositionsApi.md#create_composition_database_record) | **POST** /compositions/{id}/database/{table} | Create Record In Composition Database |
|
|
13
|
+
| [**delete_composition**](CompositionsApi.md#delete_composition) | **DELETE** /compositions/{id} | Delete Composition |
|
|
14
|
+
| [**delete_composition_content_item**](CompositionsApi.md#delete_composition_content_item) | **DELETE** /compositions/{id}/content/{list}/items/{itemId} | Delete a content list item |
|
|
15
|
+
| [**delete_composition_data_source**](CompositionsApi.md#delete_composition_data_source) | **DELETE** /compositions/{id}/data-source | Remove the composition data source binding |
|
|
16
|
+
| [**delete_composition_database_record**](CompositionsApi.md#delete_composition_database_record) | **DELETE** /compositions/{id}/database/{table}/{recordId} | Delete Record From Composition Database |
|
|
17
|
+
| [**delete_composition_entry_items**](CompositionsApi.md#delete_composition_entry_items) | **DELETE** /compositions/{id}/entries/{table}/items | Delete composition entry items by id or host context |
|
|
18
|
+
| [**describe_composition_entries**](CompositionsApi.md#describe_composition_entries) | **GET** /compositions/{id}/entries | Describe What a Composition Keeps |
|
|
19
|
+
| [**duplicate_composition**](CompositionsApi.md#duplicate_composition) | **POST** /compositions/{id}/duplicate | Duplicate Composition |
|
|
20
|
+
| [**export_composition_entry_items**](CompositionsApi.md#export_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/export | Export composition entry items |
|
|
21
|
+
| [**get_ai_answers_knowledge**](CompositionsApi.md#get_ai_answers_knowledge) | **GET** /compositions/{id}/adapters/ai-answers/knowledge | See the documents a widget's AI answers from |
|
|
22
|
+
| [**get_all_compositions**](CompositionsApi.md#get_all_compositions) | **GET** /compositions | Get All Compositions |
|
|
23
|
+
| [**get_composition_by_id**](CompositionsApi.md#get_composition_by_id) | **GET** /compositions/{id} | Get Composition |
|
|
24
|
+
| [**get_composition_content**](CompositionsApi.md#get_composition_content) | **GET** /compositions/{id}/content | Get Current Content |
|
|
25
|
+
| [**get_composition_content_schema**](CompositionsApi.md#get_composition_content_schema) | **GET** /compositions/{id}/schema/content | Get Content Schema |
|
|
26
|
+
| [**get_composition_data_source**](CompositionsApi.md#get_composition_data_source) | **GET** /compositions/{id}/data-source | Read the composition data source binding |
|
|
27
|
+
| [**get_composition_database_record**](CompositionsApi.md#get_composition_database_record) | **GET** /compositions/{id}/database/{table}/{recordId} | Get Record From Composition Database |
|
|
28
|
+
| [**get_composition_database_records**](CompositionsApi.md#get_composition_database_records) | **GET** /compositions/{id}/database/{table} | Get All Records From Composition Database Table |
|
|
29
|
+
| [**get_composition_design**](CompositionsApi.md#get_composition_design) | **GET** /compositions/{id}/design | Get Composition Design |
|
|
30
|
+
| [**get_composition_design_schema**](CompositionsApi.md#get_composition_design_schema) | **GET** /compositions/{id}/schema/design | Get Design Schema |
|
|
31
|
+
| [**get_composition_embed_schema**](CompositionsApi.md#get_composition_embed_schema) | **GET** /compositions/{id}/schema/embed | Get Embed Schema |
|
|
32
|
+
| [**get_composition_embed_settings**](CompositionsApi.md#get_composition_embed_settings) | **GET** /compositions/{id}/embed-settings | Get Composition Embed Settings |
|
|
33
|
+
| [**get_composition_preview**](CompositionsApi.md#get_composition_preview) | **GET** /compositions/{id}/preview | Get Composition Preview |
|
|
34
|
+
| [**get_composition_versions**](CompositionsApi.md#get_composition_versions) | **GET** /compositions/{id}/versions | Get Composition Versions |
|
|
35
|
+
| [**get_compositions_batch**](CompositionsApi.md#get_compositions_batch) | **POST** /compositions/batch | Get Compositions Batch |
|
|
36
|
+
| [**list_composition_entry_items**](CompositionsApi.md#list_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/items | List composition entry items with paging and filters |
|
|
37
|
+
| [**patch_composition_content_item**](CompositionsApi.md#patch_composition_content_item) | **PATCH** /compositions/{id}/content/{list}/items/{itemId} | Update a content list item |
|
|
38
|
+
| [**read_composition_entries**](CompositionsApi.md#read_composition_entries) | **GET** /compositions/{id}/entries/{table} | Read the Entries of a Composition's Table |
|
|
39
|
+
| [**remove_ai_answers_knowledge_document**](CompositionsApi.md#remove_ai_answers_knowledge_document) | **DELETE** /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId} | Remove a document from a widget's knowledge base |
|
|
40
|
+
| [**set_composition_data_source**](CompositionsApi.md#set_composition_data_source) | **PUT** /compositions/{id}/data-source | Bind a public JSON data source for embed refresh |
|
|
41
|
+
| [**set_dynamic_content**](CompositionsApi.md#set_dynamic_content) | **PUT** /compositions/{id}/content | Set Dynamic Content |
|
|
42
|
+
| [**update_composition**](CompositionsApi.md#update_composition) | **PUT** /compositions/{id} | Update Composition |
|
|
43
|
+
| [**update_composition_database_record**](CompositionsApi.md#update_composition_database_record) | **PUT** /compositions/{id}/database/{table}/{recordId} | Update Record In Composition Database |
|
|
44
|
+
| [**update_composition_status**](CompositionsApi.md#update_composition_status) | **PUT** /compositions/{id}/status | Update Composition Status |
|
|
45
|
+
| [**validate_composition_content**](CompositionsApi.md#validate_composition_content) | **POST** /compositions/{id}/content/validate | Validate Content |
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
## add_ai_answers_knowledge_document
|
|
49
|
+
|
|
50
|
+
> <AiAnswersKnowledgeDocumentResponse> add_ai_answers_knowledge_document(id, add_ai_answers_knowledge_document_request, opts)
|
|
47
51
|
|
|
48
52
|
Add a document for a widget's AI to answer from
|
|
49
53
|
|
|
50
|
-
Gives the widget's AI a document to answer visitors' questions from. Send the title and the plain text. The call returns once the document is ready to be used, which takes a few seconds, longer for a long text. **How it is used.** The text is cleaned, cut into short passages and each passage is turned into numbers (an embedding) so the widget can find the passages nearest to a question. When a visitor asks, the nearest passages and the question are shown to an AI model, which writes the answer from them and from nothing else; if the documents say nothing about the question the visitor is told so, and the owner is not charged for that question. The titles of the documents an answer used are shown to the visitor as its sources. **What leaves Widgetic.** The text of a document is sent to OpenAI to be embedded when it is added, and the passages used for a question are sent to the AI model that writes the answer. Say so in your privacy policy. **Treat every document as public.** An answer can quote or paraphrase anything a document says, to any visitor of the widget. Do not add passwords, keys, personal data or anything that must stay private. **Limits.** A widget holds up to 20 documents, each up to 100000 characters, and up to 400000 characters in all (`getAiAnswersKnowledge` reports the current numbers).
|
|
54
|
+
Gives the widget's AI a document to answer visitors' questions from. Send the title and the plain text. The call returns once the document is ready to be used, which takes a few seconds, longer for a long text. **How it is used.** The text is cleaned, cut into short passages and each passage is turned into numbers (an embedding) so the widget can find the passages nearest to a question. When a visitor asks, the nearest passages and the question are shown to an AI model, which writes the answer from them and from nothing else; if the documents say nothing about the question the visitor is told so, and the owner is not charged for that question. The titles of the documents an answer used are shown to the visitor as its sources. **What leaves Widgetic.** The text of a document is sent to OpenAI to be embedded when it is added, and the passages used for a question are sent to the AI model that writes the answer. Say so in your privacy policy. **Treat every document as public.** An answer can quote or paraphrase anything a document says, to any visitor of the widget. Do not add passwords, keys, personal data or anything that must stay private. **Limits.** A widget holds up to 20 documents, each up to 100000 characters, and up to 400000 characters in all (`getAiAnswersKnowledge` reports the current numbers). This call takes text. To add a text file or a picture of a document (a PDF too, once PDFs are read) without turning it into text yourself, use `addAiAnswersKnowledgeFile`. Adding a document costs no credits. The same text cannot be added twice to one widget (409). The caller must be allowed to change the widget. An API key needs the `content:write` scope. Adds are limited to ten in ten minutes per person. A partner's customer in an editor session is one person of its own: its adds are not counted with the partner's other customers'.
|
|
51
55
|
|
|
52
56
|
### Examples
|
|
53
57
|
|
|
@@ -64,34 +68,34 @@ api_instance = ApiSdkRb::CompositionsApi.new
|
|
|
64
68
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The widget (composition) to add the document to
|
|
65
69
|
add_ai_answers_knowledge_document_request = ApiSdkRb::AddAiAnswersKnowledgeDocumentRequest.new({title: 'Shipping and returns', text: 'Orders ship within 2 business days. Returns are accepted for 30 days after delivery, in the original packaging.'}) # AddAiAnswersKnowledgeDocumentRequest |
|
|
66
70
|
opts = {
|
|
67
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
68
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
71
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
72
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
69
73
|
}
|
|
70
74
|
|
|
71
75
|
begin
|
|
72
76
|
# Add a document for a widget's AI to answer from
|
|
73
|
-
result = api_instance.
|
|
77
|
+
result = api_instance.add_ai_answers_knowledge_document(id, add_ai_answers_knowledge_document_request, opts)
|
|
74
78
|
p result
|
|
75
79
|
rescue ApiSdkRb::ApiError => e
|
|
76
|
-
puts "Error when calling CompositionsApi->
|
|
80
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_document: #{e}"
|
|
77
81
|
end
|
|
78
82
|
```
|
|
79
83
|
|
|
80
|
-
#### Using the
|
|
84
|
+
#### Using the add_ai_answers_knowledge_document_with_http_info variant
|
|
81
85
|
|
|
82
86
|
This returns an Array which contains the response data, status code and headers.
|
|
83
87
|
|
|
84
|
-
> <Array(<
|
|
88
|
+
> <Array(<AiAnswersKnowledgeDocumentResponse>, Integer, Hash)> add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts)
|
|
85
89
|
|
|
86
90
|
```ruby
|
|
87
91
|
begin
|
|
88
92
|
# Add a document for a widget's AI to answer from
|
|
89
|
-
data, status_code, headers = api_instance.
|
|
93
|
+
data, status_code, headers = api_instance.add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts)
|
|
90
94
|
p status_code # => 2xx
|
|
91
95
|
p headers # => { ... }
|
|
92
|
-
p data # => <
|
|
96
|
+
p data # => <AiAnswersKnowledgeDocumentResponse>
|
|
93
97
|
rescue ApiSdkRb::ApiError => e
|
|
94
|
-
puts "Error when calling CompositionsApi->
|
|
98
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_document_with_http_info: #{e}"
|
|
95
99
|
end
|
|
96
100
|
```
|
|
97
101
|
|
|
@@ -101,12 +105,12 @@ end
|
|
|
101
105
|
| ---- | ---- | ----------- | ----- |
|
|
102
106
|
| **id** | **String** | The widget (composition) to add the document to | |
|
|
103
107
|
| **add_ai_answers_knowledge_document_request** | [**AddAiAnswersKnowledgeDocumentRequest**](AddAiAnswersKnowledgeDocumentRequest.md) | | |
|
|
104
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
105
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
108
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
109
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
106
110
|
|
|
107
111
|
### Return type
|
|
108
112
|
|
|
109
|
-
[**
|
|
113
|
+
[**AiAnswersKnowledgeDocumentResponse**](AiAnswersKnowledgeDocumentResponse.md)
|
|
110
114
|
|
|
111
115
|
### Authorization
|
|
112
116
|
|
|
@@ -118,9 +122,88 @@ end
|
|
|
118
122
|
- **Accept**: application/json
|
|
119
123
|
|
|
120
124
|
|
|
121
|
-
##
|
|
125
|
+
## add_ai_answers_knowledge_file
|
|
122
126
|
|
|
123
|
-
> <
|
|
127
|
+
> <AiAnswersKnowledgeDocumentResponse> add_ai_answers_knowledge_file(id, file, opts)
|
|
128
|
+
|
|
129
|
+
Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
130
|
+
|
|
131
|
+
Gives the widget's AI a document made from a file. Send a `multipart/form-data` request with the file in the field named `file` and, if you like, a `title`. The file is turned into text and then added exactly as `addAiAnswersKnowledgeDocument` adds text: the same cleaning, the same limits, the same refusal of a copy of a document the widget already has. The call returns once the document is ready to be used, which takes a few seconds (a PDF is read first, so it takes longer). **PDFs are not read yet.** For now a PDF is refused with 415, in a sentence that says what to do instead: paste the text, upload it as a text file, or upload its pages as pictures. What this description says about a PDF is what will hold from the day PDFs are read. **Which files.** - A **PDF** (not read yet, see above), up to 10 MB and 300 pages. Its text is read and its paragraphs are put back together. A PDF that is only pictures of pages (a scan) has no text to read: upload the pages as pictures instead. A PDF locked with a password is refused. - A **text file**: `.txt`, `.text`, `.md`, `.markdown` or `.csv`, in UTF-8, UTF-16 or Windows-1252. - A **picture of a document**: PNG, JPEG or WebP, up to 4 MB. The text in it is read with the same text recognition as the `ocr` adapter. - Word and other office files are not read yet: save the file as a PDF and upload that. What a file is comes from what is in it, not from its name or the type it is sent as. A file that is none of these is refused with 415. **The title.** Left out, the name of the file (without its extension) is the title. Visitors see the title as the source of an answer, so send one that means something to them. **The file is not kept.** Only its text, cut into passages, is kept, and `getAiAnswersKnowledge` never returns it. **What leaves Widgetic.** As for text, the words of the document are sent to OpenAI to be embedded when it is added, and the passages used for a question are sent to the AI model that writes the answer. A picture is also sent to the text recognition service. A PDF is read on Widgetic's own servers and is not sent anywhere to be read. Say so in your privacy policy. **Treat every document as public.** An answer can quote or paraphrase anything a document says, to any visitor of the widget. Do not add passwords, keys, personal data or anything that must stay private. **Limits.** The widget's limits are those of `addAiAnswersKnowledgeDocument` (up to 20 documents, each up to 100000 characters of text, and up to 400000 characters in all; `getAiAnswersKnowledge` reports the current numbers), and the file is at most 10 MB. Adding a document costs no credits. The same text cannot be added twice to one widget (409). The caller must be allowed to change the widget. An API key needs the `content:write` scope. Adds, from text or from a file, share one limit of ten in ten minutes per person. A partner's customer in an editor session is one person of its own: its adds are not counted with the partner's other customers'.
|
|
132
|
+
|
|
133
|
+
### Examples
|
|
134
|
+
|
|
135
|
+
```ruby
|
|
136
|
+
require 'time'
|
|
137
|
+
require 'api-sdk-rb'
|
|
138
|
+
# setup authorization
|
|
139
|
+
ApiSdkRb.configure do |config|
|
|
140
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
141
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
api_instance = ApiSdkRb::CompositionsApi.new
|
|
145
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The widget (composition) to add the document to
|
|
146
|
+
file = File.new('/path/to/some/file') # File | The file, which is a text file or a picture of a document (a PDF is not read yet). One file only
|
|
147
|
+
opts = {
|
|
148
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
149
|
+
x_managed_user_external_id: 'customer-1042', # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
150
|
+
title: 'title_example' # String | What the document is called, on one line. Visitors see it as the source of an answer. Left out, the name of the file stands in for it
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
begin
|
|
154
|
+
# Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
155
|
+
result = api_instance.add_ai_answers_knowledge_file(id, file, opts)
|
|
156
|
+
p result
|
|
157
|
+
rescue ApiSdkRb::ApiError => e
|
|
158
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_file: #{e}"
|
|
159
|
+
end
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
#### Using the add_ai_answers_knowledge_file_with_http_info variant
|
|
163
|
+
|
|
164
|
+
This returns an Array which contains the response data, status code and headers.
|
|
165
|
+
|
|
166
|
+
> <Array(<AiAnswersKnowledgeDocumentResponse>, Integer, Hash)> add_ai_answers_knowledge_file_with_http_info(id, file, opts)
|
|
167
|
+
|
|
168
|
+
```ruby
|
|
169
|
+
begin
|
|
170
|
+
# Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
171
|
+
data, status_code, headers = api_instance.add_ai_answers_knowledge_file_with_http_info(id, file, opts)
|
|
172
|
+
p status_code # => 2xx
|
|
173
|
+
p headers # => { ... }
|
|
174
|
+
p data # => <AiAnswersKnowledgeDocumentResponse>
|
|
175
|
+
rescue ApiSdkRb::ApiError => e
|
|
176
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_file_with_http_info: #{e}"
|
|
177
|
+
end
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Parameters
|
|
181
|
+
|
|
182
|
+
| Name | Type | Description | Notes |
|
|
183
|
+
| ---- | ---- | ----------- | ----- |
|
|
184
|
+
| **id** | **String** | The widget (composition) to add the document to | |
|
|
185
|
+
| **file** | **File** | The file, which is a text file or a picture of a document (a PDF is not read yet). One file only | |
|
|
186
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
187
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
188
|
+
| **title** | **String** | What the document is called, on one line. Visitors see it as the source of an answer. Left out, the name of the file stands in for it | [optional] |
|
|
189
|
+
|
|
190
|
+
### Return type
|
|
191
|
+
|
|
192
|
+
[**AiAnswersKnowledgeDocumentResponse**](AiAnswersKnowledgeDocumentResponse.md)
|
|
193
|
+
|
|
194
|
+
### Authorization
|
|
195
|
+
|
|
196
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
197
|
+
|
|
198
|
+
### HTTP request headers
|
|
199
|
+
|
|
200
|
+
- **Content-Type**: multipart/form-data
|
|
201
|
+
- **Accept**: application/json
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
## check_composition_access
|
|
205
|
+
|
|
206
|
+
> <CheckCompositionAccessResponse> check_composition_access(id)
|
|
124
207
|
|
|
125
208
|
Check Composition Access
|
|
126
209
|
|
|
@@ -142,28 +225,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Composition ID
|
|
|
142
225
|
|
|
143
226
|
begin
|
|
144
227
|
# Check Composition Access
|
|
145
|
-
result = api_instance.
|
|
228
|
+
result = api_instance.check_composition_access(id)
|
|
146
229
|
p result
|
|
147
230
|
rescue ApiSdkRb::ApiError => e
|
|
148
|
-
puts "Error when calling CompositionsApi->
|
|
231
|
+
puts "Error when calling CompositionsApi->check_composition_access: #{e}"
|
|
149
232
|
end
|
|
150
233
|
```
|
|
151
234
|
|
|
152
|
-
#### Using the
|
|
235
|
+
#### Using the check_composition_access_with_http_info variant
|
|
153
236
|
|
|
154
237
|
This returns an Array which contains the response data, status code and headers.
|
|
155
238
|
|
|
156
|
-
> <Array(<CheckCompositionAccessResponse>, Integer, Hash)>
|
|
239
|
+
> <Array(<CheckCompositionAccessResponse>, Integer, Hash)> check_composition_access_with_http_info(id)
|
|
157
240
|
|
|
158
241
|
```ruby
|
|
159
242
|
begin
|
|
160
243
|
# Check Composition Access
|
|
161
|
-
data, status_code, headers = api_instance.
|
|
244
|
+
data, status_code, headers = api_instance.check_composition_access_with_http_info(id)
|
|
162
245
|
p status_code # => 2xx
|
|
163
246
|
p headers # => { ... }
|
|
164
247
|
p data # => <CheckCompositionAccessResponse>
|
|
165
248
|
rescue ApiSdkRb::ApiError => e
|
|
166
|
-
puts "Error when calling CompositionsApi->
|
|
249
|
+
puts "Error when calling CompositionsApi->check_composition_access_with_http_info: #{e}"
|
|
167
250
|
end
|
|
168
251
|
```
|
|
169
252
|
|
|
@@ -187,9 +270,9 @@ end
|
|
|
187
270
|
- **Accept**: application/json
|
|
188
271
|
|
|
189
272
|
|
|
190
|
-
##
|
|
273
|
+
## create_composition
|
|
191
274
|
|
|
192
|
-
> <
|
|
275
|
+
> <CompositionResponse> create_composition(idempotency_key, new_composition, opts)
|
|
193
276
|
|
|
194
277
|
Create Composition
|
|
195
278
|
|
|
@@ -210,34 +293,34 @@ api_instance = ApiSdkRb::CompositionsApi.new
|
|
|
210
293
|
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`).
|
|
211
294
|
new_composition = ApiSdkRb::NewComposition.new({name: 'My New Composition', widget_id: '123e4567-e89b-12d3-a456-426614174002'}) # NewComposition |
|
|
212
295
|
opts = {
|
|
213
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
214
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
296
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
297
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
215
298
|
}
|
|
216
299
|
|
|
217
300
|
begin
|
|
218
301
|
# Create Composition
|
|
219
|
-
result = api_instance.
|
|
302
|
+
result = api_instance.create_composition(idempotency_key, new_composition, opts)
|
|
220
303
|
p result
|
|
221
304
|
rescue ApiSdkRb::ApiError => e
|
|
222
|
-
puts "Error when calling CompositionsApi->
|
|
305
|
+
puts "Error when calling CompositionsApi->create_composition: #{e}"
|
|
223
306
|
end
|
|
224
307
|
```
|
|
225
308
|
|
|
226
|
-
#### Using the
|
|
309
|
+
#### Using the create_composition_with_http_info variant
|
|
227
310
|
|
|
228
311
|
This returns an Array which contains the response data, status code and headers.
|
|
229
312
|
|
|
230
|
-
> <Array(<
|
|
313
|
+
> <Array(<CompositionResponse>, Integer, Hash)> create_composition_with_http_info(idempotency_key, new_composition, opts)
|
|
231
314
|
|
|
232
315
|
```ruby
|
|
233
316
|
begin
|
|
234
317
|
# Create Composition
|
|
235
|
-
data, status_code, headers = api_instance.
|
|
318
|
+
data, status_code, headers = api_instance.create_composition_with_http_info(idempotency_key, new_composition, opts)
|
|
236
319
|
p status_code # => 2xx
|
|
237
320
|
p headers # => { ... }
|
|
238
|
-
p data # => <
|
|
321
|
+
p data # => <CompositionResponse>
|
|
239
322
|
rescue ApiSdkRb::ApiError => e
|
|
240
|
-
puts "Error when calling CompositionsApi->
|
|
323
|
+
puts "Error when calling CompositionsApi->create_composition_with_http_info: #{e}"
|
|
241
324
|
end
|
|
242
325
|
```
|
|
243
326
|
|
|
@@ -247,12 +330,12 @@ end
|
|
|
247
330
|
| ---- | ---- | ----------- | ----- |
|
|
248
331
|
| **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`). | |
|
|
249
332
|
| **new_composition** | [**NewComposition**](NewComposition.md) | | |
|
|
250
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
251
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
333
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
334
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
252
335
|
|
|
253
336
|
### Return type
|
|
254
337
|
|
|
255
|
-
[**
|
|
338
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
256
339
|
|
|
257
340
|
### Authorization
|
|
258
341
|
|
|
@@ -264,9 +347,9 @@ end
|
|
|
264
347
|
- **Accept**: application/json
|
|
265
348
|
|
|
266
349
|
|
|
267
|
-
##
|
|
350
|
+
## create_composition_content_item
|
|
268
351
|
|
|
269
|
-
> <
|
|
352
|
+
> <ContentItemWriteResultResponse> create_composition_content_item(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
270
353
|
|
|
271
354
|
Add a content list item
|
|
272
355
|
|
|
@@ -290,34 +373,34 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
290
373
|
create_composition_content_item_request = ApiSdkRb::CreateCompositionContentItemRequest.new # CreateCompositionContentItemRequest |
|
|
291
374
|
opts = {
|
|
292
375
|
if_match: 'if_match_example', # String | Optional content version from ETag
|
|
293
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
294
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
376
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
377
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
295
378
|
}
|
|
296
379
|
|
|
297
380
|
begin
|
|
298
381
|
# Add a content list item
|
|
299
|
-
result = api_instance.
|
|
382
|
+
result = api_instance.create_composition_content_item(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
300
383
|
p result
|
|
301
384
|
rescue ApiSdkRb::ApiError => e
|
|
302
|
-
puts "Error when calling CompositionsApi->
|
|
385
|
+
puts "Error when calling CompositionsApi->create_composition_content_item: #{e}"
|
|
303
386
|
end
|
|
304
387
|
```
|
|
305
388
|
|
|
306
|
-
#### Using the
|
|
389
|
+
#### Using the create_composition_content_item_with_http_info variant
|
|
307
390
|
|
|
308
391
|
This returns an Array which contains the response data, status code and headers.
|
|
309
392
|
|
|
310
|
-
> <Array(<
|
|
393
|
+
> <Array(<ContentItemWriteResultResponse>, Integer, Hash)> create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
311
394
|
|
|
312
395
|
```ruby
|
|
313
396
|
begin
|
|
314
397
|
# Add a content list item
|
|
315
|
-
data, status_code, headers = api_instance.
|
|
398
|
+
data, status_code, headers = api_instance.create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
316
399
|
p status_code # => 2xx
|
|
317
400
|
p headers # => { ... }
|
|
318
|
-
p data # => <
|
|
401
|
+
p data # => <ContentItemWriteResultResponse>
|
|
319
402
|
rescue ApiSdkRb::ApiError => e
|
|
320
|
-
puts "Error when calling CompositionsApi->
|
|
403
|
+
puts "Error when calling CompositionsApi->create_composition_content_item_with_http_info: #{e}"
|
|
321
404
|
end
|
|
322
405
|
```
|
|
323
406
|
|
|
@@ -330,12 +413,12 @@ end
|
|
|
330
413
|
| **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`). | |
|
|
331
414
|
| **create_composition_content_item_request** | [**CreateCompositionContentItemRequest**](CreateCompositionContentItemRequest.md) | | |
|
|
332
415
|
| **if_match** | **String** | Optional content version from ETag | [optional] |
|
|
333
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
334
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
416
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
417
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
335
418
|
|
|
336
419
|
### Return type
|
|
337
420
|
|
|
338
|
-
[**
|
|
421
|
+
[**ContentItemWriteResultResponse**](ContentItemWriteResultResponse.md)
|
|
339
422
|
|
|
340
423
|
### Authorization
|
|
341
424
|
|
|
@@ -347,9 +430,9 @@ end
|
|
|
347
430
|
- **Accept**: application/json
|
|
348
431
|
|
|
349
432
|
|
|
350
|
-
##
|
|
433
|
+
## create_composition_database_record
|
|
351
434
|
|
|
352
|
-
> <
|
|
435
|
+
> <CompositionDatabaseRecordResponse> create_composition_database_record(id, table, idempotency_key, body, opts)
|
|
353
436
|
|
|
354
437
|
Create Record In Composition Database
|
|
355
438
|
|
|
@@ -372,34 +455,34 @@ table = 'table_example' # String | Name of the database table
|
|
|
372
455
|
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`).
|
|
373
456
|
body = { ... } # Object |
|
|
374
457
|
opts = {
|
|
375
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
376
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
458
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
459
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
377
460
|
}
|
|
378
461
|
|
|
379
462
|
begin
|
|
380
463
|
# Create Record In Composition Database
|
|
381
|
-
result = api_instance.
|
|
464
|
+
result = api_instance.create_composition_database_record(id, table, idempotency_key, body, opts)
|
|
382
465
|
p result
|
|
383
466
|
rescue ApiSdkRb::ApiError => e
|
|
384
|
-
puts "Error when calling CompositionsApi->
|
|
467
|
+
puts "Error when calling CompositionsApi->create_composition_database_record: #{e}"
|
|
385
468
|
end
|
|
386
469
|
```
|
|
387
470
|
|
|
388
|
-
#### Using the
|
|
471
|
+
#### Using the create_composition_database_record_with_http_info variant
|
|
389
472
|
|
|
390
473
|
This returns an Array which contains the response data, status code and headers.
|
|
391
474
|
|
|
392
|
-
> <Array(<
|
|
475
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts)
|
|
393
476
|
|
|
394
477
|
```ruby
|
|
395
478
|
begin
|
|
396
479
|
# Create Record In Composition Database
|
|
397
|
-
data, status_code, headers = api_instance.
|
|
480
|
+
data, status_code, headers = api_instance.create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts)
|
|
398
481
|
p status_code # => 2xx
|
|
399
482
|
p headers # => { ... }
|
|
400
|
-
p data # => <
|
|
483
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
401
484
|
rescue ApiSdkRb::ApiError => e
|
|
402
|
-
puts "Error when calling CompositionsApi->
|
|
485
|
+
puts "Error when calling CompositionsApi->create_composition_database_record_with_http_info: #{e}"
|
|
403
486
|
end
|
|
404
487
|
```
|
|
405
488
|
|
|
@@ -411,12 +494,12 @@ end
|
|
|
411
494
|
| **table** | **String** | Name of the database table | |
|
|
412
495
|
| **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`). | |
|
|
413
496
|
| **body** | **Object** | | |
|
|
414
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
415
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
497
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
498
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
416
499
|
|
|
417
500
|
### Return type
|
|
418
501
|
|
|
419
|
-
[**
|
|
502
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
420
503
|
|
|
421
504
|
### Authorization
|
|
422
505
|
|
|
@@ -428,9 +511,9 @@ end
|
|
|
428
511
|
- **Accept**: application/json
|
|
429
512
|
|
|
430
513
|
|
|
431
|
-
##
|
|
514
|
+
## delete_composition
|
|
432
515
|
|
|
433
|
-
>
|
|
516
|
+
> delete_composition(id, opts)
|
|
434
517
|
|
|
435
518
|
Delete Composition
|
|
436
519
|
|
|
@@ -450,33 +533,33 @@ end
|
|
|
450
533
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
451
534
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The ID of the composition to delete
|
|
452
535
|
opts = {
|
|
453
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
454
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
536
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
537
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
455
538
|
}
|
|
456
539
|
|
|
457
540
|
begin
|
|
458
541
|
# Delete Composition
|
|
459
|
-
api_instance.
|
|
542
|
+
api_instance.delete_composition(id, opts)
|
|
460
543
|
rescue ApiSdkRb::ApiError => e
|
|
461
|
-
puts "Error when calling CompositionsApi->
|
|
544
|
+
puts "Error when calling CompositionsApi->delete_composition: #{e}"
|
|
462
545
|
end
|
|
463
546
|
```
|
|
464
547
|
|
|
465
|
-
#### Using the
|
|
548
|
+
#### Using the delete_composition_with_http_info variant
|
|
466
549
|
|
|
467
550
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
468
551
|
|
|
469
|
-
> <Array(nil, Integer, Hash)>
|
|
552
|
+
> <Array(nil, Integer, Hash)> delete_composition_with_http_info(id, opts)
|
|
470
553
|
|
|
471
554
|
```ruby
|
|
472
555
|
begin
|
|
473
556
|
# Delete Composition
|
|
474
|
-
data, status_code, headers = api_instance.
|
|
557
|
+
data, status_code, headers = api_instance.delete_composition_with_http_info(id, opts)
|
|
475
558
|
p status_code # => 2xx
|
|
476
559
|
p headers # => { ... }
|
|
477
560
|
p data # => nil
|
|
478
561
|
rescue ApiSdkRb::ApiError => e
|
|
479
|
-
puts "Error when calling CompositionsApi->
|
|
562
|
+
puts "Error when calling CompositionsApi->delete_composition_with_http_info: #{e}"
|
|
480
563
|
end
|
|
481
564
|
```
|
|
482
565
|
|
|
@@ -485,8 +568,8 @@ end
|
|
|
485
568
|
| Name | Type | Description | Notes |
|
|
486
569
|
| ---- | ---- | ----------- | ----- |
|
|
487
570
|
| **id** | **String** | The ID of the composition to delete | |
|
|
488
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
489
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
571
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
572
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
490
573
|
|
|
491
574
|
### Return type
|
|
492
575
|
|
|
@@ -502,9 +585,9 @@ nil (empty response body)
|
|
|
502
585
|
- **Accept**: application/json
|
|
503
586
|
|
|
504
587
|
|
|
505
|
-
##
|
|
588
|
+
## delete_composition_content_item
|
|
506
589
|
|
|
507
|
-
> <DeleteCompositionContentItemResponse>
|
|
590
|
+
> <DeleteCompositionContentItemResponse> delete_composition_content_item(id, list, item_id, idempotency_key, opts)
|
|
508
591
|
|
|
509
592
|
Delete a content list item
|
|
510
593
|
|
|
@@ -526,34 +609,34 @@ item_id = 'item_id_example' # String |
|
|
|
526
609
|
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`).
|
|
527
610
|
opts = {
|
|
528
611
|
if_match: 'if_match_example', # String |
|
|
529
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
530
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
612
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
613
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
531
614
|
}
|
|
532
615
|
|
|
533
616
|
begin
|
|
534
617
|
# Delete a content list item
|
|
535
|
-
result = api_instance.
|
|
618
|
+
result = api_instance.delete_composition_content_item(id, list, item_id, idempotency_key, opts)
|
|
536
619
|
p result
|
|
537
620
|
rescue ApiSdkRb::ApiError => e
|
|
538
|
-
puts "Error when calling CompositionsApi->
|
|
621
|
+
puts "Error when calling CompositionsApi->delete_composition_content_item: #{e}"
|
|
539
622
|
end
|
|
540
623
|
```
|
|
541
624
|
|
|
542
|
-
#### Using the
|
|
625
|
+
#### Using the delete_composition_content_item_with_http_info variant
|
|
543
626
|
|
|
544
627
|
This returns an Array which contains the response data, status code and headers.
|
|
545
628
|
|
|
546
|
-
> <Array(<DeleteCompositionContentItemResponse>, Integer, Hash)>
|
|
629
|
+
> <Array(<DeleteCompositionContentItemResponse>, Integer, Hash)> delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts)
|
|
547
630
|
|
|
548
631
|
```ruby
|
|
549
632
|
begin
|
|
550
633
|
# Delete a content list item
|
|
551
|
-
data, status_code, headers = api_instance.
|
|
634
|
+
data, status_code, headers = api_instance.delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts)
|
|
552
635
|
p status_code # => 2xx
|
|
553
636
|
p headers # => { ... }
|
|
554
637
|
p data # => <DeleteCompositionContentItemResponse>
|
|
555
638
|
rescue ApiSdkRb::ApiError => e
|
|
556
|
-
puts "Error when calling CompositionsApi->
|
|
639
|
+
puts "Error when calling CompositionsApi->delete_composition_content_item_with_http_info: #{e}"
|
|
557
640
|
end
|
|
558
641
|
```
|
|
559
642
|
|
|
@@ -566,8 +649,8 @@ end
|
|
|
566
649
|
| **item_id** | **String** | | |
|
|
567
650
|
| **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`). | |
|
|
568
651
|
| **if_match** | **String** | | [optional] |
|
|
569
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
570
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
652
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
653
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
571
654
|
|
|
572
655
|
### Return type
|
|
573
656
|
|
|
@@ -583,9 +666,9 @@ end
|
|
|
583
666
|
- **Accept**: application/json
|
|
584
667
|
|
|
585
668
|
|
|
586
|
-
##
|
|
669
|
+
## delete_composition_data_source
|
|
587
670
|
|
|
588
|
-
> <DeleteCompositionDataSourceResponse>
|
|
671
|
+
> <DeleteCompositionDataSourceResponse> delete_composition_data_source(id, idempotency_key, opts)
|
|
589
672
|
|
|
590
673
|
Remove the composition data source binding
|
|
591
674
|
|
|
@@ -606,34 +689,34 @@ api_instance = ApiSdkRb::CompositionsApi.new
|
|
|
606
689
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
607
690
|
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`).
|
|
608
691
|
opts = {
|
|
609
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
610
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
692
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
693
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
611
694
|
}
|
|
612
695
|
|
|
613
696
|
begin
|
|
614
697
|
# Remove the composition data source binding
|
|
615
|
-
result = api_instance.
|
|
698
|
+
result = api_instance.delete_composition_data_source(id, idempotency_key, opts)
|
|
616
699
|
p result
|
|
617
700
|
rescue ApiSdkRb::ApiError => e
|
|
618
|
-
puts "Error when calling CompositionsApi->
|
|
701
|
+
puts "Error when calling CompositionsApi->delete_composition_data_source: #{e}"
|
|
619
702
|
end
|
|
620
703
|
```
|
|
621
704
|
|
|
622
|
-
#### Using the
|
|
705
|
+
#### Using the delete_composition_data_source_with_http_info variant
|
|
623
706
|
|
|
624
707
|
This returns an Array which contains the response data, status code and headers.
|
|
625
708
|
|
|
626
|
-
> <Array(<DeleteCompositionDataSourceResponse>, Integer, Hash)>
|
|
709
|
+
> <Array(<DeleteCompositionDataSourceResponse>, Integer, Hash)> delete_composition_data_source_with_http_info(id, idempotency_key, opts)
|
|
627
710
|
|
|
628
711
|
```ruby
|
|
629
712
|
begin
|
|
630
713
|
# Remove the composition data source binding
|
|
631
|
-
data, status_code, headers = api_instance.
|
|
714
|
+
data, status_code, headers = api_instance.delete_composition_data_source_with_http_info(id, idempotency_key, opts)
|
|
632
715
|
p status_code # => 2xx
|
|
633
716
|
p headers # => { ... }
|
|
634
717
|
p data # => <DeleteCompositionDataSourceResponse>
|
|
635
718
|
rescue ApiSdkRb::ApiError => e
|
|
636
|
-
puts "Error when calling CompositionsApi->
|
|
719
|
+
puts "Error when calling CompositionsApi->delete_composition_data_source_with_http_info: #{e}"
|
|
637
720
|
end
|
|
638
721
|
```
|
|
639
722
|
|
|
@@ -643,8 +726,8 @@ end
|
|
|
643
726
|
| ---- | ---- | ----------- | ----- |
|
|
644
727
|
| **id** | **String** | | |
|
|
645
728
|
| **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`). | |
|
|
646
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
647
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
729
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
730
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
648
731
|
|
|
649
732
|
### Return type
|
|
650
733
|
|
|
@@ -660,9 +743,9 @@ end
|
|
|
660
743
|
- **Accept**: application/json
|
|
661
744
|
|
|
662
745
|
|
|
663
|
-
##
|
|
746
|
+
## delete_composition_database_record
|
|
664
747
|
|
|
665
|
-
> <
|
|
748
|
+
> <CompositionDatabaseRecordResponse> delete_composition_database_record(id, table, record_id, opts)
|
|
666
749
|
|
|
667
750
|
Delete Record From Composition Database
|
|
668
751
|
|
|
@@ -684,34 +767,34 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
|
684
767
|
table = 'table_example' # String | Name of the database table
|
|
685
768
|
record_id = 'record_id_example' # String | ID of the record to delete
|
|
686
769
|
opts = {
|
|
687
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
688
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
770
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
771
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
689
772
|
}
|
|
690
773
|
|
|
691
774
|
begin
|
|
692
775
|
# Delete Record From Composition Database
|
|
693
|
-
result = api_instance.
|
|
776
|
+
result = api_instance.delete_composition_database_record(id, table, record_id, opts)
|
|
694
777
|
p result
|
|
695
778
|
rescue ApiSdkRb::ApiError => e
|
|
696
|
-
puts "Error when calling CompositionsApi->
|
|
779
|
+
puts "Error when calling CompositionsApi->delete_composition_database_record: #{e}"
|
|
697
780
|
end
|
|
698
781
|
```
|
|
699
782
|
|
|
700
|
-
#### Using the
|
|
783
|
+
#### Using the delete_composition_database_record_with_http_info variant
|
|
701
784
|
|
|
702
785
|
This returns an Array which contains the response data, status code and headers.
|
|
703
786
|
|
|
704
|
-
> <Array(<
|
|
787
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> delete_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
705
788
|
|
|
706
789
|
```ruby
|
|
707
790
|
begin
|
|
708
791
|
# Delete Record From Composition Database
|
|
709
|
-
data, status_code, headers = api_instance.
|
|
792
|
+
data, status_code, headers = api_instance.delete_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
710
793
|
p status_code # => 2xx
|
|
711
794
|
p headers # => { ... }
|
|
712
|
-
p data # => <
|
|
795
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
713
796
|
rescue ApiSdkRb::ApiError => e
|
|
714
|
-
puts "Error when calling CompositionsApi->
|
|
797
|
+
puts "Error when calling CompositionsApi->delete_composition_database_record_with_http_info: #{e}"
|
|
715
798
|
end
|
|
716
799
|
```
|
|
717
800
|
|
|
@@ -722,12 +805,95 @@ end
|
|
|
722
805
|
| **id** | **String** | ID of the composition | |
|
|
723
806
|
| **table** | **String** | Name of the database table | |
|
|
724
807
|
| **record_id** | **String** | ID of the record to delete | |
|
|
725
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
726
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
808
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
809
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
810
|
+
|
|
811
|
+
### Return type
|
|
812
|
+
|
|
813
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
814
|
+
|
|
815
|
+
### Authorization
|
|
816
|
+
|
|
817
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
818
|
+
|
|
819
|
+
### HTTP request headers
|
|
820
|
+
|
|
821
|
+
- **Content-Type**: Not defined
|
|
822
|
+
- **Accept**: application/json
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
## delete_composition_entry_items
|
|
826
|
+
|
|
827
|
+
> <CompositionEntryDeleteSuccess> delete_composition_entry_items(id, table, opts)
|
|
828
|
+
|
|
829
|
+
Delete composition entry items by id or host context
|
|
830
|
+
|
|
831
|
+
Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
832
|
+
|
|
833
|
+
### Examples
|
|
834
|
+
|
|
835
|
+
```ruby
|
|
836
|
+
require 'time'
|
|
837
|
+
require 'api-sdk-rb'
|
|
838
|
+
# setup authorization
|
|
839
|
+
ApiSdkRb.configure do |config|
|
|
840
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
841
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
842
|
+
end
|
|
843
|
+
|
|
844
|
+
api_instance = ApiSdkRb::CompositionsApi.new
|
|
845
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
846
|
+
table = 'table_example' # String |
|
|
847
|
+
opts = {
|
|
848
|
+
ids: 'ids_example', # String |
|
|
849
|
+
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
850
|
+
filter: { key: { key: 'inner_example'}}, # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
851
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
852
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
853
|
+
}
|
|
854
|
+
|
|
855
|
+
begin
|
|
856
|
+
# Delete composition entry items by id or host context
|
|
857
|
+
result = api_instance.delete_composition_entry_items(id, table, opts)
|
|
858
|
+
p result
|
|
859
|
+
rescue ApiSdkRb::ApiError => e
|
|
860
|
+
puts "Error when calling CompositionsApi->delete_composition_entry_items: #{e}"
|
|
861
|
+
end
|
|
862
|
+
```
|
|
863
|
+
|
|
864
|
+
#### Using the delete_composition_entry_items_with_http_info variant
|
|
865
|
+
|
|
866
|
+
This returns an Array which contains the response data, status code and headers.
|
|
867
|
+
|
|
868
|
+
> <Array(<CompositionEntryDeleteSuccess>, Integer, Hash)> delete_composition_entry_items_with_http_info(id, table, opts)
|
|
869
|
+
|
|
870
|
+
```ruby
|
|
871
|
+
begin
|
|
872
|
+
# Delete composition entry items by id or host context
|
|
873
|
+
data, status_code, headers = api_instance.delete_composition_entry_items_with_http_info(id, table, opts)
|
|
874
|
+
p status_code # => 2xx
|
|
875
|
+
p headers # => { ... }
|
|
876
|
+
p data # => <CompositionEntryDeleteSuccess>
|
|
877
|
+
rescue ApiSdkRb::ApiError => e
|
|
878
|
+
puts "Error when calling CompositionsApi->delete_composition_entry_items_with_http_info: #{e}"
|
|
879
|
+
end
|
|
880
|
+
```
|
|
881
|
+
|
|
882
|
+
### Parameters
|
|
883
|
+
|
|
884
|
+
| Name | Type | Description | Notes |
|
|
885
|
+
| ---- | ---- | ----------- | ----- |
|
|
886
|
+
| **id** | **String** | | |
|
|
887
|
+
| **table** | **String** | | |
|
|
888
|
+
| **ids** | **String** | | [optional] |
|
|
889
|
+
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
890
|
+
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
891
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
892
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
727
893
|
|
|
728
894
|
### Return type
|
|
729
895
|
|
|
730
|
-
[**
|
|
896
|
+
[**CompositionEntryDeleteSuccess**](CompositionEntryDeleteSuccess.md)
|
|
731
897
|
|
|
732
898
|
### Authorization
|
|
733
899
|
|
|
@@ -739,9 +905,9 @@ end
|
|
|
739
905
|
- **Accept**: application/json
|
|
740
906
|
|
|
741
907
|
|
|
742
|
-
##
|
|
908
|
+
## describe_composition_entries
|
|
743
909
|
|
|
744
|
-
> <CompositionEntriesDescriptionResponse>
|
|
910
|
+
> <CompositionEntriesDescriptionResponse> describe_composition_entries(id, opts)
|
|
745
911
|
|
|
746
912
|
Describe What a Composition Keeps
|
|
747
913
|
|
|
@@ -761,34 +927,34 @@ end
|
|
|
761
927
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
762
928
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
763
929
|
opts = {
|
|
764
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
765
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
930
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
931
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
766
932
|
}
|
|
767
933
|
|
|
768
934
|
begin
|
|
769
935
|
# Describe What a Composition Keeps
|
|
770
|
-
result = api_instance.
|
|
936
|
+
result = api_instance.describe_composition_entries(id, opts)
|
|
771
937
|
p result
|
|
772
938
|
rescue ApiSdkRb::ApiError => e
|
|
773
|
-
puts "Error when calling CompositionsApi->
|
|
939
|
+
puts "Error when calling CompositionsApi->describe_composition_entries: #{e}"
|
|
774
940
|
end
|
|
775
941
|
```
|
|
776
942
|
|
|
777
|
-
#### Using the
|
|
943
|
+
#### Using the describe_composition_entries_with_http_info variant
|
|
778
944
|
|
|
779
945
|
This returns an Array which contains the response data, status code and headers.
|
|
780
946
|
|
|
781
|
-
> <Array(<CompositionEntriesDescriptionResponse>, Integer, Hash)>
|
|
947
|
+
> <Array(<CompositionEntriesDescriptionResponse>, Integer, Hash)> describe_composition_entries_with_http_info(id, opts)
|
|
782
948
|
|
|
783
949
|
```ruby
|
|
784
950
|
begin
|
|
785
951
|
# Describe What a Composition Keeps
|
|
786
|
-
data, status_code, headers = api_instance.
|
|
952
|
+
data, status_code, headers = api_instance.describe_composition_entries_with_http_info(id, opts)
|
|
787
953
|
p status_code # => 2xx
|
|
788
954
|
p headers # => { ... }
|
|
789
955
|
p data # => <CompositionEntriesDescriptionResponse>
|
|
790
956
|
rescue ApiSdkRb::ApiError => e
|
|
791
|
-
puts "Error when calling CompositionsApi->
|
|
957
|
+
puts "Error when calling CompositionsApi->describe_composition_entries_with_http_info: #{e}"
|
|
792
958
|
end
|
|
793
959
|
```
|
|
794
960
|
|
|
@@ -797,8 +963,8 @@ end
|
|
|
797
963
|
| Name | Type | Description | Notes |
|
|
798
964
|
| ---- | ---- | ----------- | ----- |
|
|
799
965
|
| **id** | **String** | ID of the composition | |
|
|
800
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
801
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
966
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
967
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
802
968
|
|
|
803
969
|
### Return type
|
|
804
970
|
|
|
@@ -814,9 +980,9 @@ end
|
|
|
814
980
|
- **Accept**: application/json
|
|
815
981
|
|
|
816
982
|
|
|
817
|
-
##
|
|
983
|
+
## duplicate_composition
|
|
818
984
|
|
|
819
|
-
> <DuplicateComposition202Response>
|
|
985
|
+
> <DuplicateComposition202Response> duplicate_composition(id, idempotency_key, opts)
|
|
820
986
|
|
|
821
987
|
Duplicate Composition
|
|
822
988
|
|
|
@@ -837,35 +1003,35 @@ api_instance = ApiSdkRb::CompositionsApi.new
|
|
|
837
1003
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition to duplicate
|
|
838
1004
|
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`).
|
|
839
1005
|
opts = {
|
|
840
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
841
|
-
x_managed_user_external_id: 'customer-1042', # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1006
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1007
|
+
x_managed_user_external_id: 'customer-1042', # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
842
1008
|
duplicate_composition_request: ApiSdkRb::DuplicateCompositionRequest.new # DuplicateCompositionRequest |
|
|
843
1009
|
}
|
|
844
1010
|
|
|
845
1011
|
begin
|
|
846
1012
|
# Duplicate Composition
|
|
847
|
-
result = api_instance.
|
|
1013
|
+
result = api_instance.duplicate_composition(id, idempotency_key, opts)
|
|
848
1014
|
p result
|
|
849
1015
|
rescue ApiSdkRb::ApiError => e
|
|
850
|
-
puts "Error when calling CompositionsApi->
|
|
1016
|
+
puts "Error when calling CompositionsApi->duplicate_composition: #{e}"
|
|
851
1017
|
end
|
|
852
1018
|
```
|
|
853
1019
|
|
|
854
|
-
#### Using the
|
|
1020
|
+
#### Using the duplicate_composition_with_http_info variant
|
|
855
1021
|
|
|
856
1022
|
This returns an Array which contains the response data, status code and headers.
|
|
857
1023
|
|
|
858
|
-
> <Array(<DuplicateComposition202Response>, Integer, Hash)>
|
|
1024
|
+
> <Array(<DuplicateComposition202Response>, Integer, Hash)> duplicate_composition_with_http_info(id, idempotency_key, opts)
|
|
859
1025
|
|
|
860
1026
|
```ruby
|
|
861
1027
|
begin
|
|
862
1028
|
# Duplicate Composition
|
|
863
|
-
data, status_code, headers = api_instance.
|
|
1029
|
+
data, status_code, headers = api_instance.duplicate_composition_with_http_info(id, idempotency_key, opts)
|
|
864
1030
|
p status_code # => 2xx
|
|
865
1031
|
p headers # => { ... }
|
|
866
1032
|
p data # => <DuplicateComposition202Response>
|
|
867
1033
|
rescue ApiSdkRb::ApiError => e
|
|
868
|
-
puts "Error when calling CompositionsApi->
|
|
1034
|
+
puts "Error when calling CompositionsApi->duplicate_composition_with_http_info: #{e}"
|
|
869
1035
|
end
|
|
870
1036
|
```
|
|
871
1037
|
|
|
@@ -875,8 +1041,8 @@ end
|
|
|
875
1041
|
| ---- | ---- | ----------- | ----- |
|
|
876
1042
|
| **id** | **String** | ID of the composition to duplicate | |
|
|
877
1043
|
| **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`). | |
|
|
878
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
879
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1044
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1045
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
880
1046
|
| **duplicate_composition_request** | [**DuplicateCompositionRequest**](DuplicateCompositionRequest.md) | | [optional] |
|
|
881
1047
|
|
|
882
1048
|
### Return type
|
|
@@ -893,9 +1059,98 @@ end
|
|
|
893
1059
|
- **Accept**: application/json
|
|
894
1060
|
|
|
895
1061
|
|
|
896
|
-
##
|
|
1062
|
+
## export_composition_entry_items
|
|
1063
|
+
|
|
1064
|
+
> String export_composition_entry_items(id, table, opts)
|
|
1065
|
+
|
|
1066
|
+
Export composition entry items
|
|
1067
|
+
|
|
1068
|
+
Streams up to 50,000 matching rows in batches of 1,000. Tables without cursor paging export at most one batch; when more rows exist the response sets `X-Widgetic-Export-Truncated: true`. Rate limit 20 requests per minute.
|
|
1069
|
+
|
|
1070
|
+
### Examples
|
|
1071
|
+
|
|
1072
|
+
```ruby
|
|
1073
|
+
require 'time'
|
|
1074
|
+
require 'api-sdk-rb'
|
|
1075
|
+
# setup authorization
|
|
1076
|
+
ApiSdkRb.configure do |config|
|
|
1077
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1078
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1079
|
+
end
|
|
1080
|
+
|
|
1081
|
+
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1082
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
1083
|
+
table = 'table_example' # String |
|
|
1084
|
+
opts = {
|
|
1085
|
+
format: 'csv', # String |
|
|
1086
|
+
order: 'asc', # String | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id.
|
|
1087
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`.
|
|
1088
|
+
_until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`).
|
|
1089
|
+
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
1090
|
+
filter: { key: { key: 'inner_example'}}, # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
1091
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1092
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
begin
|
|
1096
|
+
# Export composition entry items
|
|
1097
|
+
result = api_instance.export_composition_entry_items(id, table, opts)
|
|
1098
|
+
p result
|
|
1099
|
+
rescue ApiSdkRb::ApiError => e
|
|
1100
|
+
puts "Error when calling CompositionsApi->export_composition_entry_items: #{e}"
|
|
1101
|
+
end
|
|
1102
|
+
```
|
|
1103
|
+
|
|
1104
|
+
#### Using the export_composition_entry_items_with_http_info variant
|
|
1105
|
+
|
|
1106
|
+
This returns an Array which contains the response data, status code and headers.
|
|
897
1107
|
|
|
898
|
-
> <
|
|
1108
|
+
> <Array(String, Integer, Hash)> export_composition_entry_items_with_http_info(id, table, opts)
|
|
1109
|
+
|
|
1110
|
+
```ruby
|
|
1111
|
+
begin
|
|
1112
|
+
# Export composition entry items
|
|
1113
|
+
data, status_code, headers = api_instance.export_composition_entry_items_with_http_info(id, table, opts)
|
|
1114
|
+
p status_code # => 2xx
|
|
1115
|
+
p headers # => { ... }
|
|
1116
|
+
p data # => String
|
|
1117
|
+
rescue ApiSdkRb::ApiError => e
|
|
1118
|
+
puts "Error when calling CompositionsApi->export_composition_entry_items_with_http_info: #{e}"
|
|
1119
|
+
end
|
|
1120
|
+
```
|
|
1121
|
+
|
|
1122
|
+
### Parameters
|
|
1123
|
+
|
|
1124
|
+
| Name | Type | Description | Notes |
|
|
1125
|
+
| ---- | ---- | ----------- | ----- |
|
|
1126
|
+
| **id** | **String** | | |
|
|
1127
|
+
| **table** | **String** | | |
|
|
1128
|
+
| **format** | **String** | | [optional][default to 'csv'] |
|
|
1129
|
+
| **order** | **String** | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id. | [optional][default to 'desc'] |
|
|
1130
|
+
| **since** | **Time** | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`. | [optional] |
|
|
1131
|
+
| **_until** | **Time** | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`). | [optional] |
|
|
1132
|
+
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
1133
|
+
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
1134
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1135
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1136
|
+
|
|
1137
|
+
### Return type
|
|
1138
|
+
|
|
1139
|
+
**String**
|
|
1140
|
+
|
|
1141
|
+
### Authorization
|
|
1142
|
+
|
|
1143
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1144
|
+
|
|
1145
|
+
### HTTP request headers
|
|
1146
|
+
|
|
1147
|
+
- **Content-Type**: Not defined
|
|
1148
|
+
- **Accept**: text/csv, application/json
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
## get_ai_answers_knowledge
|
|
1152
|
+
|
|
1153
|
+
> <GetAiAnswersKnowledge200Response> get_ai_answers_knowledge(id, opts)
|
|
899
1154
|
|
|
900
1155
|
See the documents a widget's AI answers from
|
|
901
1156
|
|
|
@@ -915,34 +1170,34 @@ end
|
|
|
915
1170
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
916
1171
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The widget (composition) whose documents to list
|
|
917
1172
|
opts = {
|
|
918
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
919
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1173
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1174
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
920
1175
|
}
|
|
921
1176
|
|
|
922
1177
|
begin
|
|
923
1178
|
# See the documents a widget's AI answers from
|
|
924
|
-
result = api_instance.
|
|
1179
|
+
result = api_instance.get_ai_answers_knowledge(id, opts)
|
|
925
1180
|
p result
|
|
926
1181
|
rescue ApiSdkRb::ApiError => e
|
|
927
|
-
puts "Error when calling CompositionsApi->
|
|
1182
|
+
puts "Error when calling CompositionsApi->get_ai_answers_knowledge: #{e}"
|
|
928
1183
|
end
|
|
929
1184
|
```
|
|
930
1185
|
|
|
931
|
-
#### Using the
|
|
1186
|
+
#### Using the get_ai_answers_knowledge_with_http_info variant
|
|
932
1187
|
|
|
933
1188
|
This returns an Array which contains the response data, status code and headers.
|
|
934
1189
|
|
|
935
|
-
> <Array(<GetAiAnswersKnowledge200Response>, Integer, Hash)>
|
|
1190
|
+
> <Array(<GetAiAnswersKnowledge200Response>, Integer, Hash)> get_ai_answers_knowledge_with_http_info(id, opts)
|
|
936
1191
|
|
|
937
1192
|
```ruby
|
|
938
1193
|
begin
|
|
939
1194
|
# See the documents a widget's AI answers from
|
|
940
|
-
data, status_code, headers = api_instance.
|
|
1195
|
+
data, status_code, headers = api_instance.get_ai_answers_knowledge_with_http_info(id, opts)
|
|
941
1196
|
p status_code # => 2xx
|
|
942
1197
|
p headers # => { ... }
|
|
943
1198
|
p data # => <GetAiAnswersKnowledge200Response>
|
|
944
1199
|
rescue ApiSdkRb::ApiError => e
|
|
945
|
-
puts "Error when calling CompositionsApi->
|
|
1200
|
+
puts "Error when calling CompositionsApi->get_ai_answers_knowledge_with_http_info: #{e}"
|
|
946
1201
|
end
|
|
947
1202
|
```
|
|
948
1203
|
|
|
@@ -951,8 +1206,8 @@ end
|
|
|
951
1206
|
| Name | Type | Description | Notes |
|
|
952
1207
|
| ---- | ---- | ----------- | ----- |
|
|
953
1208
|
| **id** | **String** | The widget (composition) whose documents to list | |
|
|
954
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
955
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1209
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1210
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
956
1211
|
|
|
957
1212
|
### Return type
|
|
958
1213
|
|
|
@@ -968,9 +1223,9 @@ end
|
|
|
968
1223
|
- **Accept**: application/json
|
|
969
1224
|
|
|
970
1225
|
|
|
971
|
-
##
|
|
1226
|
+
## get_all_compositions
|
|
972
1227
|
|
|
973
|
-
> <GetAllCompositions200Response>
|
|
1228
|
+
> <GetAllCompositions200Response> get_all_compositions(opts)
|
|
974
1229
|
|
|
975
1230
|
Get All Compositions
|
|
976
1231
|
|
|
@@ -998,34 +1253,34 @@ opts = {
|
|
|
998
1253
|
status: 'draft', # String | Only the compositions in this status. Without it, every status is listed.
|
|
999
1254
|
managed_user_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | List only the compositions made for this managed user (Widgetic's id for the user). Send this or `managedUserExternalId`, not both. Send it as `managedUserId`; the snake_case spelling `managed_user_id` is refused with a 400, not ignored.
|
|
1000
1255
|
managed_user_external_id: 'managed_user_external_id_example', # String | List only the compositions made for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
|
|
1001
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1002
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1256
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1257
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1003
1258
|
}
|
|
1004
1259
|
|
|
1005
1260
|
begin
|
|
1006
1261
|
# Get All Compositions
|
|
1007
|
-
result = api_instance.
|
|
1262
|
+
result = api_instance.get_all_compositions(opts)
|
|
1008
1263
|
p result
|
|
1009
1264
|
rescue ApiSdkRb::ApiError => e
|
|
1010
|
-
puts "Error when calling CompositionsApi->
|
|
1265
|
+
puts "Error when calling CompositionsApi->get_all_compositions: #{e}"
|
|
1011
1266
|
end
|
|
1012
1267
|
```
|
|
1013
1268
|
|
|
1014
|
-
#### Using the
|
|
1269
|
+
#### Using the get_all_compositions_with_http_info variant
|
|
1015
1270
|
|
|
1016
1271
|
This returns an Array which contains the response data, status code and headers.
|
|
1017
1272
|
|
|
1018
|
-
> <Array(<GetAllCompositions200Response>, Integer, Hash)>
|
|
1273
|
+
> <Array(<GetAllCompositions200Response>, Integer, Hash)> get_all_compositions_with_http_info(opts)
|
|
1019
1274
|
|
|
1020
1275
|
```ruby
|
|
1021
1276
|
begin
|
|
1022
1277
|
# Get All Compositions
|
|
1023
|
-
data, status_code, headers = api_instance.
|
|
1278
|
+
data, status_code, headers = api_instance.get_all_compositions_with_http_info(opts)
|
|
1024
1279
|
p status_code # => 2xx
|
|
1025
1280
|
p headers # => { ... }
|
|
1026
1281
|
p data # => <GetAllCompositions200Response>
|
|
1027
1282
|
rescue ApiSdkRb::ApiError => e
|
|
1028
|
-
puts "Error when calling CompositionsApi->
|
|
1283
|
+
puts "Error when calling CompositionsApi->get_all_compositions_with_http_info: #{e}"
|
|
1029
1284
|
end
|
|
1030
1285
|
```
|
|
1031
1286
|
|
|
@@ -1042,8 +1297,8 @@ end
|
|
|
1042
1297
|
| **status** | **String** | Only the compositions in this status. Without it, every status is listed. | [optional] |
|
|
1043
1298
|
| **managed_user_id** | **String** | List only the compositions made for this managed user (Widgetic's id for the user). Send this or `managedUserExternalId`, not both. Send it as `managedUserId`; the snake_case spelling `managed_user_id` is refused with a 400, not ignored. | [optional] |
|
|
1044
1299
|
| **managed_user_external_id** | **String** | List only the compositions made for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both. | [optional] |
|
|
1045
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1046
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1300
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1301
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1047
1302
|
|
|
1048
1303
|
### Return type
|
|
1049
1304
|
|
|
@@ -1059,13 +1314,13 @@ end
|
|
|
1059
1314
|
- **Accept**: application/json
|
|
1060
1315
|
|
|
1061
1316
|
|
|
1062
|
-
##
|
|
1317
|
+
## get_composition_by_id
|
|
1063
1318
|
|
|
1064
|
-
> <
|
|
1319
|
+
> <CompositionResponse> get_composition_by_id(id, opts)
|
|
1065
1320
|
|
|
1066
1321
|
Get Composition
|
|
1067
1322
|
|
|
1068
|
-
Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route
|
|
1323
|
+
Retrieves a specific composition by its ID. The answer carries `direct`, which says whether the widget the composition is made from is drawn straight into your page (`true`) or inside a frame (`false`), or `null` while the widget has no published version. Read it before you go live: a widget drawn without a frame writes its entries from your own page, so the public entry route looks at the website that page is on. While the composition's allowed list is empty (you have not restricted the allowed websites), every website may write; once you list websites, only those may, besides Widgetic's own sites, the visitor's own machine and your own platform. A widget in a frame writes from Widgetic's own frame and is accepted whatever the list says. The public JSON of the composition stays open to every website. For a composition a team shares (one filed under a project of an organization, or made in a Shopify store's workspace) the answer also carries `lastEditedBy` and `lastEditedAt`: who made the latest change and when, so that a teammate who opens it can be told \"Anna changed this at 14:32\". A composition in a personal project leaves both out, and so does an answer given to an editor session or to a call made for one managed user: only a person is told who a teammate is.
|
|
1069
1324
|
|
|
1070
1325
|
### Examples
|
|
1071
1326
|
|
|
@@ -1081,34 +1336,34 @@ end
|
|
|
1081
1336
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1082
1337
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Composition ID
|
|
1083
1338
|
opts = {
|
|
1084
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1085
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1339
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1340
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1086
1341
|
}
|
|
1087
1342
|
|
|
1088
1343
|
begin
|
|
1089
1344
|
# Get Composition
|
|
1090
|
-
result = api_instance.
|
|
1345
|
+
result = api_instance.get_composition_by_id(id, opts)
|
|
1091
1346
|
p result
|
|
1092
1347
|
rescue ApiSdkRb::ApiError => e
|
|
1093
|
-
puts "Error when calling CompositionsApi->
|
|
1348
|
+
puts "Error when calling CompositionsApi->get_composition_by_id: #{e}"
|
|
1094
1349
|
end
|
|
1095
1350
|
```
|
|
1096
1351
|
|
|
1097
|
-
#### Using the
|
|
1352
|
+
#### Using the get_composition_by_id_with_http_info variant
|
|
1098
1353
|
|
|
1099
1354
|
This returns an Array which contains the response data, status code and headers.
|
|
1100
1355
|
|
|
1101
|
-
> <Array(<
|
|
1356
|
+
> <Array(<CompositionResponse>, Integer, Hash)> get_composition_by_id_with_http_info(id, opts)
|
|
1102
1357
|
|
|
1103
1358
|
```ruby
|
|
1104
1359
|
begin
|
|
1105
1360
|
# Get Composition
|
|
1106
|
-
data, status_code, headers = api_instance.
|
|
1361
|
+
data, status_code, headers = api_instance.get_composition_by_id_with_http_info(id, opts)
|
|
1107
1362
|
p status_code # => 2xx
|
|
1108
1363
|
p headers # => { ... }
|
|
1109
|
-
p data # => <
|
|
1364
|
+
p data # => <CompositionResponse>
|
|
1110
1365
|
rescue ApiSdkRb::ApiError => e
|
|
1111
|
-
puts "Error when calling CompositionsApi->
|
|
1366
|
+
puts "Error when calling CompositionsApi->get_composition_by_id_with_http_info: #{e}"
|
|
1112
1367
|
end
|
|
1113
1368
|
```
|
|
1114
1369
|
|
|
@@ -1117,12 +1372,12 @@ end
|
|
|
1117
1372
|
| Name | Type | Description | Notes |
|
|
1118
1373
|
| ---- | ---- | ----------- | ----- |
|
|
1119
1374
|
| **id** | **String** | Composition ID | |
|
|
1120
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1121
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1375
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1376
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1122
1377
|
|
|
1123
1378
|
### Return type
|
|
1124
1379
|
|
|
1125
|
-
[**
|
|
1380
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
1126
1381
|
|
|
1127
1382
|
### Authorization
|
|
1128
1383
|
|
|
@@ -1134,9 +1389,9 @@ end
|
|
|
1134
1389
|
- **Accept**: application/json
|
|
1135
1390
|
|
|
1136
1391
|
|
|
1137
|
-
##
|
|
1392
|
+
## get_composition_content
|
|
1138
1393
|
|
|
1139
|
-
> <GetCompositionContentResponse>
|
|
1394
|
+
> <GetCompositionContentResponse> get_composition_content(id, opts)
|
|
1140
1395
|
|
|
1141
1396
|
Get Current Content
|
|
1142
1397
|
|
|
@@ -1156,34 +1411,34 @@ end
|
|
|
1156
1411
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1157
1412
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1158
1413
|
opts = {
|
|
1159
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1160
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1414
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1415
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1161
1416
|
}
|
|
1162
1417
|
|
|
1163
1418
|
begin
|
|
1164
1419
|
# Get Current Content
|
|
1165
|
-
result = api_instance.
|
|
1420
|
+
result = api_instance.get_composition_content(id, opts)
|
|
1166
1421
|
p result
|
|
1167
1422
|
rescue ApiSdkRb::ApiError => e
|
|
1168
|
-
puts "Error when calling CompositionsApi->
|
|
1423
|
+
puts "Error when calling CompositionsApi->get_composition_content: #{e}"
|
|
1169
1424
|
end
|
|
1170
1425
|
```
|
|
1171
1426
|
|
|
1172
|
-
#### Using the
|
|
1427
|
+
#### Using the get_composition_content_with_http_info variant
|
|
1173
1428
|
|
|
1174
1429
|
This returns an Array which contains the response data, status code and headers.
|
|
1175
1430
|
|
|
1176
|
-
> <Array(<GetCompositionContentResponse>, Integer, Hash)>
|
|
1431
|
+
> <Array(<GetCompositionContentResponse>, Integer, Hash)> get_composition_content_with_http_info(id, opts)
|
|
1177
1432
|
|
|
1178
1433
|
```ruby
|
|
1179
1434
|
begin
|
|
1180
1435
|
# Get Current Content
|
|
1181
|
-
data, status_code, headers = api_instance.
|
|
1436
|
+
data, status_code, headers = api_instance.get_composition_content_with_http_info(id, opts)
|
|
1182
1437
|
p status_code # => 2xx
|
|
1183
1438
|
p headers # => { ... }
|
|
1184
1439
|
p data # => <GetCompositionContentResponse>
|
|
1185
1440
|
rescue ApiSdkRb::ApiError => e
|
|
1186
|
-
puts "Error when calling CompositionsApi->
|
|
1441
|
+
puts "Error when calling CompositionsApi->get_composition_content_with_http_info: #{e}"
|
|
1187
1442
|
end
|
|
1188
1443
|
```
|
|
1189
1444
|
|
|
@@ -1192,8 +1447,8 @@ end
|
|
|
1192
1447
|
| Name | Type | Description | Notes |
|
|
1193
1448
|
| ---- | ---- | ----------- | ----- |
|
|
1194
1449
|
| **id** | **String** | ID of the composition | |
|
|
1195
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1196
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1450
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1451
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1197
1452
|
|
|
1198
1453
|
### Return type
|
|
1199
1454
|
|
|
@@ -1209,9 +1464,9 @@ end
|
|
|
1209
1464
|
- **Accept**: application/json
|
|
1210
1465
|
|
|
1211
1466
|
|
|
1212
|
-
##
|
|
1467
|
+
## get_composition_content_schema
|
|
1213
1468
|
|
|
1214
|
-
> <GetCompositionContentSchemaResponse>
|
|
1469
|
+
> <GetCompositionContentSchemaResponse> get_composition_content_schema(id, opts)
|
|
1215
1470
|
|
|
1216
1471
|
Get Content Schema
|
|
1217
1472
|
|
|
@@ -1231,34 +1486,34 @@ end
|
|
|
1231
1486
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1232
1487
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1233
1488
|
opts = {
|
|
1234
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1235
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1489
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1490
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1236
1491
|
}
|
|
1237
1492
|
|
|
1238
1493
|
begin
|
|
1239
1494
|
# Get Content Schema
|
|
1240
|
-
result = api_instance.
|
|
1495
|
+
result = api_instance.get_composition_content_schema(id, opts)
|
|
1241
1496
|
p result
|
|
1242
1497
|
rescue ApiSdkRb::ApiError => e
|
|
1243
|
-
puts "Error when calling CompositionsApi->
|
|
1498
|
+
puts "Error when calling CompositionsApi->get_composition_content_schema: #{e}"
|
|
1244
1499
|
end
|
|
1245
1500
|
```
|
|
1246
1501
|
|
|
1247
|
-
#### Using the
|
|
1502
|
+
#### Using the get_composition_content_schema_with_http_info variant
|
|
1248
1503
|
|
|
1249
1504
|
This returns an Array which contains the response data, status code and headers.
|
|
1250
1505
|
|
|
1251
|
-
> <Array(<GetCompositionContentSchemaResponse>, Integer, Hash)>
|
|
1506
|
+
> <Array(<GetCompositionContentSchemaResponse>, Integer, Hash)> get_composition_content_schema_with_http_info(id, opts)
|
|
1252
1507
|
|
|
1253
1508
|
```ruby
|
|
1254
1509
|
begin
|
|
1255
1510
|
# Get Content Schema
|
|
1256
|
-
data, status_code, headers = api_instance.
|
|
1511
|
+
data, status_code, headers = api_instance.get_composition_content_schema_with_http_info(id, opts)
|
|
1257
1512
|
p status_code # => 2xx
|
|
1258
1513
|
p headers # => { ... }
|
|
1259
1514
|
p data # => <GetCompositionContentSchemaResponse>
|
|
1260
1515
|
rescue ApiSdkRb::ApiError => e
|
|
1261
|
-
puts "Error when calling CompositionsApi->
|
|
1516
|
+
puts "Error when calling CompositionsApi->get_composition_content_schema_with_http_info: #{e}"
|
|
1262
1517
|
end
|
|
1263
1518
|
```
|
|
1264
1519
|
|
|
@@ -1267,8 +1522,8 @@ end
|
|
|
1267
1522
|
| Name | Type | Description | Notes |
|
|
1268
1523
|
| ---- | ---- | ----------- | ----- |
|
|
1269
1524
|
| **id** | **String** | ID of the composition | |
|
|
1270
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1271
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1525
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1526
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1272
1527
|
|
|
1273
1528
|
### Return type
|
|
1274
1529
|
|
|
@@ -1284,9 +1539,9 @@ end
|
|
|
1284
1539
|
- **Accept**: application/json
|
|
1285
1540
|
|
|
1286
1541
|
|
|
1287
|
-
##
|
|
1542
|
+
## get_composition_data_source
|
|
1288
1543
|
|
|
1289
|
-
> <GetCompositionDataSourceResponse>
|
|
1544
|
+
> <GetCompositionDataSourceResponse> get_composition_data_source(id, opts)
|
|
1290
1545
|
|
|
1291
1546
|
Read the composition data source binding
|
|
1292
1547
|
|
|
@@ -1306,34 +1561,34 @@ end
|
|
|
1306
1561
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1307
1562
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
1308
1563
|
opts = {
|
|
1309
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1310
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1564
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1565
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1311
1566
|
}
|
|
1312
1567
|
|
|
1313
1568
|
begin
|
|
1314
1569
|
# Read the composition data source binding
|
|
1315
|
-
result = api_instance.
|
|
1570
|
+
result = api_instance.get_composition_data_source(id, opts)
|
|
1316
1571
|
p result
|
|
1317
1572
|
rescue ApiSdkRb::ApiError => e
|
|
1318
|
-
puts "Error when calling CompositionsApi->
|
|
1573
|
+
puts "Error when calling CompositionsApi->get_composition_data_source: #{e}"
|
|
1319
1574
|
end
|
|
1320
1575
|
```
|
|
1321
1576
|
|
|
1322
|
-
#### Using the
|
|
1577
|
+
#### Using the get_composition_data_source_with_http_info variant
|
|
1323
1578
|
|
|
1324
1579
|
This returns an Array which contains the response data, status code and headers.
|
|
1325
1580
|
|
|
1326
|
-
> <Array(<GetCompositionDataSourceResponse>, Integer, Hash)>
|
|
1581
|
+
> <Array(<GetCompositionDataSourceResponse>, Integer, Hash)> get_composition_data_source_with_http_info(id, opts)
|
|
1327
1582
|
|
|
1328
1583
|
```ruby
|
|
1329
1584
|
begin
|
|
1330
1585
|
# Read the composition data source binding
|
|
1331
|
-
data, status_code, headers = api_instance.
|
|
1586
|
+
data, status_code, headers = api_instance.get_composition_data_source_with_http_info(id, opts)
|
|
1332
1587
|
p status_code # => 2xx
|
|
1333
1588
|
p headers # => { ... }
|
|
1334
1589
|
p data # => <GetCompositionDataSourceResponse>
|
|
1335
1590
|
rescue ApiSdkRb::ApiError => e
|
|
1336
|
-
puts "Error when calling CompositionsApi->
|
|
1591
|
+
puts "Error when calling CompositionsApi->get_composition_data_source_with_http_info: #{e}"
|
|
1337
1592
|
end
|
|
1338
1593
|
```
|
|
1339
1594
|
|
|
@@ -1342,8 +1597,8 @@ end
|
|
|
1342
1597
|
| Name | Type | Description | Notes |
|
|
1343
1598
|
| ---- | ---- | ----------- | ----- |
|
|
1344
1599
|
| **id** | **String** | | |
|
|
1345
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1346
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1600
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1601
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1347
1602
|
|
|
1348
1603
|
### Return type
|
|
1349
1604
|
|
|
@@ -1359,9 +1614,9 @@ end
|
|
|
1359
1614
|
- **Accept**: application/json
|
|
1360
1615
|
|
|
1361
1616
|
|
|
1362
|
-
##
|
|
1617
|
+
## get_composition_database_record
|
|
1363
1618
|
|
|
1364
|
-
> <
|
|
1619
|
+
> <CompositionDatabaseRecordResponse> get_composition_database_record(id, table, record_id, opts)
|
|
1365
1620
|
|
|
1366
1621
|
Get Record From Composition Database
|
|
1367
1622
|
|
|
@@ -1383,34 +1638,34 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
|
1383
1638
|
table = 'table_example' # String | Name of the database table
|
|
1384
1639
|
record_id = 'record_id_example' # String | ID of the record to retrieve
|
|
1385
1640
|
opts = {
|
|
1386
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1387
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1641
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1642
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1388
1643
|
}
|
|
1389
1644
|
|
|
1390
1645
|
begin
|
|
1391
1646
|
# Get Record From Composition Database
|
|
1392
|
-
result = api_instance.
|
|
1647
|
+
result = api_instance.get_composition_database_record(id, table, record_id, opts)
|
|
1393
1648
|
p result
|
|
1394
1649
|
rescue ApiSdkRb::ApiError => e
|
|
1395
|
-
puts "Error when calling CompositionsApi->
|
|
1650
|
+
puts "Error when calling CompositionsApi->get_composition_database_record: #{e}"
|
|
1396
1651
|
end
|
|
1397
1652
|
```
|
|
1398
1653
|
|
|
1399
|
-
#### Using the
|
|
1654
|
+
#### Using the get_composition_database_record_with_http_info variant
|
|
1400
1655
|
|
|
1401
1656
|
This returns an Array which contains the response data, status code and headers.
|
|
1402
1657
|
|
|
1403
|
-
> <Array(<
|
|
1658
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> get_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
1404
1659
|
|
|
1405
1660
|
```ruby
|
|
1406
1661
|
begin
|
|
1407
1662
|
# Get Record From Composition Database
|
|
1408
|
-
data, status_code, headers = api_instance.
|
|
1663
|
+
data, status_code, headers = api_instance.get_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
1409
1664
|
p status_code # => 2xx
|
|
1410
1665
|
p headers # => { ... }
|
|
1411
|
-
p data # => <
|
|
1666
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
1412
1667
|
rescue ApiSdkRb::ApiError => e
|
|
1413
|
-
puts "Error when calling CompositionsApi->
|
|
1668
|
+
puts "Error when calling CompositionsApi->get_composition_database_record_with_http_info: #{e}"
|
|
1414
1669
|
end
|
|
1415
1670
|
```
|
|
1416
1671
|
|
|
@@ -1421,12 +1676,12 @@ end
|
|
|
1421
1676
|
| **id** | **String** | ID of the composition | |
|
|
1422
1677
|
| **table** | **String** | Name of the database table | |
|
|
1423
1678
|
| **record_id** | **String** | ID of the record to retrieve | |
|
|
1424
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1425
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1679
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1680
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1426
1681
|
|
|
1427
1682
|
### Return type
|
|
1428
1683
|
|
|
1429
|
-
[**
|
|
1684
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
1430
1685
|
|
|
1431
1686
|
### Authorization
|
|
1432
1687
|
|
|
@@ -1438,9 +1693,9 @@ end
|
|
|
1438
1693
|
- **Accept**: application/json
|
|
1439
1694
|
|
|
1440
1695
|
|
|
1441
|
-
##
|
|
1696
|
+
## get_composition_database_records
|
|
1442
1697
|
|
|
1443
|
-
> <GetCompositionDatabaseRecords200Response>
|
|
1698
|
+
> <GetCompositionDatabaseRecords200Response> get_composition_database_records(id, table, opts)
|
|
1444
1699
|
|
|
1445
1700
|
Get All Records From Composition Database Table
|
|
1446
1701
|
|
|
@@ -1461,34 +1716,34 @@ api_instance = ApiSdkRb::CompositionsApi.new
|
|
|
1461
1716
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1462
1717
|
table = 'table_example' # String | Name of the database table
|
|
1463
1718
|
opts = {
|
|
1464
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1465
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1719
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1720
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1466
1721
|
}
|
|
1467
1722
|
|
|
1468
1723
|
begin
|
|
1469
1724
|
# Get All Records From Composition Database Table
|
|
1470
|
-
result = api_instance.
|
|
1725
|
+
result = api_instance.get_composition_database_records(id, table, opts)
|
|
1471
1726
|
p result
|
|
1472
1727
|
rescue ApiSdkRb::ApiError => e
|
|
1473
|
-
puts "Error when calling CompositionsApi->
|
|
1728
|
+
puts "Error when calling CompositionsApi->get_composition_database_records: #{e}"
|
|
1474
1729
|
end
|
|
1475
1730
|
```
|
|
1476
1731
|
|
|
1477
|
-
#### Using the
|
|
1732
|
+
#### Using the get_composition_database_records_with_http_info variant
|
|
1478
1733
|
|
|
1479
1734
|
This returns an Array which contains the response data, status code and headers.
|
|
1480
1735
|
|
|
1481
|
-
> <Array(<GetCompositionDatabaseRecords200Response>, Integer, Hash)>
|
|
1736
|
+
> <Array(<GetCompositionDatabaseRecords200Response>, Integer, Hash)> get_composition_database_records_with_http_info(id, table, opts)
|
|
1482
1737
|
|
|
1483
1738
|
```ruby
|
|
1484
1739
|
begin
|
|
1485
1740
|
# Get All Records From Composition Database Table
|
|
1486
|
-
data, status_code, headers = api_instance.
|
|
1741
|
+
data, status_code, headers = api_instance.get_composition_database_records_with_http_info(id, table, opts)
|
|
1487
1742
|
p status_code # => 2xx
|
|
1488
1743
|
p headers # => { ... }
|
|
1489
1744
|
p data # => <GetCompositionDatabaseRecords200Response>
|
|
1490
1745
|
rescue ApiSdkRb::ApiError => e
|
|
1491
|
-
puts "Error when calling CompositionsApi->
|
|
1746
|
+
puts "Error when calling CompositionsApi->get_composition_database_records_with_http_info: #{e}"
|
|
1492
1747
|
end
|
|
1493
1748
|
```
|
|
1494
1749
|
|
|
@@ -1498,8 +1753,8 @@ end
|
|
|
1498
1753
|
| ---- | ---- | ----------- | ----- |
|
|
1499
1754
|
| **id** | **String** | ID of the composition | |
|
|
1500
1755
|
| **table** | **String** | Name of the database table | |
|
|
1501
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1502
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1756
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1757
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1503
1758
|
|
|
1504
1759
|
### Return type
|
|
1505
1760
|
|
|
@@ -1515,9 +1770,9 @@ end
|
|
|
1515
1770
|
- **Accept**: application/json
|
|
1516
1771
|
|
|
1517
1772
|
|
|
1518
|
-
##
|
|
1773
|
+
## get_composition_design
|
|
1519
1774
|
|
|
1520
|
-
> <GetCompositionDesignResponse>
|
|
1775
|
+
> <GetCompositionDesignResponse> get_composition_design(id, opts)
|
|
1521
1776
|
|
|
1522
1777
|
Get Composition Design
|
|
1523
1778
|
|
|
@@ -1537,34 +1792,34 @@ end
|
|
|
1537
1792
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1538
1793
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1539
1794
|
opts = {
|
|
1540
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1541
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1795
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1796
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1542
1797
|
}
|
|
1543
1798
|
|
|
1544
1799
|
begin
|
|
1545
1800
|
# Get Composition Design
|
|
1546
|
-
result = api_instance.
|
|
1801
|
+
result = api_instance.get_composition_design(id, opts)
|
|
1547
1802
|
p result
|
|
1548
1803
|
rescue ApiSdkRb::ApiError => e
|
|
1549
|
-
puts "Error when calling CompositionsApi->
|
|
1804
|
+
puts "Error when calling CompositionsApi->get_composition_design: #{e}"
|
|
1550
1805
|
end
|
|
1551
1806
|
```
|
|
1552
1807
|
|
|
1553
|
-
#### Using the
|
|
1808
|
+
#### Using the get_composition_design_with_http_info variant
|
|
1554
1809
|
|
|
1555
1810
|
This returns an Array which contains the response data, status code and headers.
|
|
1556
1811
|
|
|
1557
|
-
> <Array(<GetCompositionDesignResponse>, Integer, Hash)>
|
|
1812
|
+
> <Array(<GetCompositionDesignResponse>, Integer, Hash)> get_composition_design_with_http_info(id, opts)
|
|
1558
1813
|
|
|
1559
1814
|
```ruby
|
|
1560
1815
|
begin
|
|
1561
1816
|
# Get Composition Design
|
|
1562
|
-
data, status_code, headers = api_instance.
|
|
1817
|
+
data, status_code, headers = api_instance.get_composition_design_with_http_info(id, opts)
|
|
1563
1818
|
p status_code # => 2xx
|
|
1564
1819
|
p headers # => { ... }
|
|
1565
1820
|
p data # => <GetCompositionDesignResponse>
|
|
1566
1821
|
rescue ApiSdkRb::ApiError => e
|
|
1567
|
-
puts "Error when calling CompositionsApi->
|
|
1822
|
+
puts "Error when calling CompositionsApi->get_composition_design_with_http_info: #{e}"
|
|
1568
1823
|
end
|
|
1569
1824
|
```
|
|
1570
1825
|
|
|
@@ -1573,8 +1828,8 @@ end
|
|
|
1573
1828
|
| Name | Type | Description | Notes |
|
|
1574
1829
|
| ---- | ---- | ----------- | ----- |
|
|
1575
1830
|
| **id** | **String** | ID of the composition | |
|
|
1576
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1577
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1831
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1832
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1578
1833
|
|
|
1579
1834
|
### Return type
|
|
1580
1835
|
|
|
@@ -1590,9 +1845,9 @@ end
|
|
|
1590
1845
|
- **Accept**: application/json
|
|
1591
1846
|
|
|
1592
1847
|
|
|
1593
|
-
##
|
|
1848
|
+
## get_composition_design_schema
|
|
1594
1849
|
|
|
1595
|
-
> <GetCompositionDesignSchemaResponse>
|
|
1850
|
+
> <GetCompositionDesignSchemaResponse> get_composition_design_schema(id, opts)
|
|
1596
1851
|
|
|
1597
1852
|
Get Design Schema
|
|
1598
1853
|
|
|
@@ -1612,34 +1867,34 @@ end
|
|
|
1612
1867
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1613
1868
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1614
1869
|
opts = {
|
|
1615
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1616
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1870
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1871
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1617
1872
|
}
|
|
1618
1873
|
|
|
1619
1874
|
begin
|
|
1620
1875
|
# Get Design Schema
|
|
1621
|
-
result = api_instance.
|
|
1876
|
+
result = api_instance.get_composition_design_schema(id, opts)
|
|
1622
1877
|
p result
|
|
1623
1878
|
rescue ApiSdkRb::ApiError => e
|
|
1624
|
-
puts "Error when calling CompositionsApi->
|
|
1879
|
+
puts "Error when calling CompositionsApi->get_composition_design_schema: #{e}"
|
|
1625
1880
|
end
|
|
1626
1881
|
```
|
|
1627
1882
|
|
|
1628
|
-
#### Using the
|
|
1883
|
+
#### Using the get_composition_design_schema_with_http_info variant
|
|
1629
1884
|
|
|
1630
1885
|
This returns an Array which contains the response data, status code and headers.
|
|
1631
1886
|
|
|
1632
|
-
> <Array(<GetCompositionDesignSchemaResponse>, Integer, Hash)>
|
|
1887
|
+
> <Array(<GetCompositionDesignSchemaResponse>, Integer, Hash)> get_composition_design_schema_with_http_info(id, opts)
|
|
1633
1888
|
|
|
1634
1889
|
```ruby
|
|
1635
1890
|
begin
|
|
1636
1891
|
# Get Design Schema
|
|
1637
|
-
data, status_code, headers = api_instance.
|
|
1892
|
+
data, status_code, headers = api_instance.get_composition_design_schema_with_http_info(id, opts)
|
|
1638
1893
|
p status_code # => 2xx
|
|
1639
1894
|
p headers # => { ... }
|
|
1640
1895
|
p data # => <GetCompositionDesignSchemaResponse>
|
|
1641
1896
|
rescue ApiSdkRb::ApiError => e
|
|
1642
|
-
puts "Error when calling CompositionsApi->
|
|
1897
|
+
puts "Error when calling CompositionsApi->get_composition_design_schema_with_http_info: #{e}"
|
|
1643
1898
|
end
|
|
1644
1899
|
```
|
|
1645
1900
|
|
|
@@ -1648,8 +1903,8 @@ end
|
|
|
1648
1903
|
| Name | Type | Description | Notes |
|
|
1649
1904
|
| ---- | ---- | ----------- | ----- |
|
|
1650
1905
|
| **id** | **String** | ID of the composition | |
|
|
1651
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1652
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1906
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1907
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1653
1908
|
|
|
1654
1909
|
### Return type
|
|
1655
1910
|
|
|
@@ -1665,9 +1920,9 @@ end
|
|
|
1665
1920
|
- **Accept**: application/json
|
|
1666
1921
|
|
|
1667
1922
|
|
|
1668
|
-
##
|
|
1923
|
+
## get_composition_embed_schema
|
|
1669
1924
|
|
|
1670
|
-
> <GetCompositionEmbedSchemaResponse>
|
|
1925
|
+
> <GetCompositionEmbedSchemaResponse> get_composition_embed_schema(id, opts)
|
|
1671
1926
|
|
|
1672
1927
|
Get Embed Schema
|
|
1673
1928
|
|
|
@@ -1687,34 +1942,34 @@ end
|
|
|
1687
1942
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1688
1943
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1689
1944
|
opts = {
|
|
1690
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1691
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1945
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1946
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1692
1947
|
}
|
|
1693
1948
|
|
|
1694
1949
|
begin
|
|
1695
1950
|
# Get Embed Schema
|
|
1696
|
-
result = api_instance.
|
|
1951
|
+
result = api_instance.get_composition_embed_schema(id, opts)
|
|
1697
1952
|
p result
|
|
1698
1953
|
rescue ApiSdkRb::ApiError => e
|
|
1699
|
-
puts "Error when calling CompositionsApi->
|
|
1954
|
+
puts "Error when calling CompositionsApi->get_composition_embed_schema: #{e}"
|
|
1700
1955
|
end
|
|
1701
1956
|
```
|
|
1702
1957
|
|
|
1703
|
-
#### Using the
|
|
1958
|
+
#### Using the get_composition_embed_schema_with_http_info variant
|
|
1704
1959
|
|
|
1705
1960
|
This returns an Array which contains the response data, status code and headers.
|
|
1706
1961
|
|
|
1707
|
-
> <Array(<GetCompositionEmbedSchemaResponse>, Integer, Hash)>
|
|
1962
|
+
> <Array(<GetCompositionEmbedSchemaResponse>, Integer, Hash)> get_composition_embed_schema_with_http_info(id, opts)
|
|
1708
1963
|
|
|
1709
1964
|
```ruby
|
|
1710
1965
|
begin
|
|
1711
1966
|
# Get Embed Schema
|
|
1712
|
-
data, status_code, headers = api_instance.
|
|
1967
|
+
data, status_code, headers = api_instance.get_composition_embed_schema_with_http_info(id, opts)
|
|
1713
1968
|
p status_code # => 2xx
|
|
1714
1969
|
p headers # => { ... }
|
|
1715
1970
|
p data # => <GetCompositionEmbedSchemaResponse>
|
|
1716
1971
|
rescue ApiSdkRb::ApiError => e
|
|
1717
|
-
puts "Error when calling CompositionsApi->
|
|
1972
|
+
puts "Error when calling CompositionsApi->get_composition_embed_schema_with_http_info: #{e}"
|
|
1718
1973
|
end
|
|
1719
1974
|
```
|
|
1720
1975
|
|
|
@@ -1723,8 +1978,8 @@ end
|
|
|
1723
1978
|
| Name | Type | Description | Notes |
|
|
1724
1979
|
| ---- | ---- | ----------- | ----- |
|
|
1725
1980
|
| **id** | **String** | ID of the composition | |
|
|
1726
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1727
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1981
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1982
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1728
1983
|
|
|
1729
1984
|
### Return type
|
|
1730
1985
|
|
|
@@ -1740,9 +1995,9 @@ end
|
|
|
1740
1995
|
- **Accept**: application/json
|
|
1741
1996
|
|
|
1742
1997
|
|
|
1743
|
-
##
|
|
1998
|
+
## get_composition_embed_settings
|
|
1744
1999
|
|
|
1745
|
-
> <GetCompositionEmbedSettingsResponse>
|
|
2000
|
+
> <GetCompositionEmbedSettingsResponse> get_composition_embed_settings(id, opts)
|
|
1746
2001
|
|
|
1747
2002
|
Get Composition Embed Settings
|
|
1748
2003
|
|
|
@@ -1762,34 +2017,34 @@ end
|
|
|
1762
2017
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1763
2018
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1764
2019
|
opts = {
|
|
1765
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1766
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2020
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2021
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1767
2022
|
}
|
|
1768
2023
|
|
|
1769
2024
|
begin
|
|
1770
2025
|
# Get Composition Embed Settings
|
|
1771
|
-
result = api_instance.
|
|
2026
|
+
result = api_instance.get_composition_embed_settings(id, opts)
|
|
1772
2027
|
p result
|
|
1773
2028
|
rescue ApiSdkRb::ApiError => e
|
|
1774
|
-
puts "Error when calling CompositionsApi->
|
|
2029
|
+
puts "Error when calling CompositionsApi->get_composition_embed_settings: #{e}"
|
|
1775
2030
|
end
|
|
1776
2031
|
```
|
|
1777
2032
|
|
|
1778
|
-
#### Using the
|
|
2033
|
+
#### Using the get_composition_embed_settings_with_http_info variant
|
|
1779
2034
|
|
|
1780
2035
|
This returns an Array which contains the response data, status code and headers.
|
|
1781
2036
|
|
|
1782
|
-
> <Array(<GetCompositionEmbedSettingsResponse>, Integer, Hash)>
|
|
2037
|
+
> <Array(<GetCompositionEmbedSettingsResponse>, Integer, Hash)> get_composition_embed_settings_with_http_info(id, opts)
|
|
1783
2038
|
|
|
1784
2039
|
```ruby
|
|
1785
2040
|
begin
|
|
1786
2041
|
# Get Composition Embed Settings
|
|
1787
|
-
data, status_code, headers = api_instance.
|
|
2042
|
+
data, status_code, headers = api_instance.get_composition_embed_settings_with_http_info(id, opts)
|
|
1788
2043
|
p status_code # => 2xx
|
|
1789
2044
|
p headers # => { ... }
|
|
1790
2045
|
p data # => <GetCompositionEmbedSettingsResponse>
|
|
1791
2046
|
rescue ApiSdkRb::ApiError => e
|
|
1792
|
-
puts "Error when calling CompositionsApi->
|
|
2047
|
+
puts "Error when calling CompositionsApi->get_composition_embed_settings_with_http_info: #{e}"
|
|
1793
2048
|
end
|
|
1794
2049
|
```
|
|
1795
2050
|
|
|
@@ -1798,8 +2053,8 @@ end
|
|
|
1798
2053
|
| Name | Type | Description | Notes |
|
|
1799
2054
|
| ---- | ---- | ----------- | ----- |
|
|
1800
2055
|
| **id** | **String** | ID of the composition | |
|
|
1801
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1802
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2056
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2057
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1803
2058
|
|
|
1804
2059
|
### Return type
|
|
1805
2060
|
|
|
@@ -1815,9 +2070,9 @@ end
|
|
|
1815
2070
|
- **Accept**: application/json
|
|
1816
2071
|
|
|
1817
2072
|
|
|
1818
|
-
##
|
|
2073
|
+
## get_composition_preview
|
|
1819
2074
|
|
|
1820
|
-
> <GetCompositionPreviewResponse>
|
|
2075
|
+
> <GetCompositionPreviewResponse> get_composition_preview(id, opts)
|
|
1821
2076
|
|
|
1822
2077
|
Get Composition Preview
|
|
1823
2078
|
|
|
@@ -1837,34 +2092,34 @@ end
|
|
|
1837
2092
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1838
2093
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
1839
2094
|
opts = {
|
|
1840
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1841
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2095
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2096
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1842
2097
|
}
|
|
1843
2098
|
|
|
1844
2099
|
begin
|
|
1845
2100
|
# Get Composition Preview
|
|
1846
|
-
result = api_instance.
|
|
2101
|
+
result = api_instance.get_composition_preview(id, opts)
|
|
1847
2102
|
p result
|
|
1848
2103
|
rescue ApiSdkRb::ApiError => e
|
|
1849
|
-
puts "Error when calling CompositionsApi->
|
|
2104
|
+
puts "Error when calling CompositionsApi->get_composition_preview: #{e}"
|
|
1850
2105
|
end
|
|
1851
2106
|
```
|
|
1852
2107
|
|
|
1853
|
-
#### Using the
|
|
2108
|
+
#### Using the get_composition_preview_with_http_info variant
|
|
1854
2109
|
|
|
1855
2110
|
This returns an Array which contains the response data, status code and headers.
|
|
1856
2111
|
|
|
1857
|
-
> <Array(<GetCompositionPreviewResponse>, Integer, Hash)>
|
|
2112
|
+
> <Array(<GetCompositionPreviewResponse>, Integer, Hash)> get_composition_preview_with_http_info(id, opts)
|
|
1858
2113
|
|
|
1859
2114
|
```ruby
|
|
1860
2115
|
begin
|
|
1861
2116
|
# Get Composition Preview
|
|
1862
|
-
data, status_code, headers = api_instance.
|
|
2117
|
+
data, status_code, headers = api_instance.get_composition_preview_with_http_info(id, opts)
|
|
1863
2118
|
p status_code # => 2xx
|
|
1864
2119
|
p headers # => { ... }
|
|
1865
2120
|
p data # => <GetCompositionPreviewResponse>
|
|
1866
2121
|
rescue ApiSdkRb::ApiError => e
|
|
1867
|
-
puts "Error when calling CompositionsApi->
|
|
2122
|
+
puts "Error when calling CompositionsApi->get_composition_preview_with_http_info: #{e}"
|
|
1868
2123
|
end
|
|
1869
2124
|
```
|
|
1870
2125
|
|
|
@@ -1873,8 +2128,8 @@ end
|
|
|
1873
2128
|
| Name | Type | Description | Notes |
|
|
1874
2129
|
| ---- | ---- | ----------- | ----- |
|
|
1875
2130
|
| **id** | **String** | ID of the composition | |
|
|
1876
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1877
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2131
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2132
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1878
2133
|
|
|
1879
2134
|
### Return type
|
|
1880
2135
|
|
|
@@ -1890,9 +2145,9 @@ end
|
|
|
1890
2145
|
- **Accept**: application/json
|
|
1891
2146
|
|
|
1892
2147
|
|
|
1893
|
-
##
|
|
2148
|
+
## get_composition_versions
|
|
1894
2149
|
|
|
1895
|
-
> <GetCompositionVersions200Response>
|
|
2150
|
+
> <GetCompositionVersions200Response> get_composition_versions(id, opts)
|
|
1896
2151
|
|
|
1897
2152
|
Get Composition Versions
|
|
1898
2153
|
|
|
@@ -1912,34 +2167,34 @@ end
|
|
|
1912
2167
|
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1913
2168
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Composition ID
|
|
1914
2169
|
opts = {
|
|
1915
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1916
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2170
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2171
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1917
2172
|
}
|
|
1918
2173
|
|
|
1919
2174
|
begin
|
|
1920
2175
|
# Get Composition Versions
|
|
1921
|
-
result = api_instance.
|
|
2176
|
+
result = api_instance.get_composition_versions(id, opts)
|
|
1922
2177
|
p result
|
|
1923
2178
|
rescue ApiSdkRb::ApiError => e
|
|
1924
|
-
puts "Error when calling CompositionsApi->
|
|
2179
|
+
puts "Error when calling CompositionsApi->get_composition_versions: #{e}"
|
|
1925
2180
|
end
|
|
1926
2181
|
```
|
|
1927
2182
|
|
|
1928
|
-
#### Using the
|
|
2183
|
+
#### Using the get_composition_versions_with_http_info variant
|
|
1929
2184
|
|
|
1930
2185
|
This returns an Array which contains the response data, status code and headers.
|
|
1931
2186
|
|
|
1932
|
-
> <Array(<GetCompositionVersions200Response>, Integer, Hash)>
|
|
2187
|
+
> <Array(<GetCompositionVersions200Response>, Integer, Hash)> get_composition_versions_with_http_info(id, opts)
|
|
1933
2188
|
|
|
1934
2189
|
```ruby
|
|
1935
2190
|
begin
|
|
1936
2191
|
# Get Composition Versions
|
|
1937
|
-
data, status_code, headers = api_instance.
|
|
2192
|
+
data, status_code, headers = api_instance.get_composition_versions_with_http_info(id, opts)
|
|
1938
2193
|
p status_code # => 2xx
|
|
1939
2194
|
p headers # => { ... }
|
|
1940
2195
|
p data # => <GetCompositionVersions200Response>
|
|
1941
2196
|
rescue ApiSdkRb::ApiError => e
|
|
1942
|
-
puts "Error when calling CompositionsApi->
|
|
2197
|
+
puts "Error when calling CompositionsApi->get_composition_versions_with_http_info: #{e}"
|
|
1943
2198
|
end
|
|
1944
2199
|
```
|
|
1945
2200
|
|
|
@@ -1948,8 +2203,8 @@ end
|
|
|
1948
2203
|
| Name | Type | Description | Notes |
|
|
1949
2204
|
| ---- | ---- | ----------- | ----- |
|
|
1950
2205
|
| **id** | **String** | Composition ID | |
|
|
1951
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
1952
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2206
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2207
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1953
2208
|
|
|
1954
2209
|
### Return type
|
|
1955
2210
|
|
|
@@ -1965,9 +2220,9 @@ end
|
|
|
1965
2220
|
- **Accept**: application/json
|
|
1966
2221
|
|
|
1967
2222
|
|
|
1968
|
-
##
|
|
2223
|
+
## get_compositions_batch
|
|
1969
2224
|
|
|
1970
|
-
> <GetCompositionsBatchResponse>
|
|
2225
|
+
> <GetCompositionsBatchResponse> get_compositions_batch(get_compositions_batch_request)
|
|
1971
2226
|
|
|
1972
2227
|
Get Compositions Batch
|
|
1973
2228
|
|
|
@@ -1989,28 +2244,28 @@ get_compositions_batch_request = ApiSdkRb::GetCompositionsBatchRequest.new({comp
|
|
|
1989
2244
|
|
|
1990
2245
|
begin
|
|
1991
2246
|
# Get Compositions Batch
|
|
1992
|
-
result = api_instance.
|
|
2247
|
+
result = api_instance.get_compositions_batch(get_compositions_batch_request)
|
|
1993
2248
|
p result
|
|
1994
2249
|
rescue ApiSdkRb::ApiError => e
|
|
1995
|
-
puts "Error when calling CompositionsApi->
|
|
2250
|
+
puts "Error when calling CompositionsApi->get_compositions_batch: #{e}"
|
|
1996
2251
|
end
|
|
1997
2252
|
```
|
|
1998
2253
|
|
|
1999
|
-
#### Using the
|
|
2254
|
+
#### Using the get_compositions_batch_with_http_info variant
|
|
2000
2255
|
|
|
2001
2256
|
This returns an Array which contains the response data, status code and headers.
|
|
2002
2257
|
|
|
2003
|
-
> <Array(<GetCompositionsBatchResponse>, Integer, Hash)>
|
|
2258
|
+
> <Array(<GetCompositionsBatchResponse>, Integer, Hash)> get_compositions_batch_with_http_info(get_compositions_batch_request)
|
|
2004
2259
|
|
|
2005
2260
|
```ruby
|
|
2006
2261
|
begin
|
|
2007
2262
|
# Get Compositions Batch
|
|
2008
|
-
data, status_code, headers = api_instance.
|
|
2263
|
+
data, status_code, headers = api_instance.get_compositions_batch_with_http_info(get_compositions_batch_request)
|
|
2009
2264
|
p status_code # => 2xx
|
|
2010
2265
|
p headers # => { ... }
|
|
2011
2266
|
p data # => <GetCompositionsBatchResponse>
|
|
2012
2267
|
rescue ApiSdkRb::ApiError => e
|
|
2013
|
-
puts "Error when calling CompositionsApi->
|
|
2268
|
+
puts "Error when calling CompositionsApi->get_compositions_batch_with_http_info: #{e}"
|
|
2014
2269
|
end
|
|
2015
2270
|
```
|
|
2016
2271
|
|
|
@@ -2034,9 +2289,100 @@ end
|
|
|
2034
2289
|
- **Accept**: application/json
|
|
2035
2290
|
|
|
2036
2291
|
|
|
2037
|
-
##
|
|
2292
|
+
## list_composition_entry_items
|
|
2293
|
+
|
|
2294
|
+
> <CompositionEntryItemsPageSuccess> list_composition_entry_items(id, table, opts)
|
|
2295
|
+
|
|
2296
|
+
List composition entry items with paging and filters
|
|
2297
|
+
|
|
2298
|
+
Reads one widget table with cursor paging (time then id in byte order), optional since/until on the time column, and up to five context filters plus ten column filters. Rate limit 120 requests per minute. Each read batch uses a 5 s statement timeout.
|
|
2299
|
+
|
|
2300
|
+
### Examples
|
|
2301
|
+
|
|
2302
|
+
```ruby
|
|
2303
|
+
require 'time'
|
|
2304
|
+
require 'api-sdk-rb'
|
|
2305
|
+
# setup authorization
|
|
2306
|
+
ApiSdkRb.configure do |config|
|
|
2307
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
2308
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2309
|
+
end
|
|
2310
|
+
|
|
2311
|
+
api_instance = ApiSdkRb::CompositionsApi.new
|
|
2312
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
2313
|
+
table = 'table_example' # String |
|
|
2314
|
+
opts = {
|
|
2315
|
+
limit: 56, # Integer |
|
|
2316
|
+
order: 'asc', # String | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id.
|
|
2317
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`.
|
|
2318
|
+
_until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`).
|
|
2319
|
+
cursor: 'cursor_example', # String |
|
|
2320
|
+
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
2321
|
+
filter: { key: { key: 'inner_example'}}, # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
2322
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2323
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2324
|
+
}
|
|
2325
|
+
|
|
2326
|
+
begin
|
|
2327
|
+
# List composition entry items with paging and filters
|
|
2328
|
+
result = api_instance.list_composition_entry_items(id, table, opts)
|
|
2329
|
+
p result
|
|
2330
|
+
rescue ApiSdkRb::ApiError => e
|
|
2331
|
+
puts "Error when calling CompositionsApi->list_composition_entry_items: #{e}"
|
|
2332
|
+
end
|
|
2333
|
+
```
|
|
2334
|
+
|
|
2335
|
+
#### Using the list_composition_entry_items_with_http_info variant
|
|
2336
|
+
|
|
2337
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2338
|
+
|
|
2339
|
+
> <Array(<CompositionEntryItemsPageSuccess>, Integer, Hash)> list_composition_entry_items_with_http_info(id, table, opts)
|
|
2340
|
+
|
|
2341
|
+
```ruby
|
|
2342
|
+
begin
|
|
2343
|
+
# List composition entry items with paging and filters
|
|
2344
|
+
data, status_code, headers = api_instance.list_composition_entry_items_with_http_info(id, table, opts)
|
|
2345
|
+
p status_code # => 2xx
|
|
2346
|
+
p headers # => { ... }
|
|
2347
|
+
p data # => <CompositionEntryItemsPageSuccess>
|
|
2348
|
+
rescue ApiSdkRb::ApiError => e
|
|
2349
|
+
puts "Error when calling CompositionsApi->list_composition_entry_items_with_http_info: #{e}"
|
|
2350
|
+
end
|
|
2351
|
+
```
|
|
2352
|
+
|
|
2353
|
+
### Parameters
|
|
2354
|
+
|
|
2355
|
+
| Name | Type | Description | Notes |
|
|
2356
|
+
| ---- | ---- | ----------- | ----- |
|
|
2357
|
+
| **id** | **String** | | |
|
|
2358
|
+
| **table** | **String** | | |
|
|
2359
|
+
| **limit** | **Integer** | | [optional][default to 25] |
|
|
2360
|
+
| **order** | **String** | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id. | [optional][default to 'desc'] |
|
|
2361
|
+
| **since** | **Time** | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`. | [optional] |
|
|
2362
|
+
| **_until** | **Time** | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`). | [optional] |
|
|
2363
|
+
| **cursor** | **String** | | [optional] |
|
|
2364
|
+
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
2365
|
+
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
2366
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2367
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2368
|
+
|
|
2369
|
+
### Return type
|
|
2370
|
+
|
|
2371
|
+
[**CompositionEntryItemsPageSuccess**](CompositionEntryItemsPageSuccess.md)
|
|
2372
|
+
|
|
2373
|
+
### Authorization
|
|
2374
|
+
|
|
2375
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
2376
|
+
|
|
2377
|
+
### HTTP request headers
|
|
2378
|
+
|
|
2379
|
+
- **Content-Type**: Not defined
|
|
2380
|
+
- **Accept**: application/json
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
## patch_composition_content_item
|
|
2038
2384
|
|
|
2039
|
-
> <
|
|
2385
|
+
> <ContentItemWriteResultResponse> patch_composition_content_item(id, list, item_id, idempotency_key, request_body, opts)
|
|
2040
2386
|
|
|
2041
2387
|
Update a content list item
|
|
2042
2388
|
|
|
@@ -2059,34 +2405,34 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
2059
2405
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2060
2406
|
opts = {
|
|
2061
2407
|
if_match: 'if_match_example', # String |
|
|
2062
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2063
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2408
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2409
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2064
2410
|
}
|
|
2065
2411
|
|
|
2066
2412
|
begin
|
|
2067
2413
|
# Update a content list item
|
|
2068
|
-
result = api_instance.
|
|
2414
|
+
result = api_instance.patch_composition_content_item(id, list, item_id, idempotency_key, request_body, opts)
|
|
2069
2415
|
p result
|
|
2070
2416
|
rescue ApiSdkRb::ApiError => e
|
|
2071
|
-
puts "Error when calling CompositionsApi->
|
|
2417
|
+
puts "Error when calling CompositionsApi->patch_composition_content_item: #{e}"
|
|
2072
2418
|
end
|
|
2073
2419
|
```
|
|
2074
2420
|
|
|
2075
|
-
#### Using the
|
|
2421
|
+
#### Using the patch_composition_content_item_with_http_info variant
|
|
2076
2422
|
|
|
2077
2423
|
This returns an Array which contains the response data, status code and headers.
|
|
2078
2424
|
|
|
2079
|
-
> <Array(<
|
|
2425
|
+
> <Array(<ContentItemWriteResultResponse>, Integer, Hash)> patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts)
|
|
2080
2426
|
|
|
2081
2427
|
```ruby
|
|
2082
2428
|
begin
|
|
2083
2429
|
# Update a content list item
|
|
2084
|
-
data, status_code, headers = api_instance.
|
|
2430
|
+
data, status_code, headers = api_instance.patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts)
|
|
2085
2431
|
p status_code # => 2xx
|
|
2086
2432
|
p headers # => { ... }
|
|
2087
|
-
p data # => <
|
|
2433
|
+
p data # => <ContentItemWriteResultResponse>
|
|
2088
2434
|
rescue ApiSdkRb::ApiError => e
|
|
2089
|
-
puts "Error when calling CompositionsApi->
|
|
2435
|
+
puts "Error when calling CompositionsApi->patch_composition_content_item_with_http_info: #{e}"
|
|
2090
2436
|
end
|
|
2091
2437
|
```
|
|
2092
2438
|
|
|
@@ -2100,12 +2446,12 @@ end
|
|
|
2100
2446
|
| **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`). | |
|
|
2101
2447
|
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2102
2448
|
| **if_match** | **String** | | [optional] |
|
|
2103
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2104
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2449
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2450
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2105
2451
|
|
|
2106
2452
|
### Return type
|
|
2107
2453
|
|
|
2108
|
-
[**
|
|
2454
|
+
[**ContentItemWriteResultResponse**](ContentItemWriteResultResponse.md)
|
|
2109
2455
|
|
|
2110
2456
|
### Authorization
|
|
2111
2457
|
|
|
@@ -2117,9 +2463,9 @@ end
|
|
|
2117
2463
|
- **Accept**: application/json
|
|
2118
2464
|
|
|
2119
2465
|
|
|
2120
|
-
##
|
|
2466
|
+
## read_composition_entries
|
|
2121
2467
|
|
|
2122
|
-
> <CompositionEntriesReadingResponse>
|
|
2468
|
+
> <CompositionEntriesReadingResponse> read_composition_entries(id, table, opts)
|
|
2123
2469
|
|
|
2124
2470
|
Read the Entries of a Composition's Table
|
|
2125
2471
|
|
|
@@ -2148,34 +2494,34 @@ opts = {
|
|
|
2148
2494
|
_until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`).
|
|
2149
2495
|
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
2150
2496
|
filter: { key: { key: 'inner_example'}}, # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
2151
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2152
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2497
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2498
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2153
2499
|
}
|
|
2154
2500
|
|
|
2155
2501
|
begin
|
|
2156
2502
|
# Read the Entries of a Composition's Table
|
|
2157
|
-
result = api_instance.
|
|
2503
|
+
result = api_instance.read_composition_entries(id, table, opts)
|
|
2158
2504
|
p result
|
|
2159
2505
|
rescue ApiSdkRb::ApiError => e
|
|
2160
|
-
puts "Error when calling CompositionsApi->
|
|
2506
|
+
puts "Error when calling CompositionsApi->read_composition_entries: #{e}"
|
|
2161
2507
|
end
|
|
2162
2508
|
```
|
|
2163
2509
|
|
|
2164
|
-
#### Using the
|
|
2510
|
+
#### Using the read_composition_entries_with_http_info variant
|
|
2165
2511
|
|
|
2166
2512
|
This returns an Array which contains the response data, status code and headers.
|
|
2167
2513
|
|
|
2168
|
-
> <Array(<CompositionEntriesReadingResponse>, Integer, Hash)>
|
|
2514
|
+
> <Array(<CompositionEntriesReadingResponse>, Integer, Hash)> read_composition_entries_with_http_info(id, table, opts)
|
|
2169
2515
|
|
|
2170
2516
|
```ruby
|
|
2171
2517
|
begin
|
|
2172
2518
|
# Read the Entries of a Composition's Table
|
|
2173
|
-
data, status_code, headers = api_instance.
|
|
2519
|
+
data, status_code, headers = api_instance.read_composition_entries_with_http_info(id, table, opts)
|
|
2174
2520
|
p status_code # => 2xx
|
|
2175
2521
|
p headers # => { ... }
|
|
2176
2522
|
p data # => <CompositionEntriesReadingResponse>
|
|
2177
2523
|
rescue ApiSdkRb::ApiError => e
|
|
2178
|
-
puts "Error when calling CompositionsApi->
|
|
2524
|
+
puts "Error when calling CompositionsApi->read_composition_entries_with_http_info: #{e}"
|
|
2179
2525
|
end
|
|
2180
2526
|
```
|
|
2181
2527
|
|
|
@@ -2193,8 +2539,8 @@ end
|
|
|
2193
2539
|
| **_until** | **Time** | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`). | [optional] |
|
|
2194
2540
|
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
2195
2541
|
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
2196
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2197
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2542
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2543
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2198
2544
|
|
|
2199
2545
|
### Return type
|
|
2200
2546
|
|
|
@@ -2210,9 +2556,9 @@ end
|
|
|
2210
2556
|
- **Accept**: application/json
|
|
2211
2557
|
|
|
2212
2558
|
|
|
2213
|
-
##
|
|
2559
|
+
## remove_ai_answers_knowledge_document
|
|
2214
2560
|
|
|
2215
|
-
> <RemoveAiAnswersKnowledgeDocument200Response>
|
|
2561
|
+
> <RemoveAiAnswersKnowledgeDocument200Response> remove_ai_answers_knowledge_document(id, document_id, opts)
|
|
2216
2562
|
|
|
2217
2563
|
Remove a document from a widget's knowledge base
|
|
2218
2564
|
|
|
@@ -2233,34 +2579,34 @@ api_instance = ApiSdkRb::CompositionsApi.new
|
|
|
2233
2579
|
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The widget (composition) the document is in
|
|
2234
2580
|
document_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The document to remove
|
|
2235
2581
|
opts = {
|
|
2236
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2237
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2582
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2583
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2238
2584
|
}
|
|
2239
2585
|
|
|
2240
2586
|
begin
|
|
2241
2587
|
# Remove a document from a widget's knowledge base
|
|
2242
|
-
result = api_instance.
|
|
2588
|
+
result = api_instance.remove_ai_answers_knowledge_document(id, document_id, opts)
|
|
2243
2589
|
p result
|
|
2244
2590
|
rescue ApiSdkRb::ApiError => e
|
|
2245
|
-
puts "Error when calling CompositionsApi->
|
|
2591
|
+
puts "Error when calling CompositionsApi->remove_ai_answers_knowledge_document: #{e}"
|
|
2246
2592
|
end
|
|
2247
2593
|
```
|
|
2248
2594
|
|
|
2249
|
-
#### Using the
|
|
2595
|
+
#### Using the remove_ai_answers_knowledge_document_with_http_info variant
|
|
2250
2596
|
|
|
2251
2597
|
This returns an Array which contains the response data, status code and headers.
|
|
2252
2598
|
|
|
2253
|
-
> <Array(<RemoveAiAnswersKnowledgeDocument200Response>, Integer, Hash)>
|
|
2599
|
+
> <Array(<RemoveAiAnswersKnowledgeDocument200Response>, Integer, Hash)> remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts)
|
|
2254
2600
|
|
|
2255
2601
|
```ruby
|
|
2256
2602
|
begin
|
|
2257
2603
|
# Remove a document from a widget's knowledge base
|
|
2258
|
-
data, status_code, headers = api_instance.
|
|
2604
|
+
data, status_code, headers = api_instance.remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts)
|
|
2259
2605
|
p status_code # => 2xx
|
|
2260
2606
|
p headers # => { ... }
|
|
2261
2607
|
p data # => <RemoveAiAnswersKnowledgeDocument200Response>
|
|
2262
2608
|
rescue ApiSdkRb::ApiError => e
|
|
2263
|
-
puts "Error when calling CompositionsApi->
|
|
2609
|
+
puts "Error when calling CompositionsApi->remove_ai_answers_knowledge_document_with_http_info: #{e}"
|
|
2264
2610
|
end
|
|
2265
2611
|
```
|
|
2266
2612
|
|
|
@@ -2270,8 +2616,8 @@ end
|
|
|
2270
2616
|
| ---- | ---- | ----------- | ----- |
|
|
2271
2617
|
| **id** | **String** | The widget (composition) the document is in | |
|
|
2272
2618
|
| **document_id** | **String** | The document to remove | |
|
|
2273
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2274
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2619
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2620
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2275
2621
|
|
|
2276
2622
|
### Return type
|
|
2277
2623
|
|
|
@@ -2287,9 +2633,9 @@ end
|
|
|
2287
2633
|
- **Accept**: application/json
|
|
2288
2634
|
|
|
2289
2635
|
|
|
2290
|
-
##
|
|
2636
|
+
## set_composition_data_source
|
|
2291
2637
|
|
|
2292
|
-
> <CompositionDataSourceResponse>
|
|
2638
|
+
> <CompositionDataSourceResponse> set_composition_data_source(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2293
2639
|
|
|
2294
2640
|
Bind a public JSON data source for embed refresh
|
|
2295
2641
|
|
|
@@ -2311,34 +2657,34 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
|
2311
2657
|
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`).
|
|
2312
2658
|
set_composition_data_source_request = ApiSdkRb::SetCompositionDataSourceRequest.new({url: 'url_example', refresh_seconds: 37}) # SetCompositionDataSourceRequest |
|
|
2313
2659
|
opts = {
|
|
2314
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2315
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2660
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2661
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2316
2662
|
}
|
|
2317
2663
|
|
|
2318
2664
|
begin
|
|
2319
2665
|
# Bind a public JSON data source for embed refresh
|
|
2320
|
-
result = api_instance.
|
|
2666
|
+
result = api_instance.set_composition_data_source(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2321
2667
|
p result
|
|
2322
2668
|
rescue ApiSdkRb::ApiError => e
|
|
2323
|
-
puts "Error when calling CompositionsApi->
|
|
2669
|
+
puts "Error when calling CompositionsApi->set_composition_data_source: #{e}"
|
|
2324
2670
|
end
|
|
2325
2671
|
```
|
|
2326
2672
|
|
|
2327
|
-
#### Using the
|
|
2673
|
+
#### Using the set_composition_data_source_with_http_info variant
|
|
2328
2674
|
|
|
2329
2675
|
This returns an Array which contains the response data, status code and headers.
|
|
2330
2676
|
|
|
2331
|
-
> <Array(<CompositionDataSourceResponse>, Integer, Hash)>
|
|
2677
|
+
> <Array(<CompositionDataSourceResponse>, Integer, Hash)> set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2332
2678
|
|
|
2333
2679
|
```ruby
|
|
2334
2680
|
begin
|
|
2335
2681
|
# Bind a public JSON data source for embed refresh
|
|
2336
|
-
data, status_code, headers = api_instance.
|
|
2682
|
+
data, status_code, headers = api_instance.set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2337
2683
|
p status_code # => 2xx
|
|
2338
2684
|
p headers # => { ... }
|
|
2339
2685
|
p data # => <CompositionDataSourceResponse>
|
|
2340
2686
|
rescue ApiSdkRb::ApiError => e
|
|
2341
|
-
puts "Error when calling CompositionsApi->
|
|
2687
|
+
puts "Error when calling CompositionsApi->set_composition_data_source_with_http_info: #{e}"
|
|
2342
2688
|
end
|
|
2343
2689
|
```
|
|
2344
2690
|
|
|
@@ -2349,8 +2695,8 @@ end
|
|
|
2349
2695
|
| **id** | **String** | | |
|
|
2350
2696
|
| **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`). | |
|
|
2351
2697
|
| **set_composition_data_source_request** | [**SetCompositionDataSourceRequest**](SetCompositionDataSourceRequest.md) | | |
|
|
2352
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2353
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2698
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2699
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2354
2700
|
|
|
2355
2701
|
### Return type
|
|
2356
2702
|
|
|
@@ -2366,9 +2712,9 @@ end
|
|
|
2366
2712
|
- **Accept**: application/json
|
|
2367
2713
|
|
|
2368
2714
|
|
|
2369
|
-
##
|
|
2715
|
+
## set_dynamic_content
|
|
2370
2716
|
|
|
2371
|
-
> <SetDynamicContentResponse>
|
|
2717
|
+
> <SetDynamicContentResponse> set_dynamic_content(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2372
2718
|
|
|
2373
2719
|
Set Dynamic Content
|
|
2374
2720
|
|
|
@@ -2391,34 +2737,34 @@ idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a
|
|
|
2391
2737
|
set_dynamic_content_request = ApiSdkRb::SetDynamicContentRequest.new({content: 3.56}) # SetDynamicContentRequest |
|
|
2392
2738
|
opts = {
|
|
2393
2739
|
if_match: 'if_match_example', # String | Optional content version from ETag (`\"3\"`, `3`, or `*`)
|
|
2394
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2395
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2740
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2741
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2396
2742
|
}
|
|
2397
2743
|
|
|
2398
2744
|
begin
|
|
2399
2745
|
# Set Dynamic Content
|
|
2400
|
-
result = api_instance.
|
|
2746
|
+
result = api_instance.set_dynamic_content(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2401
2747
|
p result
|
|
2402
2748
|
rescue ApiSdkRb::ApiError => e
|
|
2403
|
-
puts "Error when calling CompositionsApi->
|
|
2749
|
+
puts "Error when calling CompositionsApi->set_dynamic_content: #{e}"
|
|
2404
2750
|
end
|
|
2405
2751
|
```
|
|
2406
2752
|
|
|
2407
|
-
#### Using the
|
|
2753
|
+
#### Using the set_dynamic_content_with_http_info variant
|
|
2408
2754
|
|
|
2409
2755
|
This returns an Array which contains the response data, status code and headers.
|
|
2410
2756
|
|
|
2411
|
-
> <Array(<SetDynamicContentResponse>, Integer, Hash)>
|
|
2757
|
+
> <Array(<SetDynamicContentResponse>, Integer, Hash)> set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2412
2758
|
|
|
2413
2759
|
```ruby
|
|
2414
2760
|
begin
|
|
2415
2761
|
# Set Dynamic Content
|
|
2416
|
-
data, status_code, headers = api_instance.
|
|
2762
|
+
data, status_code, headers = api_instance.set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2417
2763
|
p status_code # => 2xx
|
|
2418
2764
|
p headers # => { ... }
|
|
2419
2765
|
p data # => <SetDynamicContentResponse>
|
|
2420
2766
|
rescue ApiSdkRb::ApiError => e
|
|
2421
|
-
puts "Error when calling CompositionsApi->
|
|
2767
|
+
puts "Error when calling CompositionsApi->set_dynamic_content_with_http_info: #{e}"
|
|
2422
2768
|
end
|
|
2423
2769
|
```
|
|
2424
2770
|
|
|
@@ -2430,8 +2776,8 @@ end
|
|
|
2430
2776
|
| **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`). | |
|
|
2431
2777
|
| **set_dynamic_content_request** | [**SetDynamicContentRequest**](SetDynamicContentRequest.md) | | |
|
|
2432
2778
|
| **if_match** | **String** | Optional content version from ETag (`\"3\"`, `3`, or `*`) | [optional] |
|
|
2433
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2434
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2779
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2780
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2435
2781
|
|
|
2436
2782
|
### Return type
|
|
2437
2783
|
|
|
@@ -2447,13 +2793,13 @@ end
|
|
|
2447
2793
|
- **Accept**: application/json
|
|
2448
2794
|
|
|
2449
2795
|
|
|
2450
|
-
##
|
|
2796
|
+
## update_composition
|
|
2451
2797
|
|
|
2452
|
-
> <
|
|
2798
|
+
> <CompositionResponse> update_composition(id, idempotency_key, update_composition, opts)
|
|
2453
2799
|
|
|
2454
2800
|
Update Composition
|
|
2455
2801
|
|
|
2456
|
-
Updates a specific composition. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry. An editor session (see `createManagedUserEditorSession`) can send only `name`, `content`, `design` and `embedSettings`, and only for a composition made for its managed user. A body that names any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`. Send `databaseSchema` to add tables to the composition: the tables that are missing are made, and the ones that exist are left as they are. A `databaseSchema` that cannot be used is refused before anything is saved, with `400` and `INVALID_DATABASE_SCHEMA`. If the composition is saved but its tables cannot be made just now, the answer is still `200` and `meta.warnings` says so.
|
|
2802
|
+
Updates a specific composition. The `Idempotency-Key` header is required (`400` without it). Send the same key when you retry. An editor session (see `createManagedUserEditorSession`) can send only `name`, `content`, `design` and `embedSettings`, and only for a composition made for its managed user. A body that names any other field is refused with `403` and `EDITOR_SESSION_FIELD_NOT_ALLOWED`. Send `databaseSchema` to add tables to the composition: the tables that are missing are made, and the ones that exist are left as they are. A `databaseSchema` that cannot be used is refused before anything is saved, with `400` and `INVALID_DATABASE_SCHEMA`. If the composition is saved but its tables cannot be made just now, the answer is still `200` and `meta.warnings` says so. **When several people edit the same composition.** A save that carries `content` can name the content version it started from in the `If-Match` header (the `contentVersion` of the composition you read, or the `ETag` of an earlier answer). If somebody saved the content since, nothing is overwritten: the save is refused with `412` and `CONTENT_VERSION_MISMATCH`, and `error.details.currentVersion` is the version to start again from. For a composition a team shares, `error.details` also says who got there first: `lastEditedBy` (`{ id, name }`, or `null` when nobody can be named) and `lastEditedAt`. An editor session, or a call made for one managed user, is told the version only. A save without `If-Match` still goes through, and the other person's change is replaced, as it always was.
|
|
2457
2803
|
|
|
2458
2804
|
### Examples
|
|
2459
2805
|
|
|
@@ -2471,34 +2817,35 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Composition ID
|
|
|
2471
2817
|
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`).
|
|
2472
2818
|
update_composition = ApiSdkRb::UpdateComposition.new # UpdateComposition |
|
|
2473
2819
|
opts = {
|
|
2474
|
-
|
|
2475
|
-
|
|
2820
|
+
if_match: 'if_match_example', # String | Optional content version from `contentVersion` or an `ETag` (`\"3\"`, `3`, or `*`). Read only when the body has `content`.
|
|
2821
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2822
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2476
2823
|
}
|
|
2477
2824
|
|
|
2478
2825
|
begin
|
|
2479
2826
|
# Update Composition
|
|
2480
|
-
result = api_instance.
|
|
2827
|
+
result = api_instance.update_composition(id, idempotency_key, update_composition, opts)
|
|
2481
2828
|
p result
|
|
2482
2829
|
rescue ApiSdkRb::ApiError => e
|
|
2483
|
-
puts "Error when calling CompositionsApi->
|
|
2830
|
+
puts "Error when calling CompositionsApi->update_composition: #{e}"
|
|
2484
2831
|
end
|
|
2485
2832
|
```
|
|
2486
2833
|
|
|
2487
|
-
#### Using the
|
|
2834
|
+
#### Using the update_composition_with_http_info variant
|
|
2488
2835
|
|
|
2489
2836
|
This returns an Array which contains the response data, status code and headers.
|
|
2490
2837
|
|
|
2491
|
-
> <Array(<
|
|
2838
|
+
> <Array(<CompositionResponse>, Integer, Hash)> update_composition_with_http_info(id, idempotency_key, update_composition, opts)
|
|
2492
2839
|
|
|
2493
2840
|
```ruby
|
|
2494
2841
|
begin
|
|
2495
2842
|
# Update Composition
|
|
2496
|
-
data, status_code, headers = api_instance.
|
|
2843
|
+
data, status_code, headers = api_instance.update_composition_with_http_info(id, idempotency_key, update_composition, opts)
|
|
2497
2844
|
p status_code # => 2xx
|
|
2498
2845
|
p headers # => { ... }
|
|
2499
|
-
p data # => <
|
|
2846
|
+
p data # => <CompositionResponse>
|
|
2500
2847
|
rescue ApiSdkRb::ApiError => e
|
|
2501
|
-
puts "Error when calling CompositionsApi->
|
|
2848
|
+
puts "Error when calling CompositionsApi->update_composition_with_http_info: #{e}"
|
|
2502
2849
|
end
|
|
2503
2850
|
```
|
|
2504
2851
|
|
|
@@ -2509,12 +2856,13 @@ end
|
|
|
2509
2856
|
| **id** | **String** | Composition ID | |
|
|
2510
2857
|
| **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`). | |
|
|
2511
2858
|
| **update_composition** | [**UpdateComposition**](UpdateComposition.md) | | |
|
|
2512
|
-
| **
|
|
2513
|
-
| **
|
|
2859
|
+
| **if_match** | **String** | Optional content version from `contentVersion` or an `ETag` (`\"3\"`, `3`, or `*`). Read only when the body has `content`. | [optional] |
|
|
2860
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2861
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2514
2862
|
|
|
2515
2863
|
### Return type
|
|
2516
2864
|
|
|
2517
|
-
[**
|
|
2865
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
2518
2866
|
|
|
2519
2867
|
### Authorization
|
|
2520
2868
|
|
|
@@ -2526,9 +2874,9 @@ end
|
|
|
2526
2874
|
- **Accept**: application/json
|
|
2527
2875
|
|
|
2528
2876
|
|
|
2529
|
-
##
|
|
2877
|
+
## update_composition_database_record
|
|
2530
2878
|
|
|
2531
|
-
> <
|
|
2879
|
+
> <CompositionDatabaseRecordResponse> update_composition_database_record(id, table, record_id, idempotency_key, body, opts)
|
|
2532
2880
|
|
|
2533
2881
|
Update Record In Composition Database
|
|
2534
2882
|
|
|
@@ -2552,34 +2900,34 @@ record_id = 'record_id_example' # String | ID of the record to update
|
|
|
2552
2900
|
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`).
|
|
2553
2901
|
body = { ... } # Object |
|
|
2554
2902
|
opts = {
|
|
2555
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2556
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2903
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2904
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2557
2905
|
}
|
|
2558
2906
|
|
|
2559
2907
|
begin
|
|
2560
2908
|
# Update Record In Composition Database
|
|
2561
|
-
result = api_instance.
|
|
2909
|
+
result = api_instance.update_composition_database_record(id, table, record_id, idempotency_key, body, opts)
|
|
2562
2910
|
p result
|
|
2563
2911
|
rescue ApiSdkRb::ApiError => e
|
|
2564
|
-
puts "Error when calling CompositionsApi->
|
|
2912
|
+
puts "Error when calling CompositionsApi->update_composition_database_record: #{e}"
|
|
2565
2913
|
end
|
|
2566
2914
|
```
|
|
2567
2915
|
|
|
2568
|
-
#### Using the
|
|
2916
|
+
#### Using the update_composition_database_record_with_http_info variant
|
|
2569
2917
|
|
|
2570
2918
|
This returns an Array which contains the response data, status code and headers.
|
|
2571
2919
|
|
|
2572
|
-
> <Array(<
|
|
2920
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts)
|
|
2573
2921
|
|
|
2574
2922
|
```ruby
|
|
2575
2923
|
begin
|
|
2576
2924
|
# Update Record In Composition Database
|
|
2577
|
-
data, status_code, headers = api_instance.
|
|
2925
|
+
data, status_code, headers = api_instance.update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts)
|
|
2578
2926
|
p status_code # => 2xx
|
|
2579
2927
|
p headers # => { ... }
|
|
2580
|
-
p data # => <
|
|
2928
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
2581
2929
|
rescue ApiSdkRb::ApiError => e
|
|
2582
|
-
puts "Error when calling CompositionsApi->
|
|
2930
|
+
puts "Error when calling CompositionsApi->update_composition_database_record_with_http_info: #{e}"
|
|
2583
2931
|
end
|
|
2584
2932
|
```
|
|
2585
2933
|
|
|
@@ -2592,12 +2940,12 @@ end
|
|
|
2592
2940
|
| **record_id** | **String** | ID of the record to update | |
|
|
2593
2941
|
| **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`). | |
|
|
2594
2942
|
| **body** | **Object** | | |
|
|
2595
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2596
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2943
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2944
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2597
2945
|
|
|
2598
2946
|
### Return type
|
|
2599
2947
|
|
|
2600
|
-
[**
|
|
2948
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
2601
2949
|
|
|
2602
2950
|
### Authorization
|
|
2603
2951
|
|
|
@@ -2609,9 +2957,9 @@ end
|
|
|
2609
2957
|
- **Accept**: application/json
|
|
2610
2958
|
|
|
2611
2959
|
|
|
2612
|
-
##
|
|
2960
|
+
## update_composition_status
|
|
2613
2961
|
|
|
2614
|
-
> <CompositionResponse>
|
|
2962
|
+
> <CompositionResponse> update_composition_status(id, idempotency_key, update_composition_status_request, opts)
|
|
2615
2963
|
|
|
2616
2964
|
Update Composition Status
|
|
2617
2965
|
|
|
@@ -2633,34 +2981,34 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Composition ID
|
|
|
2633
2981
|
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`).
|
|
2634
2982
|
update_composition_status_request = ApiSdkRb::UpdateCompositionStatusRequest.new({status: 'draft'}) # UpdateCompositionStatusRequest |
|
|
2635
2983
|
opts = {
|
|
2636
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2637
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2984
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2985
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2638
2986
|
}
|
|
2639
2987
|
|
|
2640
2988
|
begin
|
|
2641
2989
|
# Update Composition Status
|
|
2642
|
-
result = api_instance.
|
|
2990
|
+
result = api_instance.update_composition_status(id, idempotency_key, update_composition_status_request, opts)
|
|
2643
2991
|
p result
|
|
2644
2992
|
rescue ApiSdkRb::ApiError => e
|
|
2645
|
-
puts "Error when calling CompositionsApi->
|
|
2993
|
+
puts "Error when calling CompositionsApi->update_composition_status: #{e}"
|
|
2646
2994
|
end
|
|
2647
2995
|
```
|
|
2648
2996
|
|
|
2649
|
-
#### Using the
|
|
2997
|
+
#### Using the update_composition_status_with_http_info variant
|
|
2650
2998
|
|
|
2651
2999
|
This returns an Array which contains the response data, status code and headers.
|
|
2652
3000
|
|
|
2653
|
-
> <Array(<CompositionResponse>, Integer, Hash)>
|
|
3001
|
+
> <Array(<CompositionResponse>, Integer, Hash)> update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts)
|
|
2654
3002
|
|
|
2655
3003
|
```ruby
|
|
2656
3004
|
begin
|
|
2657
3005
|
# Update Composition Status
|
|
2658
|
-
data, status_code, headers = api_instance.
|
|
3006
|
+
data, status_code, headers = api_instance.update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts)
|
|
2659
3007
|
p status_code # => 2xx
|
|
2660
3008
|
p headers # => { ... }
|
|
2661
3009
|
p data # => <CompositionResponse>
|
|
2662
3010
|
rescue ApiSdkRb::ApiError => e
|
|
2663
|
-
puts "Error when calling CompositionsApi->
|
|
3011
|
+
puts "Error when calling CompositionsApi->update_composition_status_with_http_info: #{e}"
|
|
2664
3012
|
end
|
|
2665
3013
|
```
|
|
2666
3014
|
|
|
@@ -2671,8 +3019,8 @@ end
|
|
|
2671
3019
|
| **id** | **String** | Composition ID | |
|
|
2672
3020
|
| **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`). | |
|
|
2673
3021
|
| **update_composition_status_request** | [**UpdateCompositionStatusRequest**](UpdateCompositionStatusRequest.md) | | |
|
|
2674
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2675
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
3022
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
3023
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2676
3024
|
|
|
2677
3025
|
### Return type
|
|
2678
3026
|
|
|
@@ -2688,9 +3036,9 @@ end
|
|
|
2688
3036
|
- **Accept**: application/json
|
|
2689
3037
|
|
|
2690
3038
|
|
|
2691
|
-
##
|
|
3039
|
+
## validate_composition_content
|
|
2692
3040
|
|
|
2693
|
-
> <ValidateCompositionContentResponse>
|
|
3041
|
+
> <ValidateCompositionContentResponse> validate_composition_content(id, idempotency_key, request_body, opts)
|
|
2694
3042
|
|
|
2695
3043
|
Validate Content
|
|
2696
3044
|
|
|
@@ -2712,34 +3060,34 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the composition
|
|
|
2712
3060
|
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`).
|
|
2713
3061
|
request_body = { key: 3.56} # Hash<String, Object> |
|
|
2714
3062
|
opts = {
|
|
2715
|
-
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2716
|
-
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
3063
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
3064
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2717
3065
|
}
|
|
2718
3066
|
|
|
2719
3067
|
begin
|
|
2720
3068
|
# Validate Content
|
|
2721
|
-
result = api_instance.
|
|
3069
|
+
result = api_instance.validate_composition_content(id, idempotency_key, request_body, opts)
|
|
2722
3070
|
p result
|
|
2723
3071
|
rescue ApiSdkRb::ApiError => e
|
|
2724
|
-
puts "Error when calling CompositionsApi->
|
|
3072
|
+
puts "Error when calling CompositionsApi->validate_composition_content: #{e}"
|
|
2725
3073
|
end
|
|
2726
3074
|
```
|
|
2727
3075
|
|
|
2728
|
-
#### Using the
|
|
3076
|
+
#### Using the validate_composition_content_with_http_info variant
|
|
2729
3077
|
|
|
2730
3078
|
This returns an Array which contains the response data, status code and headers.
|
|
2731
3079
|
|
|
2732
|
-
> <Array(<ValidateCompositionContentResponse>, Integer, Hash)>
|
|
3080
|
+
> <Array(<ValidateCompositionContentResponse>, Integer, Hash)> validate_composition_content_with_http_info(id, idempotency_key, request_body, opts)
|
|
2733
3081
|
|
|
2734
3082
|
```ruby
|
|
2735
3083
|
begin
|
|
2736
3084
|
# Validate Content
|
|
2737
|
-
data, status_code, headers = api_instance.
|
|
3085
|
+
data, status_code, headers = api_instance.validate_composition_content_with_http_info(id, idempotency_key, request_body, opts)
|
|
2738
3086
|
p status_code # => 2xx
|
|
2739
3087
|
p headers # => { ... }
|
|
2740
3088
|
p data # => <ValidateCompositionContentResponse>
|
|
2741
3089
|
rescue ApiSdkRb::ApiError => e
|
|
2742
|
-
puts "Error when calling CompositionsApi->
|
|
3090
|
+
puts "Error when calling CompositionsApi->validate_composition_content_with_http_info: #{e}"
|
|
2743
3091
|
end
|
|
2744
3092
|
```
|
|
2745
3093
|
|
|
@@ -2750,8 +3098,8 @@ end
|
|
|
2750
3098
|
| **id** | **String** | ID of the composition | |
|
|
2751
3099
|
| **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`). | |
|
|
2752
3100
|
| **request_body** | [**Hash<String, Object>**](Object.md) | | |
|
|
2753
|
-
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
2754
|
-
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions: a list shows only theirs, a composition the call makes is filed under them, and
|
|
3101
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
3102
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2755
3103
|
|
|
2756
3104
|
### Return type
|
|
2757
3105
|
|