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
|
@@ -20,44 +20,44 @@ module ApiSdkRb
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Add a document for a widget's AI to answer from
|
|
23
|
-
# 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).
|
|
23
|
+
# 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'.
|
|
24
24
|
# @param id [String] The widget (composition) to add the document to
|
|
25
25
|
# @param add_ai_answers_knowledge_document_request [AddAiAnswersKnowledgeDocumentRequest]
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
|
-
# @option opts [String] :x_managed_user_id 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
|
|
28
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
29
|
-
# @return [
|
|
30
|
-
def
|
|
31
|
-
data, _status_code, _headers =
|
|
27
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
28
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
29
|
+
# @return [AiAnswersKnowledgeDocumentResponse]
|
|
30
|
+
def add_ai_answers_knowledge_document(id, add_ai_answers_knowledge_document_request, opts = {})
|
|
31
|
+
data, _status_code, _headers = add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts)
|
|
32
32
|
data
|
|
33
33
|
end
|
|
34
34
|
|
|
35
35
|
# Add a document for a widget's AI to answer from
|
|
36
|
-
# 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).
|
|
36
|
+
# 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'.
|
|
37
37
|
# @param id [String] The widget (composition) to add the document to
|
|
38
38
|
# @param add_ai_answers_knowledge_document_request [AddAiAnswersKnowledgeDocumentRequest]
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
|
-
# @option opts [String] :x_managed_user_id 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
|
|
41
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
42
|
-
# @return [Array<(
|
|
43
|
-
def
|
|
40
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
41
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
42
|
+
# @return [Array<(AiAnswersKnowledgeDocumentResponse, Integer, Hash)>] AiAnswersKnowledgeDocumentResponse data, response status code and response headers
|
|
43
|
+
def add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts = {})
|
|
44
44
|
if @api_client.config.debugging
|
|
45
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
45
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.add_ai_answers_knowledge_document ...'
|
|
46
46
|
end
|
|
47
47
|
# verify the required parameter 'id' is set
|
|
48
48
|
if @api_client.config.client_side_validation && id.nil?
|
|
49
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.add_ai_answers_knowledge_document"
|
|
50
50
|
end
|
|
51
51
|
# verify the required parameter 'add_ai_answers_knowledge_document_request' is set
|
|
52
52
|
if @api_client.config.client_side_validation && add_ai_answers_knowledge_document_request.nil?
|
|
53
|
-
fail ArgumentError, "Missing the required parameter 'add_ai_answers_knowledge_document_request' when calling CompositionsApi.
|
|
53
|
+
fail ArgumentError, "Missing the required parameter 'add_ai_answers_knowledge_document_request' when calling CompositionsApi.add_ai_answers_knowledge_document"
|
|
54
54
|
end
|
|
55
55
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
56
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
56
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_document, the character length must be smaller than or equal to 255.'
|
|
57
57
|
end
|
|
58
58
|
|
|
59
59
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
60
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
60
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_document, the character length must be great than or equal to 1.'
|
|
61
61
|
end
|
|
62
62
|
|
|
63
63
|
# resource path
|
|
@@ -85,13 +85,13 @@ module ApiSdkRb
|
|
|
85
85
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(add_ai_answers_knowledge_document_request)
|
|
86
86
|
|
|
87
87
|
# return_type
|
|
88
|
-
return_type = opts[:debug_return_type] || '
|
|
88
|
+
return_type = opts[:debug_return_type] || 'AiAnswersKnowledgeDocumentResponse'
|
|
89
89
|
|
|
90
90
|
# auth_names
|
|
91
91
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
92
92
|
|
|
93
93
|
new_options = opts.merge(
|
|
94
|
-
:operation => :"CompositionsApi.
|
|
94
|
+
:operation => :"CompositionsApi.add_ai_answers_knowledge_document",
|
|
95
95
|
:header_params => header_params,
|
|
96
96
|
:query_params => query_params,
|
|
97
97
|
:form_params => form_params,
|
|
@@ -102,7 +102,103 @@ module ApiSdkRb
|
|
|
102
102
|
|
|
103
103
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
104
104
|
if @api_client.config.debugging
|
|
105
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
105
|
+
@api_client.config.logger.debug "API called: CompositionsApi#add_ai_answers_knowledge_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
106
|
+
end
|
|
107
|
+
return data, status_code, headers
|
|
108
|
+
end
|
|
109
|
+
|
|
110
|
+
# Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
111
|
+
# 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'.
|
|
112
|
+
# @param id [String] The widget (composition) to add the document to
|
|
113
|
+
# @param file [File] The file, which is a text file or a picture of a document (a PDF is not read yet). One file only
|
|
114
|
+
# @param [Hash] opts the optional parameters
|
|
115
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
116
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
117
|
+
# @option opts [String] :title 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
|
|
118
|
+
# @return [AiAnswersKnowledgeDocumentResponse]
|
|
119
|
+
def add_ai_answers_knowledge_file(id, file, opts = {})
|
|
120
|
+
data, _status_code, _headers = add_ai_answers_knowledge_file_with_http_info(id, file, opts)
|
|
121
|
+
data
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
# Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
125
|
+
# 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'.
|
|
126
|
+
# @param id [String] The widget (composition) to add the document to
|
|
127
|
+
# @param file [File] The file, which is a text file or a picture of a document (a PDF is not read yet). One file only
|
|
128
|
+
# @param [Hash] opts the optional parameters
|
|
129
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
130
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
131
|
+
# @option opts [String] :title 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
|
|
132
|
+
# @return [Array<(AiAnswersKnowledgeDocumentResponse, Integer, Hash)>] AiAnswersKnowledgeDocumentResponse data, response status code and response headers
|
|
133
|
+
def add_ai_answers_knowledge_file_with_http_info(id, file, opts = {})
|
|
134
|
+
if @api_client.config.debugging
|
|
135
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.add_ai_answers_knowledge_file ...'
|
|
136
|
+
end
|
|
137
|
+
# verify the required parameter 'id' is set
|
|
138
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
139
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.add_ai_answers_knowledge_file"
|
|
140
|
+
end
|
|
141
|
+
# verify the required parameter 'file' is set
|
|
142
|
+
if @api_client.config.client_side_validation && file.nil?
|
|
143
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling CompositionsApi.add_ai_answers_knowledge_file"
|
|
144
|
+
end
|
|
145
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
146
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_file, the character length must be smaller than or equal to 255.'
|
|
147
|
+
end
|
|
148
|
+
|
|
149
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
150
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_file, the character length must be great than or equal to 1.'
|
|
151
|
+
end
|
|
152
|
+
|
|
153
|
+
if @api_client.config.client_side_validation && !opts[:'title'].nil? && opts[:'title'].to_s.length > 120
|
|
154
|
+
fail ArgumentError, 'invalid value for "opts[:"title"]" when calling CompositionsApi.add_ai_answers_knowledge_file, the character length must be smaller than or equal to 120.'
|
|
155
|
+
end
|
|
156
|
+
|
|
157
|
+
# resource path
|
|
158
|
+
local_var_path = '/compositions/{id}/adapters/ai-answers/knowledge/documents/file'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
159
|
+
|
|
160
|
+
# query parameters
|
|
161
|
+
query_params = opts[:query_params] || {}
|
|
162
|
+
|
|
163
|
+
# header parameters
|
|
164
|
+
header_params = opts[:header_params] || {}
|
|
165
|
+
# HTTP header 'Accept' (if needed)
|
|
166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
167
|
+
# HTTP header 'Content-Type'
|
|
168
|
+
content_type = @api_client.select_header_content_type(['multipart/form-data'])
|
|
169
|
+
if !content_type.nil?
|
|
170
|
+
header_params['Content-Type'] = content_type
|
|
171
|
+
end
|
|
172
|
+
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
173
|
+
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
174
|
+
|
|
175
|
+
# form parameters
|
|
176
|
+
form_params = opts[:form_params] || {}
|
|
177
|
+
form_params['file'] = file
|
|
178
|
+
form_params['title'] = opts[:'title'] if !opts[:'title'].nil?
|
|
179
|
+
|
|
180
|
+
# http body (model)
|
|
181
|
+
post_body = opts[:debug_body]
|
|
182
|
+
|
|
183
|
+
# return_type
|
|
184
|
+
return_type = opts[:debug_return_type] || 'AiAnswersKnowledgeDocumentResponse'
|
|
185
|
+
|
|
186
|
+
# auth_names
|
|
187
|
+
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
188
|
+
|
|
189
|
+
new_options = opts.merge(
|
|
190
|
+
:operation => :"CompositionsApi.add_ai_answers_knowledge_file",
|
|
191
|
+
:header_params => header_params,
|
|
192
|
+
:query_params => query_params,
|
|
193
|
+
:form_params => form_params,
|
|
194
|
+
:body => post_body,
|
|
195
|
+
:auth_names => auth_names,
|
|
196
|
+
:return_type => return_type
|
|
197
|
+
)
|
|
198
|
+
|
|
199
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
200
|
+
if @api_client.config.debugging
|
|
201
|
+
@api_client.config.logger.debug "API called: CompositionsApi#add_ai_answers_knowledge_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
106
202
|
end
|
|
107
203
|
return data, status_code, headers
|
|
108
204
|
end
|
|
@@ -112,8 +208,8 @@ module ApiSdkRb
|
|
|
112
208
|
# @param id [String] Composition ID
|
|
113
209
|
# @param [Hash] opts the optional parameters
|
|
114
210
|
# @return [CheckCompositionAccessResponse]
|
|
115
|
-
def
|
|
116
|
-
data, _status_code, _headers =
|
|
211
|
+
def check_composition_access(id, opts = {})
|
|
212
|
+
data, _status_code, _headers = check_composition_access_with_http_info(id, opts)
|
|
117
213
|
data
|
|
118
214
|
end
|
|
119
215
|
|
|
@@ -122,13 +218,13 @@ module ApiSdkRb
|
|
|
122
218
|
# @param id [String] Composition ID
|
|
123
219
|
# @param [Hash] opts the optional parameters
|
|
124
220
|
# @return [Array<(CheckCompositionAccessResponse, Integer, Hash)>] CheckCompositionAccessResponse data, response status code and response headers
|
|
125
|
-
def
|
|
221
|
+
def check_composition_access_with_http_info(id, opts = {})
|
|
126
222
|
if @api_client.config.debugging
|
|
127
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
223
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.check_composition_access ...'
|
|
128
224
|
end
|
|
129
225
|
# verify the required parameter 'id' is set
|
|
130
226
|
if @api_client.config.client_side_validation && id.nil?
|
|
131
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
227
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.check_composition_access"
|
|
132
228
|
end
|
|
133
229
|
# resource path
|
|
134
230
|
local_var_path = '/compositions/{id}/access'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
@@ -154,7 +250,7 @@ module ApiSdkRb
|
|
|
154
250
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
155
251
|
|
|
156
252
|
new_options = opts.merge(
|
|
157
|
-
:operation => :"CompositionsApi.
|
|
253
|
+
:operation => :"CompositionsApi.check_composition_access",
|
|
158
254
|
:header_params => header_params,
|
|
159
255
|
:query_params => query_params,
|
|
160
256
|
:form_params => form_params,
|
|
@@ -165,7 +261,7 @@ module ApiSdkRb
|
|
|
165
261
|
|
|
166
262
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
167
263
|
if @api_client.config.debugging
|
|
168
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
264
|
+
@api_client.config.logger.debug "API called: CompositionsApi#check_composition_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
169
265
|
end
|
|
170
266
|
return data, status_code, headers
|
|
171
267
|
end
|
|
@@ -175,11 +271,11 @@ module ApiSdkRb
|
|
|
175
271
|
# @param 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`).
|
|
176
272
|
# @param new_composition [NewComposition]
|
|
177
273
|
# @param [Hash] opts the optional parameters
|
|
178
|
-
# @option opts [String] :x_managed_user_id 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
|
|
179
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
180
|
-
# @return [
|
|
181
|
-
def
|
|
182
|
-
data, _status_code, _headers =
|
|
274
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
275
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
276
|
+
# @return [CompositionResponse]
|
|
277
|
+
def create_composition(idempotency_key, new_composition, opts = {})
|
|
278
|
+
data, _status_code, _headers = create_composition_with_http_info(idempotency_key, new_composition, opts)
|
|
183
279
|
data
|
|
184
280
|
end
|
|
185
281
|
|
|
@@ -188,40 +284,40 @@ module ApiSdkRb
|
|
|
188
284
|
# @param 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`).
|
|
189
285
|
# @param new_composition [NewComposition]
|
|
190
286
|
# @param [Hash] opts the optional parameters
|
|
191
|
-
# @option opts [String] :x_managed_user_id 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
|
|
192
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
193
|
-
# @return [Array<(
|
|
194
|
-
def
|
|
287
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
288
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
289
|
+
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
290
|
+
def create_composition_with_http_info(idempotency_key, new_composition, opts = {})
|
|
195
291
|
if @api_client.config.debugging
|
|
196
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
292
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.create_composition ...'
|
|
197
293
|
end
|
|
198
294
|
# verify the required parameter 'idempotency_key' is set
|
|
199
295
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
200
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
296
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.create_composition"
|
|
201
297
|
end
|
|
202
298
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
203
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
299
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition, the character length must be smaller than or equal to 50.'
|
|
204
300
|
end
|
|
205
301
|
|
|
206
302
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
207
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
303
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition, the character length must be great than or equal to 8.'
|
|
208
304
|
end
|
|
209
305
|
|
|
210
306
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
211
307
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
212
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
308
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.create_composition, must conform to the pattern #{pattern}."
|
|
213
309
|
end
|
|
214
310
|
|
|
215
311
|
# verify the required parameter 'new_composition' is set
|
|
216
312
|
if @api_client.config.client_side_validation && new_composition.nil?
|
|
217
|
-
fail ArgumentError, "Missing the required parameter 'new_composition' when calling CompositionsApi.
|
|
313
|
+
fail ArgumentError, "Missing the required parameter 'new_composition' when calling CompositionsApi.create_composition"
|
|
218
314
|
end
|
|
219
315
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
220
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
316
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition, the character length must be smaller than or equal to 255.'
|
|
221
317
|
end
|
|
222
318
|
|
|
223
319
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
224
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
320
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition, the character length must be great than or equal to 1.'
|
|
225
321
|
end
|
|
226
322
|
|
|
227
323
|
# resource path
|
|
@@ -250,13 +346,13 @@ module ApiSdkRb
|
|
|
250
346
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(new_composition)
|
|
251
347
|
|
|
252
348
|
# return_type
|
|
253
|
-
return_type = opts[:debug_return_type] || '
|
|
349
|
+
return_type = opts[:debug_return_type] || 'CompositionResponse'
|
|
254
350
|
|
|
255
351
|
# auth_names
|
|
256
352
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
257
353
|
|
|
258
354
|
new_options = opts.merge(
|
|
259
|
-
:operation => :"CompositionsApi.
|
|
355
|
+
:operation => :"CompositionsApi.create_composition",
|
|
260
356
|
:header_params => header_params,
|
|
261
357
|
:query_params => query_params,
|
|
262
358
|
:form_params => form_params,
|
|
@@ -267,7 +363,7 @@ module ApiSdkRb
|
|
|
267
363
|
|
|
268
364
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
269
365
|
if @api_client.config.debugging
|
|
270
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
366
|
+
@api_client.config.logger.debug "API called: CompositionsApi#create_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
271
367
|
end
|
|
272
368
|
return data, status_code, headers
|
|
273
369
|
end
|
|
@@ -280,11 +376,11 @@ module ApiSdkRb
|
|
|
280
376
|
# @param create_composition_content_item_request [CreateCompositionContentItemRequest]
|
|
281
377
|
# @param [Hash] opts the optional parameters
|
|
282
378
|
# @option opts [String] :if_match Optional content version from ETag
|
|
283
|
-
# @option opts [String] :x_managed_user_id 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
|
|
284
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
285
|
-
# @return [
|
|
286
|
-
def
|
|
287
|
-
data, _status_code, _headers =
|
|
379
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
380
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
381
|
+
# @return [ContentItemWriteResultResponse]
|
|
382
|
+
def create_composition_content_item(id, list, idempotency_key, create_composition_content_item_request, opts = {})
|
|
383
|
+
data, _status_code, _headers = create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
288
384
|
data
|
|
289
385
|
end
|
|
290
386
|
|
|
@@ -296,48 +392,48 @@ module ApiSdkRb
|
|
|
296
392
|
# @param create_composition_content_item_request [CreateCompositionContentItemRequest]
|
|
297
393
|
# @param [Hash] opts the optional parameters
|
|
298
394
|
# @option opts [String] :if_match Optional content version from ETag
|
|
299
|
-
# @option opts [String] :x_managed_user_id 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
|
|
300
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
301
|
-
# @return [Array<(
|
|
302
|
-
def
|
|
395
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
396
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
397
|
+
# @return [Array<(ContentItemWriteResultResponse, Integer, Hash)>] ContentItemWriteResultResponse data, response status code and response headers
|
|
398
|
+
def create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts = {})
|
|
303
399
|
if @api_client.config.debugging
|
|
304
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
400
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.create_composition_content_item ...'
|
|
305
401
|
end
|
|
306
402
|
# verify the required parameter 'id' is set
|
|
307
403
|
if @api_client.config.client_side_validation && id.nil?
|
|
308
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
404
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.create_composition_content_item"
|
|
309
405
|
end
|
|
310
406
|
# verify the required parameter 'list' is set
|
|
311
407
|
if @api_client.config.client_side_validation && list.nil?
|
|
312
|
-
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.
|
|
408
|
+
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.create_composition_content_item"
|
|
313
409
|
end
|
|
314
410
|
# verify the required parameter 'idempotency_key' is set
|
|
315
411
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
316
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
412
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.create_composition_content_item"
|
|
317
413
|
end
|
|
318
414
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
319
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
415
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_content_item, the character length must be smaller than or equal to 50.'
|
|
320
416
|
end
|
|
321
417
|
|
|
322
418
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
323
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
419
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_content_item, the character length must be great than or equal to 8.'
|
|
324
420
|
end
|
|
325
421
|
|
|
326
422
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
327
423
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
328
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
424
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.create_composition_content_item, must conform to the pattern #{pattern}."
|
|
329
425
|
end
|
|
330
426
|
|
|
331
427
|
# verify the required parameter 'create_composition_content_item_request' is set
|
|
332
428
|
if @api_client.config.client_side_validation && create_composition_content_item_request.nil?
|
|
333
|
-
fail ArgumentError, "Missing the required parameter 'create_composition_content_item_request' when calling CompositionsApi.
|
|
429
|
+
fail ArgumentError, "Missing the required parameter 'create_composition_content_item_request' when calling CompositionsApi.create_composition_content_item"
|
|
334
430
|
end
|
|
335
431
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
336
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
432
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_content_item, the character length must be smaller than or equal to 255.'
|
|
337
433
|
end
|
|
338
434
|
|
|
339
435
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
340
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
436
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_content_item, the character length must be great than or equal to 1.'
|
|
341
437
|
end
|
|
342
438
|
|
|
343
439
|
# resource path
|
|
@@ -367,13 +463,13 @@ module ApiSdkRb
|
|
|
367
463
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_composition_content_item_request)
|
|
368
464
|
|
|
369
465
|
# return_type
|
|
370
|
-
return_type = opts[:debug_return_type] || '
|
|
466
|
+
return_type = opts[:debug_return_type] || 'ContentItemWriteResultResponse'
|
|
371
467
|
|
|
372
468
|
# auth_names
|
|
373
469
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
374
470
|
|
|
375
471
|
new_options = opts.merge(
|
|
376
|
-
:operation => :"CompositionsApi.
|
|
472
|
+
:operation => :"CompositionsApi.create_composition_content_item",
|
|
377
473
|
:header_params => header_params,
|
|
378
474
|
:query_params => query_params,
|
|
379
475
|
:form_params => form_params,
|
|
@@ -384,7 +480,7 @@ module ApiSdkRb
|
|
|
384
480
|
|
|
385
481
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
386
482
|
if @api_client.config.debugging
|
|
387
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
483
|
+
@api_client.config.logger.debug "API called: CompositionsApi#create_composition_content_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
388
484
|
end
|
|
389
485
|
return data, status_code, headers
|
|
390
486
|
end
|
|
@@ -396,11 +492,11 @@ module ApiSdkRb
|
|
|
396
492
|
# @param 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`).
|
|
397
493
|
# @param body [Object]
|
|
398
494
|
# @param [Hash] opts the optional parameters
|
|
399
|
-
# @option opts [String] :x_managed_user_id 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
|
|
400
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
401
|
-
# @return [
|
|
402
|
-
def
|
|
403
|
-
data, _status_code, _headers =
|
|
495
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
496
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
497
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
498
|
+
def create_composition_database_record(id, table, idempotency_key, body, opts = {})
|
|
499
|
+
data, _status_code, _headers = create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts)
|
|
404
500
|
data
|
|
405
501
|
end
|
|
406
502
|
|
|
@@ -411,48 +507,48 @@ module ApiSdkRb
|
|
|
411
507
|
# @param 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`).
|
|
412
508
|
# @param body [Object]
|
|
413
509
|
# @param [Hash] opts the optional parameters
|
|
414
|
-
# @option opts [String] :x_managed_user_id 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
|
-
# @option opts [String] :x_managed_user_external_id 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
|
-
# @return [Array<(
|
|
417
|
-
def
|
|
510
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
511
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
512
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
513
|
+
def create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts = {})
|
|
418
514
|
if @api_client.config.debugging
|
|
419
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
515
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.create_composition_database_record ...'
|
|
420
516
|
end
|
|
421
517
|
# verify the required parameter 'id' is set
|
|
422
518
|
if @api_client.config.client_side_validation && id.nil?
|
|
423
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
519
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.create_composition_database_record"
|
|
424
520
|
end
|
|
425
521
|
# verify the required parameter 'table' is set
|
|
426
522
|
if @api_client.config.client_side_validation && table.nil?
|
|
427
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
523
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.create_composition_database_record"
|
|
428
524
|
end
|
|
429
525
|
# verify the required parameter 'idempotency_key' is set
|
|
430
526
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
431
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
527
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.create_composition_database_record"
|
|
432
528
|
end
|
|
433
529
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
434
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
530
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_database_record, the character length must be smaller than or equal to 50.'
|
|
435
531
|
end
|
|
436
532
|
|
|
437
533
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
438
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
534
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_database_record, the character length must be great than or equal to 8.'
|
|
439
535
|
end
|
|
440
536
|
|
|
441
537
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
442
538
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
443
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
539
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.create_composition_database_record, must conform to the pattern #{pattern}."
|
|
444
540
|
end
|
|
445
541
|
|
|
446
542
|
# verify the required parameter 'body' is set
|
|
447
543
|
if @api_client.config.client_side_validation && body.nil?
|
|
448
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.
|
|
544
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.create_composition_database_record"
|
|
449
545
|
end
|
|
450
546
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
451
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
547
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
452
548
|
end
|
|
453
549
|
|
|
454
550
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
455
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
551
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_database_record, the character length must be great than or equal to 1.'
|
|
456
552
|
end
|
|
457
553
|
|
|
458
554
|
# resource path
|
|
@@ -481,13 +577,13 @@ module ApiSdkRb
|
|
|
481
577
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
|
482
578
|
|
|
483
579
|
# return_type
|
|
484
|
-
return_type = opts[:debug_return_type] || '
|
|
580
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
485
581
|
|
|
486
582
|
# auth_names
|
|
487
583
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
488
584
|
|
|
489
585
|
new_options = opts.merge(
|
|
490
|
-
:operation => :"CompositionsApi.
|
|
586
|
+
:operation => :"CompositionsApi.create_composition_database_record",
|
|
491
587
|
:header_params => header_params,
|
|
492
588
|
:query_params => query_params,
|
|
493
589
|
:form_params => form_params,
|
|
@@ -498,7 +594,7 @@ module ApiSdkRb
|
|
|
498
594
|
|
|
499
595
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
500
596
|
if @api_client.config.debugging
|
|
501
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
597
|
+
@api_client.config.logger.debug "API called: CompositionsApi#create_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
502
598
|
end
|
|
503
599
|
return data, status_code, headers
|
|
504
600
|
end
|
|
@@ -507,11 +603,11 @@ module ApiSdkRb
|
|
|
507
603
|
# Deletes a specific composition, and the data it keeps (the tables it declared and what visitors left in them).
|
|
508
604
|
# @param id [String] The ID of the composition to delete
|
|
509
605
|
# @param [Hash] opts the optional parameters
|
|
510
|
-
# @option opts [String] :x_managed_user_id 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
|
|
511
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
606
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
607
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
512
608
|
# @return [nil]
|
|
513
|
-
def
|
|
514
|
-
|
|
609
|
+
def delete_composition(id, opts = {})
|
|
610
|
+
delete_composition_with_http_info(id, opts)
|
|
515
611
|
nil
|
|
516
612
|
end
|
|
517
613
|
|
|
@@ -519,23 +615,23 @@ module ApiSdkRb
|
|
|
519
615
|
# Deletes a specific composition, and the data it keeps (the tables it declared and what visitors left in them).
|
|
520
616
|
# @param id [String] The ID of the composition to delete
|
|
521
617
|
# @param [Hash] opts the optional parameters
|
|
522
|
-
# @option opts [String] :x_managed_user_id 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
|
|
523
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
618
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
619
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
524
620
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
525
|
-
def
|
|
621
|
+
def delete_composition_with_http_info(id, opts = {})
|
|
526
622
|
if @api_client.config.debugging
|
|
527
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
623
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition ...'
|
|
528
624
|
end
|
|
529
625
|
# verify the required parameter 'id' is set
|
|
530
626
|
if @api_client.config.client_side_validation && id.nil?
|
|
531
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
627
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition"
|
|
532
628
|
end
|
|
533
629
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
534
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
630
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition, the character length must be smaller than or equal to 255.'
|
|
535
631
|
end
|
|
536
632
|
|
|
537
633
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
538
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
634
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition, the character length must be great than or equal to 1.'
|
|
539
635
|
end
|
|
540
636
|
|
|
541
637
|
# resource path
|
|
@@ -564,7 +660,7 @@ module ApiSdkRb
|
|
|
564
660
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
565
661
|
|
|
566
662
|
new_options = opts.merge(
|
|
567
|
-
:operation => :"CompositionsApi.
|
|
663
|
+
:operation => :"CompositionsApi.delete_composition",
|
|
568
664
|
:header_params => header_params,
|
|
569
665
|
:query_params => query_params,
|
|
570
666
|
:form_params => form_params,
|
|
@@ -575,7 +671,7 @@ module ApiSdkRb
|
|
|
575
671
|
|
|
576
672
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
577
673
|
if @api_client.config.debugging
|
|
578
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
674
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
579
675
|
end
|
|
580
676
|
return data, status_code, headers
|
|
581
677
|
end
|
|
@@ -587,11 +683,11 @@ module ApiSdkRb
|
|
|
587
683
|
# @param 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`).
|
|
588
684
|
# @param [Hash] opts the optional parameters
|
|
589
685
|
# @option opts [String] :if_match
|
|
590
|
-
# @option opts [String] :x_managed_user_id 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
|
|
591
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
686
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
687
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
592
688
|
# @return [DeleteCompositionContentItemResponse]
|
|
593
|
-
def
|
|
594
|
-
data, _status_code, _headers =
|
|
689
|
+
def delete_composition_content_item(id, list, item_id, idempotency_key, opts = {})
|
|
690
|
+
data, _status_code, _headers = delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts)
|
|
595
691
|
data
|
|
596
692
|
end
|
|
597
693
|
|
|
@@ -602,48 +698,48 @@ module ApiSdkRb
|
|
|
602
698
|
# @param 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`).
|
|
603
699
|
# @param [Hash] opts the optional parameters
|
|
604
700
|
# @option opts [String] :if_match
|
|
605
|
-
# @option opts [String] :x_managed_user_id 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
|
|
606
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
701
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
702
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
607
703
|
# @return [Array<(DeleteCompositionContentItemResponse, Integer, Hash)>] DeleteCompositionContentItemResponse data, response status code and response headers
|
|
608
|
-
def
|
|
704
|
+
def delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts = {})
|
|
609
705
|
if @api_client.config.debugging
|
|
610
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
706
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_content_item ...'
|
|
611
707
|
end
|
|
612
708
|
# verify the required parameter 'id' is set
|
|
613
709
|
if @api_client.config.client_side_validation && id.nil?
|
|
614
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
710
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_content_item"
|
|
615
711
|
end
|
|
616
712
|
# verify the required parameter 'list' is set
|
|
617
713
|
if @api_client.config.client_side_validation && list.nil?
|
|
618
|
-
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.
|
|
714
|
+
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.delete_composition_content_item"
|
|
619
715
|
end
|
|
620
716
|
# verify the required parameter 'item_id' is set
|
|
621
717
|
if @api_client.config.client_side_validation && item_id.nil?
|
|
622
|
-
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.
|
|
718
|
+
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.delete_composition_content_item"
|
|
623
719
|
end
|
|
624
720
|
# verify the required parameter 'idempotency_key' is set
|
|
625
721
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
626
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
722
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.delete_composition_content_item"
|
|
627
723
|
end
|
|
628
724
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
629
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
725
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_content_item, the character length must be smaller than or equal to 50.'
|
|
630
726
|
end
|
|
631
727
|
|
|
632
728
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
633
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
729
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_content_item, the character length must be great than or equal to 8.'
|
|
634
730
|
end
|
|
635
731
|
|
|
636
732
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
637
733
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
638
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
734
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.delete_composition_content_item, must conform to the pattern #{pattern}."
|
|
639
735
|
end
|
|
640
736
|
|
|
641
737
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
642
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
738
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_content_item, the character length must be smaller than or equal to 255.'
|
|
643
739
|
end
|
|
644
740
|
|
|
645
741
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
646
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
742
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_content_item, the character length must be great than or equal to 1.'
|
|
647
743
|
end
|
|
648
744
|
|
|
649
745
|
# resource path
|
|
@@ -674,7 +770,7 @@ module ApiSdkRb
|
|
|
674
770
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
675
771
|
|
|
676
772
|
new_options = opts.merge(
|
|
677
|
-
:operation => :"CompositionsApi.
|
|
773
|
+
:operation => :"CompositionsApi.delete_composition_content_item",
|
|
678
774
|
:header_params => header_params,
|
|
679
775
|
:query_params => query_params,
|
|
680
776
|
:form_params => form_params,
|
|
@@ -685,7 +781,7 @@ module ApiSdkRb
|
|
|
685
781
|
|
|
686
782
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
687
783
|
if @api_client.config.debugging
|
|
688
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
784
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_content_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
689
785
|
end
|
|
690
786
|
return data, status_code, headers
|
|
691
787
|
end
|
|
@@ -695,11 +791,11 @@ module ApiSdkRb
|
|
|
695
791
|
# @param id [String]
|
|
696
792
|
# @param 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`).
|
|
697
793
|
# @param [Hash] opts the optional parameters
|
|
698
|
-
# @option opts [String] :x_managed_user_id 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
|
|
699
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
794
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
795
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
700
796
|
# @return [DeleteCompositionDataSourceResponse]
|
|
701
|
-
def
|
|
702
|
-
data, _status_code, _headers =
|
|
797
|
+
def delete_composition_data_source(id, idempotency_key, opts = {})
|
|
798
|
+
data, _status_code, _headers = delete_composition_data_source_with_http_info(id, idempotency_key, opts)
|
|
703
799
|
data
|
|
704
800
|
end
|
|
705
801
|
|
|
@@ -708,40 +804,40 @@ module ApiSdkRb
|
|
|
708
804
|
# @param id [String]
|
|
709
805
|
# @param 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`).
|
|
710
806
|
# @param [Hash] opts the optional parameters
|
|
711
|
-
# @option opts [String] :x_managed_user_id 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
|
|
712
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
807
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
808
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
713
809
|
# @return [Array<(DeleteCompositionDataSourceResponse, Integer, Hash)>] DeleteCompositionDataSourceResponse data, response status code and response headers
|
|
714
|
-
def
|
|
810
|
+
def delete_composition_data_source_with_http_info(id, idempotency_key, opts = {})
|
|
715
811
|
if @api_client.config.debugging
|
|
716
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
812
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_data_source ...'
|
|
717
813
|
end
|
|
718
814
|
# verify the required parameter 'id' is set
|
|
719
815
|
if @api_client.config.client_side_validation && id.nil?
|
|
720
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
816
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_data_source"
|
|
721
817
|
end
|
|
722
818
|
# verify the required parameter 'idempotency_key' is set
|
|
723
819
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
724
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
820
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.delete_composition_data_source"
|
|
725
821
|
end
|
|
726
822
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
727
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
823
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_data_source, the character length must be smaller than or equal to 50.'
|
|
728
824
|
end
|
|
729
825
|
|
|
730
826
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
731
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
827
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_data_source, the character length must be great than or equal to 8.'
|
|
732
828
|
end
|
|
733
829
|
|
|
734
830
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
735
831
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
736
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
832
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.delete_composition_data_source, must conform to the pattern #{pattern}."
|
|
737
833
|
end
|
|
738
834
|
|
|
739
835
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
740
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
836
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_data_source, the character length must be smaller than or equal to 255.'
|
|
741
837
|
end
|
|
742
838
|
|
|
743
839
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
744
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
840
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_data_source, the character length must be great than or equal to 1.'
|
|
745
841
|
end
|
|
746
842
|
|
|
747
843
|
# resource path
|
|
@@ -771,7 +867,7 @@ module ApiSdkRb
|
|
|
771
867
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
772
868
|
|
|
773
869
|
new_options = opts.merge(
|
|
774
|
-
:operation => :"CompositionsApi.
|
|
870
|
+
:operation => :"CompositionsApi.delete_composition_data_source",
|
|
775
871
|
:header_params => header_params,
|
|
776
872
|
:query_params => query_params,
|
|
777
873
|
:form_params => form_params,
|
|
@@ -782,7 +878,7 @@ module ApiSdkRb
|
|
|
782
878
|
|
|
783
879
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
784
880
|
if @api_client.config.debugging
|
|
785
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
881
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
786
882
|
end
|
|
787
883
|
return data, status_code, headers
|
|
788
884
|
end
|
|
@@ -793,11 +889,11 @@ module ApiSdkRb
|
|
|
793
889
|
# @param table [String] Name of the database table
|
|
794
890
|
# @param record_id [String] ID of the record to delete
|
|
795
891
|
# @param [Hash] opts the optional parameters
|
|
796
|
-
# @option opts [String] :x_managed_user_id 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
|
|
797
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
798
|
-
# @return [
|
|
799
|
-
def
|
|
800
|
-
data, _status_code, _headers =
|
|
892
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
893
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
894
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
895
|
+
def delete_composition_database_record(id, table, record_id, opts = {})
|
|
896
|
+
data, _status_code, _headers = delete_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
801
897
|
data
|
|
802
898
|
end
|
|
803
899
|
|
|
@@ -807,31 +903,31 @@ module ApiSdkRb
|
|
|
807
903
|
# @param table [String] Name of the database table
|
|
808
904
|
# @param record_id [String] ID of the record to delete
|
|
809
905
|
# @param [Hash] opts the optional parameters
|
|
810
|
-
# @option opts [String] :x_managed_user_id 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
|
|
811
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
812
|
-
# @return [Array<(
|
|
813
|
-
def
|
|
906
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
907
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
908
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
909
|
+
def delete_composition_database_record_with_http_info(id, table, record_id, opts = {})
|
|
814
910
|
if @api_client.config.debugging
|
|
815
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
911
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_database_record ...'
|
|
816
912
|
end
|
|
817
913
|
# verify the required parameter 'id' is set
|
|
818
914
|
if @api_client.config.client_side_validation && id.nil?
|
|
819
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
915
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_database_record"
|
|
820
916
|
end
|
|
821
917
|
# verify the required parameter 'table' is set
|
|
822
918
|
if @api_client.config.client_side_validation && table.nil?
|
|
823
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
919
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.delete_composition_database_record"
|
|
824
920
|
end
|
|
825
921
|
# verify the required parameter 'record_id' is set
|
|
826
922
|
if @api_client.config.client_side_validation && record_id.nil?
|
|
827
|
-
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.
|
|
923
|
+
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.delete_composition_database_record"
|
|
828
924
|
end
|
|
829
925
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
830
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
926
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
831
927
|
end
|
|
832
928
|
|
|
833
929
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
834
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
930
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_database_record, the character length must be great than or equal to 1.'
|
|
835
931
|
end
|
|
836
932
|
|
|
837
933
|
# resource path
|
|
@@ -854,13 +950,13 @@ module ApiSdkRb
|
|
|
854
950
|
post_body = opts[:debug_body]
|
|
855
951
|
|
|
856
952
|
# return_type
|
|
857
|
-
return_type = opts[:debug_return_type] || '
|
|
953
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
858
954
|
|
|
859
955
|
# auth_names
|
|
860
956
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
861
957
|
|
|
862
958
|
new_options = opts.merge(
|
|
863
|
-
:operation => :"CompositionsApi.
|
|
959
|
+
:operation => :"CompositionsApi.delete_composition_database_record",
|
|
864
960
|
:header_params => header_params,
|
|
865
961
|
:query_params => query_params,
|
|
866
962
|
:form_params => form_params,
|
|
@@ -871,7 +967,103 @@ module ApiSdkRb
|
|
|
871
967
|
|
|
872
968
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
873
969
|
if @api_client.config.debugging
|
|
874
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
970
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
971
|
+
end
|
|
972
|
+
return data, status_code, headers
|
|
973
|
+
end
|
|
974
|
+
|
|
975
|
+
# Delete composition entry items by id or host context
|
|
976
|
+
# Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
977
|
+
# @param id [String]
|
|
978
|
+
# @param table [String]
|
|
979
|
+
# @param [Hash] opts the optional parameters
|
|
980
|
+
# @option opts [String] :ids
|
|
981
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
982
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
983
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
984
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
985
|
+
# @return [CompositionEntryDeleteSuccess]
|
|
986
|
+
def delete_composition_entry_items(id, table, opts = {})
|
|
987
|
+
data, _status_code, _headers = delete_composition_entry_items_with_http_info(id, table, opts)
|
|
988
|
+
data
|
|
989
|
+
end
|
|
990
|
+
|
|
991
|
+
# Delete composition entry items by id or host context
|
|
992
|
+
# Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
993
|
+
# @param id [String]
|
|
994
|
+
# @param table [String]
|
|
995
|
+
# @param [Hash] opts the optional parameters
|
|
996
|
+
# @option opts [String] :ids
|
|
997
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
998
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
999
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1000
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1001
|
+
# @return [Array<(CompositionEntryDeleteSuccess, Integer, Hash)>] CompositionEntryDeleteSuccess data, response status code and response headers
|
|
1002
|
+
def delete_composition_entry_items_with_http_info(id, table, opts = {})
|
|
1003
|
+
if @api_client.config.debugging
|
|
1004
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_entry_items ...'
|
|
1005
|
+
end
|
|
1006
|
+
# verify the required parameter 'id' is set
|
|
1007
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1008
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_entry_items"
|
|
1009
|
+
end
|
|
1010
|
+
# verify the required parameter 'table' is set
|
|
1011
|
+
if @api_client.config.client_side_validation && table.nil?
|
|
1012
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.delete_composition_entry_items"
|
|
1013
|
+
end
|
|
1014
|
+
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
1015
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.delete_composition_entry_items, the character length must be smaller than or equal to 63.'
|
|
1016
|
+
end
|
|
1017
|
+
|
|
1018
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1019
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_entry_items, the character length must be smaller than or equal to 255.'
|
|
1020
|
+
end
|
|
1021
|
+
|
|
1022
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1023
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_entry_items, the character length must be great than or equal to 1.'
|
|
1024
|
+
end
|
|
1025
|
+
|
|
1026
|
+
# resource path
|
|
1027
|
+
local_var_path = '/compositions/{id}/entries/{table}/items'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'table' + '}', CGI.escape(table.to_s))
|
|
1028
|
+
|
|
1029
|
+
# query parameters
|
|
1030
|
+
query_params = opts[:query_params] || {}
|
|
1031
|
+
query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
|
|
1032
|
+
query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
|
|
1033
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
1034
|
+
|
|
1035
|
+
# header parameters
|
|
1036
|
+
header_params = opts[:header_params] || {}
|
|
1037
|
+
# HTTP header 'Accept' (if needed)
|
|
1038
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1039
|
+
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
1040
|
+
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
1041
|
+
|
|
1042
|
+
# form parameters
|
|
1043
|
+
form_params = opts[:form_params] || {}
|
|
1044
|
+
|
|
1045
|
+
# http body (model)
|
|
1046
|
+
post_body = opts[:debug_body]
|
|
1047
|
+
|
|
1048
|
+
# return_type
|
|
1049
|
+
return_type = opts[:debug_return_type] || 'CompositionEntryDeleteSuccess'
|
|
1050
|
+
|
|
1051
|
+
# auth_names
|
|
1052
|
+
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1053
|
+
|
|
1054
|
+
new_options = opts.merge(
|
|
1055
|
+
:operation => :"CompositionsApi.delete_composition_entry_items",
|
|
1056
|
+
:header_params => header_params,
|
|
1057
|
+
:query_params => query_params,
|
|
1058
|
+
:form_params => form_params,
|
|
1059
|
+
:body => post_body,
|
|
1060
|
+
:auth_names => auth_names,
|
|
1061
|
+
:return_type => return_type
|
|
1062
|
+
)
|
|
1063
|
+
|
|
1064
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
1065
|
+
if @api_client.config.debugging
|
|
1066
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_entry_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
875
1067
|
end
|
|
876
1068
|
return data, status_code, headers
|
|
877
1069
|
end
|
|
@@ -880,11 +1072,11 @@ module ApiSdkRb
|
|
|
880
1072
|
# Names the tables a composition's widget keeps entries in (the votes, ratings, answers or sign-ups its visitors left), their columns, and how many entries each holds. Call it first to learn the table and column names that `readCompositionEntries` takes. A widget that only shows content keeps nothing of its own: the answer is `hasData: false` with no tables, and that is not an error. A table that could not be counted has `rows: null`, which is not zero. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
|
|
881
1073
|
# @param id [String] ID of the composition
|
|
882
1074
|
# @param [Hash] opts the optional parameters
|
|
883
|
-
# @option opts [String] :x_managed_user_id 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
|
|
884
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1075
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1076
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
885
1077
|
# @return [CompositionEntriesDescriptionResponse]
|
|
886
|
-
def
|
|
887
|
-
data, _status_code, _headers =
|
|
1078
|
+
def describe_composition_entries(id, opts = {})
|
|
1079
|
+
data, _status_code, _headers = describe_composition_entries_with_http_info(id, opts)
|
|
888
1080
|
data
|
|
889
1081
|
end
|
|
890
1082
|
|
|
@@ -892,23 +1084,23 @@ module ApiSdkRb
|
|
|
892
1084
|
# Names the tables a composition's widget keeps entries in (the votes, ratings, answers or sign-ups its visitors left), their columns, and how many entries each holds. Call it first to learn the table and column names that `readCompositionEntries` takes. A widget that only shows content keeps nothing of its own: the answer is `hasData: false` with no tables, and that is not an error. A table that could not be counted has `rows: null`, which is not zero. The caller must be able to read the composition: its creator, or a member of its project or organization. An editor session cannot call this route.
|
|
893
1085
|
# @param id [String] ID of the composition
|
|
894
1086
|
# @param [Hash] opts the optional parameters
|
|
895
|
-
# @option opts [String] :x_managed_user_id 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
|
|
896
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1087
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1088
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
897
1089
|
# @return [Array<(CompositionEntriesDescriptionResponse, Integer, Hash)>] CompositionEntriesDescriptionResponse data, response status code and response headers
|
|
898
|
-
def
|
|
1090
|
+
def describe_composition_entries_with_http_info(id, opts = {})
|
|
899
1091
|
if @api_client.config.debugging
|
|
900
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1092
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.describe_composition_entries ...'
|
|
901
1093
|
end
|
|
902
1094
|
# verify the required parameter 'id' is set
|
|
903
1095
|
if @api_client.config.client_side_validation && id.nil?
|
|
904
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1096
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.describe_composition_entries"
|
|
905
1097
|
end
|
|
906
1098
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
907
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1099
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.describe_composition_entries, the character length must be smaller than or equal to 255.'
|
|
908
1100
|
end
|
|
909
1101
|
|
|
910
1102
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
911
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1103
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.describe_composition_entries, the character length must be great than or equal to 1.'
|
|
912
1104
|
end
|
|
913
1105
|
|
|
914
1106
|
# resource path
|
|
@@ -937,7 +1129,7 @@ module ApiSdkRb
|
|
|
937
1129
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
938
1130
|
|
|
939
1131
|
new_options = opts.merge(
|
|
940
|
-
:operation => :"CompositionsApi.
|
|
1132
|
+
:operation => :"CompositionsApi.describe_composition_entries",
|
|
941
1133
|
:header_params => header_params,
|
|
942
1134
|
:query_params => query_params,
|
|
943
1135
|
:form_params => form_params,
|
|
@@ -948,7 +1140,7 @@ module ApiSdkRb
|
|
|
948
1140
|
|
|
949
1141
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
950
1142
|
if @api_client.config.debugging
|
|
951
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1143
|
+
@api_client.config.logger.debug "API called: CompositionsApi#describe_composition_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
952
1144
|
end
|
|
953
1145
|
return data, status_code, headers
|
|
954
1146
|
end
|
|
@@ -958,12 +1150,12 @@ module ApiSdkRb
|
|
|
958
1150
|
# @param id [String] ID of the composition to duplicate
|
|
959
1151
|
# @param 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`).
|
|
960
1152
|
# @param [Hash] opts the optional parameters
|
|
961
|
-
# @option opts [String] :x_managed_user_id 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
|
|
962
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1153
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1154
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
963
1155
|
# @option opts [DuplicateCompositionRequest] :duplicate_composition_request
|
|
964
1156
|
# @return [DuplicateComposition202Response]
|
|
965
|
-
def
|
|
966
|
-
data, _status_code, _headers =
|
|
1157
|
+
def duplicate_composition(id, idempotency_key, opts = {})
|
|
1158
|
+
data, _status_code, _headers = duplicate_composition_with_http_info(id, idempotency_key, opts)
|
|
967
1159
|
data
|
|
968
1160
|
end
|
|
969
1161
|
|
|
@@ -972,41 +1164,41 @@ module ApiSdkRb
|
|
|
972
1164
|
# @param id [String] ID of the composition to duplicate
|
|
973
1165
|
# @param 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`).
|
|
974
1166
|
# @param [Hash] opts the optional parameters
|
|
975
|
-
# @option opts [String] :x_managed_user_id 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
|
|
976
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1167
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1168
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
977
1169
|
# @option opts [DuplicateCompositionRequest] :duplicate_composition_request
|
|
978
1170
|
# @return [Array<(DuplicateComposition202Response, Integer, Hash)>] DuplicateComposition202Response data, response status code and response headers
|
|
979
|
-
def
|
|
1171
|
+
def duplicate_composition_with_http_info(id, idempotency_key, opts = {})
|
|
980
1172
|
if @api_client.config.debugging
|
|
981
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1173
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.duplicate_composition ...'
|
|
982
1174
|
end
|
|
983
1175
|
# verify the required parameter 'id' is set
|
|
984
1176
|
if @api_client.config.client_side_validation && id.nil?
|
|
985
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1177
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.duplicate_composition"
|
|
986
1178
|
end
|
|
987
1179
|
# verify the required parameter 'idempotency_key' is set
|
|
988
1180
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
989
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
1181
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.duplicate_composition"
|
|
990
1182
|
end
|
|
991
1183
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
992
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
1184
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.duplicate_composition, the character length must be smaller than or equal to 50.'
|
|
993
1185
|
end
|
|
994
1186
|
|
|
995
1187
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
996
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
1188
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.duplicate_composition, the character length must be great than or equal to 8.'
|
|
997
1189
|
end
|
|
998
1190
|
|
|
999
1191
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
1000
1192
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
1001
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
1193
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.duplicate_composition, must conform to the pattern #{pattern}."
|
|
1002
1194
|
end
|
|
1003
1195
|
|
|
1004
1196
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1005
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1197
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.duplicate_composition, the character length must be smaller than or equal to 255.'
|
|
1006
1198
|
end
|
|
1007
1199
|
|
|
1008
1200
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1009
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1201
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.duplicate_composition, the character length must be great than or equal to 1.'
|
|
1010
1202
|
end
|
|
1011
1203
|
|
|
1012
1204
|
# resource path
|
|
@@ -1041,7 +1233,7 @@ module ApiSdkRb
|
|
|
1041
1233
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1042
1234
|
|
|
1043
1235
|
new_options = opts.merge(
|
|
1044
|
-
:operation => :"CompositionsApi.
|
|
1236
|
+
:operation => :"CompositionsApi.duplicate_composition",
|
|
1045
1237
|
:header_params => header_params,
|
|
1046
1238
|
:query_params => query_params,
|
|
1047
1239
|
:form_params => form_params,
|
|
@@ -1052,7 +1244,120 @@ module ApiSdkRb
|
|
|
1052
1244
|
|
|
1053
1245
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1054
1246
|
if @api_client.config.debugging
|
|
1055
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1247
|
+
@api_client.config.logger.debug "API called: CompositionsApi#duplicate_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1248
|
+
end
|
|
1249
|
+
return data, status_code, headers
|
|
1250
|
+
end
|
|
1251
|
+
|
|
1252
|
+
# Export composition entry items
|
|
1253
|
+
# 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.
|
|
1254
|
+
# @param id [String]
|
|
1255
|
+
# @param table [String]
|
|
1256
|
+
# @param [Hash] opts the optional parameters
|
|
1257
|
+
# @option opts [String] :format (default to 'csv')
|
|
1258
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
1259
|
+
# @option opts [Time] :since 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`.
|
|
1260
|
+
# @option opts [Time] :_until 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`).
|
|
1261
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
1262
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
1263
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1264
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1265
|
+
# @return [String]
|
|
1266
|
+
def export_composition_entry_items(id, table, opts = {})
|
|
1267
|
+
data, _status_code, _headers = export_composition_entry_items_with_http_info(id, table, opts)
|
|
1268
|
+
data
|
|
1269
|
+
end
|
|
1270
|
+
|
|
1271
|
+
# Export composition entry items
|
|
1272
|
+
# 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.
|
|
1273
|
+
# @param id [String]
|
|
1274
|
+
# @param table [String]
|
|
1275
|
+
# @param [Hash] opts the optional parameters
|
|
1276
|
+
# @option opts [String] :format (default to 'csv')
|
|
1277
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
1278
|
+
# @option opts [Time] :since 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`.
|
|
1279
|
+
# @option opts [Time] :_until 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`).
|
|
1280
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
1281
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
1282
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1283
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1284
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
1285
|
+
def export_composition_entry_items_with_http_info(id, table, opts = {})
|
|
1286
|
+
if @api_client.config.debugging
|
|
1287
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.export_composition_entry_items ...'
|
|
1288
|
+
end
|
|
1289
|
+
# verify the required parameter 'id' is set
|
|
1290
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1291
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.export_composition_entry_items"
|
|
1292
|
+
end
|
|
1293
|
+
# verify the required parameter 'table' is set
|
|
1294
|
+
if @api_client.config.client_side_validation && table.nil?
|
|
1295
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.export_composition_entry_items"
|
|
1296
|
+
end
|
|
1297
|
+
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
1298
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.export_composition_entry_items, the character length must be smaller than or equal to 63.'
|
|
1299
|
+
end
|
|
1300
|
+
|
|
1301
|
+
allowable_values = ["csv", "json"]
|
|
1302
|
+
if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
|
|
1303
|
+
fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
|
|
1304
|
+
end
|
|
1305
|
+
allowable_values = ["asc", "desc"]
|
|
1306
|
+
if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
|
|
1307
|
+
fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
|
|
1308
|
+
end
|
|
1309
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1310
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.export_composition_entry_items, the character length must be smaller than or equal to 255.'
|
|
1311
|
+
end
|
|
1312
|
+
|
|
1313
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1314
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.export_composition_entry_items, the character length must be great than or equal to 1.'
|
|
1315
|
+
end
|
|
1316
|
+
|
|
1317
|
+
# resource path
|
|
1318
|
+
local_var_path = '/compositions/{id}/entries/{table}/export'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'table' + '}', CGI.escape(table.to_s))
|
|
1319
|
+
|
|
1320
|
+
# query parameters
|
|
1321
|
+
query_params = opts[:query_params] || {}
|
|
1322
|
+
query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
|
|
1323
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
1324
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
1325
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
1326
|
+
query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
|
|
1327
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
1328
|
+
|
|
1329
|
+
# header parameters
|
|
1330
|
+
header_params = opts[:header_params] || {}
|
|
1331
|
+
# HTTP header 'Accept' (if needed)
|
|
1332
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/csv', 'application/json']) unless header_params['Accept']
|
|
1333
|
+
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
1334
|
+
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
1335
|
+
|
|
1336
|
+
# form parameters
|
|
1337
|
+
form_params = opts[:form_params] || {}
|
|
1338
|
+
|
|
1339
|
+
# http body (model)
|
|
1340
|
+
post_body = opts[:debug_body]
|
|
1341
|
+
|
|
1342
|
+
# return_type
|
|
1343
|
+
return_type = opts[:debug_return_type] || 'String'
|
|
1344
|
+
|
|
1345
|
+
# auth_names
|
|
1346
|
+
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1347
|
+
|
|
1348
|
+
new_options = opts.merge(
|
|
1349
|
+
:operation => :"CompositionsApi.export_composition_entry_items",
|
|
1350
|
+
:header_params => header_params,
|
|
1351
|
+
:query_params => query_params,
|
|
1352
|
+
:form_params => form_params,
|
|
1353
|
+
:body => post_body,
|
|
1354
|
+
:auth_names => auth_names,
|
|
1355
|
+
:return_type => return_type
|
|
1356
|
+
)
|
|
1357
|
+
|
|
1358
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1359
|
+
if @api_client.config.debugging
|
|
1360
|
+
@api_client.config.logger.debug "API called: CompositionsApi#export_composition_entry_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1056
1361
|
end
|
|
1057
1362
|
return data, status_code, headers
|
|
1058
1363
|
end
|
|
@@ -1061,11 +1366,11 @@ module ApiSdkRb
|
|
|
1061
1366
|
# The `ai-answers` adapter lets a widget answer a visitor's question with text an AI model writes from documents the widget's owner provides. This lists those documents, and how much room is left for more: `totals` carries the widget's limits next to what it uses. The list never contains what a document says, only which documents there are: their title, size and state. A `processing` document is not used to answer questions yet (or an add of it was interrupted: remove it and add it again). Add a document with `addAiAnswersKnowledgeDocument`; remove one with `removeAiAnswersKnowledgeDocument`. The caller must be allowed to see the widget: its owner, a partner for a customer it manages, or a Widgetic administrator. An API key needs the `content:read` scope.
|
|
1062
1367
|
# @param id [String] The widget (composition) whose documents to list
|
|
1063
1368
|
# @param [Hash] opts the optional parameters
|
|
1064
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1065
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1369
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1370
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1066
1371
|
# @return [GetAiAnswersKnowledge200Response]
|
|
1067
|
-
def
|
|
1068
|
-
data, _status_code, _headers =
|
|
1372
|
+
def get_ai_answers_knowledge(id, opts = {})
|
|
1373
|
+
data, _status_code, _headers = get_ai_answers_knowledge_with_http_info(id, opts)
|
|
1069
1374
|
data
|
|
1070
1375
|
end
|
|
1071
1376
|
|
|
@@ -1073,23 +1378,23 @@ module ApiSdkRb
|
|
|
1073
1378
|
# The `ai-answers` adapter lets a widget answer a visitor's question with text an AI model writes from documents the widget's owner provides. This lists those documents, and how much room is left for more: `totals` carries the widget's limits next to what it uses. The list never contains what a document says, only which documents there are: their title, size and state. A `processing` document is not used to answer questions yet (or an add of it was interrupted: remove it and add it again). Add a document with `addAiAnswersKnowledgeDocument`; remove one with `removeAiAnswersKnowledgeDocument`. The caller must be allowed to see the widget: its owner, a partner for a customer it manages, or a Widgetic administrator. An API key needs the `content:read` scope.
|
|
1074
1379
|
# @param id [String] The widget (composition) whose documents to list
|
|
1075
1380
|
# @param [Hash] opts the optional parameters
|
|
1076
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1077
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1381
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1382
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1078
1383
|
# @return [Array<(GetAiAnswersKnowledge200Response, Integer, Hash)>] GetAiAnswersKnowledge200Response data, response status code and response headers
|
|
1079
|
-
def
|
|
1384
|
+
def get_ai_answers_knowledge_with_http_info(id, opts = {})
|
|
1080
1385
|
if @api_client.config.debugging
|
|
1081
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1386
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_ai_answers_knowledge ...'
|
|
1082
1387
|
end
|
|
1083
1388
|
# verify the required parameter 'id' is set
|
|
1084
1389
|
if @api_client.config.client_side_validation && id.nil?
|
|
1085
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1390
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_ai_answers_knowledge"
|
|
1086
1391
|
end
|
|
1087
1392
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1088
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1393
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_ai_answers_knowledge, the character length must be smaller than or equal to 255.'
|
|
1089
1394
|
end
|
|
1090
1395
|
|
|
1091
1396
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1092
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1397
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_ai_answers_knowledge, the character length must be great than or equal to 1.'
|
|
1093
1398
|
end
|
|
1094
1399
|
|
|
1095
1400
|
# resource path
|
|
@@ -1118,7 +1423,7 @@ module ApiSdkRb
|
|
|
1118
1423
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1119
1424
|
|
|
1120
1425
|
new_options = opts.merge(
|
|
1121
|
-
:operation => :"CompositionsApi.
|
|
1426
|
+
:operation => :"CompositionsApi.get_ai_answers_knowledge",
|
|
1122
1427
|
:header_params => header_params,
|
|
1123
1428
|
:query_params => query_params,
|
|
1124
1429
|
:form_params => form_params,
|
|
@@ -1129,7 +1434,7 @@ module ApiSdkRb
|
|
|
1129
1434
|
|
|
1130
1435
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1131
1436
|
if @api_client.config.debugging
|
|
1132
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1437
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_ai_answers_knowledge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1133
1438
|
end
|
|
1134
1439
|
return data, status_code, headers
|
|
1135
1440
|
end
|
|
@@ -1146,11 +1451,11 @@ module ApiSdkRb
|
|
|
1146
1451
|
# @option opts [String] :status Only the compositions in this status. Without it, every status is listed.
|
|
1147
1452
|
# @option opts [String] :managed_user_id 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.
|
|
1148
1453
|
# @option opts [String] :managed_user_external_id 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.
|
|
1149
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1150
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1454
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1455
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1151
1456
|
# @return [GetAllCompositions200Response]
|
|
1152
|
-
def
|
|
1153
|
-
data, _status_code, _headers =
|
|
1457
|
+
def get_all_compositions(opts = {})
|
|
1458
|
+
data, _status_code, _headers = get_all_compositions_with_http_info(opts)
|
|
1154
1459
|
data
|
|
1155
1460
|
end
|
|
1156
1461
|
|
|
@@ -1166,23 +1471,23 @@ module ApiSdkRb
|
|
|
1166
1471
|
# @option opts [String] :status Only the compositions in this status. Without it, every status is listed.
|
|
1167
1472
|
# @option opts [String] :managed_user_id 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.
|
|
1168
1473
|
# @option opts [String] :managed_user_external_id 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.
|
|
1169
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1170
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1474
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1475
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1171
1476
|
# @return [Array<(GetAllCompositions200Response, Integer, Hash)>] GetAllCompositions200Response data, response status code and response headers
|
|
1172
|
-
def
|
|
1477
|
+
def get_all_compositions_with_http_info(opts = {})
|
|
1173
1478
|
if @api_client.config.debugging
|
|
1174
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1479
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_all_compositions ...'
|
|
1175
1480
|
end
|
|
1176
1481
|
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
1177
|
-
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CompositionsApi.
|
|
1482
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CompositionsApi.get_all_compositions, must be greater than or equal to 1.'
|
|
1178
1483
|
end
|
|
1179
1484
|
|
|
1180
1485
|
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
|
1181
|
-
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.
|
|
1486
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.get_all_compositions, must be smaller than or equal to 100.'
|
|
1182
1487
|
end
|
|
1183
1488
|
|
|
1184
1489
|
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
|
|
1185
|
-
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.
|
|
1490
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.get_all_compositions, must be greater than or equal to 1.'
|
|
1186
1491
|
end
|
|
1187
1492
|
|
|
1188
1493
|
allowable_values = ["true", "false"]
|
|
@@ -1194,15 +1499,15 @@ module ApiSdkRb
|
|
|
1194
1499
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
1195
1500
|
end
|
|
1196
1501
|
if @api_client.config.client_side_validation && !opts[:'managed_user_external_id'].nil? && opts[:'managed_user_external_id'].to_s.length > 255
|
|
1197
|
-
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling CompositionsApi.
|
|
1502
|
+
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling CompositionsApi.get_all_compositions, the character length must be smaller than or equal to 255.'
|
|
1198
1503
|
end
|
|
1199
1504
|
|
|
1200
1505
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1201
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1506
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_all_compositions, the character length must be smaller than or equal to 255.'
|
|
1202
1507
|
end
|
|
1203
1508
|
|
|
1204
1509
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1205
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1510
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_all_compositions, the character length must be great than or equal to 1.'
|
|
1206
1511
|
end
|
|
1207
1512
|
|
|
1208
1513
|
# resource path
|
|
@@ -1240,7 +1545,7 @@ module ApiSdkRb
|
|
|
1240
1545
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1241
1546
|
|
|
1242
1547
|
new_options = opts.merge(
|
|
1243
|
-
:operation => :"CompositionsApi.
|
|
1548
|
+
:operation => :"CompositionsApi.get_all_compositions",
|
|
1244
1549
|
:header_params => header_params,
|
|
1245
1550
|
:query_params => query_params,
|
|
1246
1551
|
:form_params => form_params,
|
|
@@ -1251,44 +1556,44 @@ module ApiSdkRb
|
|
|
1251
1556
|
|
|
1252
1557
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1253
1558
|
if @api_client.config.debugging
|
|
1254
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1559
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_all_compositions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1255
1560
|
end
|
|
1256
1561
|
return data, status_code, headers
|
|
1257
1562
|
end
|
|
1258
1563
|
|
|
1259
1564
|
# Get Composition
|
|
1260
|
-
# 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
|
|
1565
|
+
# 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.
|
|
1261
1566
|
# @param id [String] Composition ID
|
|
1262
1567
|
# @param [Hash] opts the optional parameters
|
|
1263
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1264
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1265
|
-
# @return [
|
|
1266
|
-
def
|
|
1267
|
-
data, _status_code, _headers =
|
|
1568
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1569
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1570
|
+
# @return [CompositionResponse]
|
|
1571
|
+
def get_composition_by_id(id, opts = {})
|
|
1572
|
+
data, _status_code, _headers = get_composition_by_id_with_http_info(id, opts)
|
|
1268
1573
|
data
|
|
1269
1574
|
end
|
|
1270
1575
|
|
|
1271
1576
|
# Get Composition
|
|
1272
|
-
# 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
|
|
1577
|
+
# 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.
|
|
1273
1578
|
# @param id [String] Composition ID
|
|
1274
1579
|
# @param [Hash] opts the optional parameters
|
|
1275
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1276
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1277
|
-
# @return [Array<(
|
|
1278
|
-
def
|
|
1580
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1581
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1582
|
+
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
1583
|
+
def get_composition_by_id_with_http_info(id, opts = {})
|
|
1279
1584
|
if @api_client.config.debugging
|
|
1280
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1585
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_by_id ...'
|
|
1281
1586
|
end
|
|
1282
1587
|
# verify the required parameter 'id' is set
|
|
1283
1588
|
if @api_client.config.client_side_validation && id.nil?
|
|
1284
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1589
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_by_id"
|
|
1285
1590
|
end
|
|
1286
1591
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1287
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1592
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_by_id, the character length must be smaller than or equal to 255.'
|
|
1288
1593
|
end
|
|
1289
1594
|
|
|
1290
1595
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1291
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1596
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_by_id, the character length must be great than or equal to 1.'
|
|
1292
1597
|
end
|
|
1293
1598
|
|
|
1294
1599
|
# resource path
|
|
@@ -1311,13 +1616,13 @@ module ApiSdkRb
|
|
|
1311
1616
|
post_body = opts[:debug_body]
|
|
1312
1617
|
|
|
1313
1618
|
# return_type
|
|
1314
|
-
return_type = opts[:debug_return_type] || '
|
|
1619
|
+
return_type = opts[:debug_return_type] || 'CompositionResponse'
|
|
1315
1620
|
|
|
1316
1621
|
# auth_names
|
|
1317
1622
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1318
1623
|
|
|
1319
1624
|
new_options = opts.merge(
|
|
1320
|
-
:operation => :"CompositionsApi.
|
|
1625
|
+
:operation => :"CompositionsApi.get_composition_by_id",
|
|
1321
1626
|
:header_params => header_params,
|
|
1322
1627
|
:query_params => query_params,
|
|
1323
1628
|
:form_params => form_params,
|
|
@@ -1328,7 +1633,7 @@ module ApiSdkRb
|
|
|
1328
1633
|
|
|
1329
1634
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1330
1635
|
if @api_client.config.debugging
|
|
1331
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1636
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1332
1637
|
end
|
|
1333
1638
|
return data, status_code, headers
|
|
1334
1639
|
end
|
|
@@ -1337,11 +1642,11 @@ module ApiSdkRb
|
|
|
1337
1642
|
# Retrieves the current content of a composition
|
|
1338
1643
|
# @param id [String] ID of the composition
|
|
1339
1644
|
# @param [Hash] opts the optional parameters
|
|
1340
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1341
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1645
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1646
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1342
1647
|
# @return [GetCompositionContentResponse]
|
|
1343
|
-
def
|
|
1344
|
-
data, _status_code, _headers =
|
|
1648
|
+
def get_composition_content(id, opts = {})
|
|
1649
|
+
data, _status_code, _headers = get_composition_content_with_http_info(id, opts)
|
|
1345
1650
|
data
|
|
1346
1651
|
end
|
|
1347
1652
|
|
|
@@ -1349,23 +1654,23 @@ module ApiSdkRb
|
|
|
1349
1654
|
# Retrieves the current content of a composition
|
|
1350
1655
|
# @param id [String] ID of the composition
|
|
1351
1656
|
# @param [Hash] opts the optional parameters
|
|
1352
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1353
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1657
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1658
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1354
1659
|
# @return [Array<(GetCompositionContentResponse, Integer, Hash)>] GetCompositionContentResponse data, response status code and response headers
|
|
1355
|
-
def
|
|
1660
|
+
def get_composition_content_with_http_info(id, opts = {})
|
|
1356
1661
|
if @api_client.config.debugging
|
|
1357
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1662
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_content ...'
|
|
1358
1663
|
end
|
|
1359
1664
|
# verify the required parameter 'id' is set
|
|
1360
1665
|
if @api_client.config.client_side_validation && id.nil?
|
|
1361
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1666
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_content"
|
|
1362
1667
|
end
|
|
1363
1668
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1364
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1669
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content, the character length must be smaller than or equal to 255.'
|
|
1365
1670
|
end
|
|
1366
1671
|
|
|
1367
1672
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1368
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1673
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content, the character length must be great than or equal to 1.'
|
|
1369
1674
|
end
|
|
1370
1675
|
|
|
1371
1676
|
# resource path
|
|
@@ -1394,7 +1699,7 @@ module ApiSdkRb
|
|
|
1394
1699
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1395
1700
|
|
|
1396
1701
|
new_options = opts.merge(
|
|
1397
|
-
:operation => :"CompositionsApi.
|
|
1702
|
+
:operation => :"CompositionsApi.get_composition_content",
|
|
1398
1703
|
:header_params => header_params,
|
|
1399
1704
|
:query_params => query_params,
|
|
1400
1705
|
:form_params => form_params,
|
|
@@ -1405,7 +1710,7 @@ module ApiSdkRb
|
|
|
1405
1710
|
|
|
1406
1711
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1407
1712
|
if @api_client.config.debugging
|
|
1408
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1713
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1409
1714
|
end
|
|
1410
1715
|
return data, status_code, headers
|
|
1411
1716
|
end
|
|
@@ -1414,11 +1719,11 @@ module ApiSdkRb
|
|
|
1414
1719
|
# Retrieves the content schema for a composition based on its widget type
|
|
1415
1720
|
# @param id [String] ID of the composition
|
|
1416
1721
|
# @param [Hash] opts the optional parameters
|
|
1417
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1418
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1722
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1723
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1419
1724
|
# @return [GetCompositionContentSchemaResponse]
|
|
1420
|
-
def
|
|
1421
|
-
data, _status_code, _headers =
|
|
1725
|
+
def get_composition_content_schema(id, opts = {})
|
|
1726
|
+
data, _status_code, _headers = get_composition_content_schema_with_http_info(id, opts)
|
|
1422
1727
|
data
|
|
1423
1728
|
end
|
|
1424
1729
|
|
|
@@ -1426,23 +1731,23 @@ module ApiSdkRb
|
|
|
1426
1731
|
# Retrieves the content schema for a composition based on its widget type
|
|
1427
1732
|
# @param id [String] ID of the composition
|
|
1428
1733
|
# @param [Hash] opts the optional parameters
|
|
1429
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1430
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1734
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1735
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1431
1736
|
# @return [Array<(GetCompositionContentSchemaResponse, Integer, Hash)>] GetCompositionContentSchemaResponse data, response status code and response headers
|
|
1432
|
-
def
|
|
1737
|
+
def get_composition_content_schema_with_http_info(id, opts = {})
|
|
1433
1738
|
if @api_client.config.debugging
|
|
1434
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1739
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_content_schema ...'
|
|
1435
1740
|
end
|
|
1436
1741
|
# verify the required parameter 'id' is set
|
|
1437
1742
|
if @api_client.config.client_side_validation && id.nil?
|
|
1438
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1743
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_content_schema"
|
|
1439
1744
|
end
|
|
1440
1745
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1441
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1746
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content_schema, the character length must be smaller than or equal to 255.'
|
|
1442
1747
|
end
|
|
1443
1748
|
|
|
1444
1749
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1445
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1750
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content_schema, the character length must be great than or equal to 1.'
|
|
1446
1751
|
end
|
|
1447
1752
|
|
|
1448
1753
|
# resource path
|
|
@@ -1471,7 +1776,7 @@ module ApiSdkRb
|
|
|
1471
1776
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1472
1777
|
|
|
1473
1778
|
new_options = opts.merge(
|
|
1474
|
-
:operation => :"CompositionsApi.
|
|
1779
|
+
:operation => :"CompositionsApi.get_composition_content_schema",
|
|
1475
1780
|
:header_params => header_params,
|
|
1476
1781
|
:query_params => query_params,
|
|
1477
1782
|
:form_params => form_params,
|
|
@@ -1482,7 +1787,7 @@ module ApiSdkRb
|
|
|
1482
1787
|
|
|
1483
1788
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1484
1789
|
if @api_client.config.debugging
|
|
1485
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1790
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_content_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1486
1791
|
end
|
|
1487
1792
|
return data, status_code, headers
|
|
1488
1793
|
end
|
|
@@ -1491,11 +1796,11 @@ module ApiSdkRb
|
|
|
1491
1796
|
# The data source that is bound to the composition: `url` and `refreshSeconds`. The answer's `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
|
|
1492
1797
|
# @param id [String]
|
|
1493
1798
|
# @param [Hash] opts the optional parameters
|
|
1494
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1495
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1799
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1800
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1496
1801
|
# @return [GetCompositionDataSourceResponse]
|
|
1497
|
-
def
|
|
1498
|
-
data, _status_code, _headers =
|
|
1802
|
+
def get_composition_data_source(id, opts = {})
|
|
1803
|
+
data, _status_code, _headers = get_composition_data_source_with_http_info(id, opts)
|
|
1499
1804
|
data
|
|
1500
1805
|
end
|
|
1501
1806
|
|
|
@@ -1503,23 +1808,23 @@ module ApiSdkRb
|
|
|
1503
1808
|
# The data source that is bound to the composition: `url` and `refreshSeconds`. The answer's `data` is `null` when none is bound, and also when what is stored does not pass the rule for a public https address (a binding written by another path, such as the general embed-settings update, is never shown to a page unless it passes the same checks as this route).
|
|
1504
1809
|
# @param id [String]
|
|
1505
1810
|
# @param [Hash] opts the optional parameters
|
|
1506
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1507
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1811
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1812
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1508
1813
|
# @return [Array<(GetCompositionDataSourceResponse, Integer, Hash)>] GetCompositionDataSourceResponse data, response status code and response headers
|
|
1509
|
-
def
|
|
1814
|
+
def get_composition_data_source_with_http_info(id, opts = {})
|
|
1510
1815
|
if @api_client.config.debugging
|
|
1511
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1816
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_data_source ...'
|
|
1512
1817
|
end
|
|
1513
1818
|
# verify the required parameter 'id' is set
|
|
1514
1819
|
if @api_client.config.client_side_validation && id.nil?
|
|
1515
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1820
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_data_source"
|
|
1516
1821
|
end
|
|
1517
1822
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1518
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1823
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_data_source, the character length must be smaller than or equal to 255.'
|
|
1519
1824
|
end
|
|
1520
1825
|
|
|
1521
1826
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1522
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1827
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_data_source, the character length must be great than or equal to 1.'
|
|
1523
1828
|
end
|
|
1524
1829
|
|
|
1525
1830
|
# resource path
|
|
@@ -1548,7 +1853,7 @@ module ApiSdkRb
|
|
|
1548
1853
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1549
1854
|
|
|
1550
1855
|
new_options = opts.merge(
|
|
1551
|
-
:operation => :"CompositionsApi.
|
|
1856
|
+
:operation => :"CompositionsApi.get_composition_data_source",
|
|
1552
1857
|
:header_params => header_params,
|
|
1553
1858
|
:query_params => query_params,
|
|
1554
1859
|
:form_params => form_params,
|
|
@@ -1559,7 +1864,7 @@ module ApiSdkRb
|
|
|
1559
1864
|
|
|
1560
1865
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1561
1866
|
if @api_client.config.debugging
|
|
1562
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1867
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1563
1868
|
end
|
|
1564
1869
|
return data, status_code, headers
|
|
1565
1870
|
end
|
|
@@ -1570,11 +1875,11 @@ module ApiSdkRb
|
|
|
1570
1875
|
# @param table [String] Name of the database table
|
|
1571
1876
|
# @param record_id [String] ID of the record to retrieve
|
|
1572
1877
|
# @param [Hash] opts the optional parameters
|
|
1573
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1574
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1575
|
-
# @return [
|
|
1576
|
-
def
|
|
1577
|
-
data, _status_code, _headers =
|
|
1878
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1879
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1880
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
1881
|
+
def get_composition_database_record(id, table, record_id, opts = {})
|
|
1882
|
+
data, _status_code, _headers = get_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
1578
1883
|
data
|
|
1579
1884
|
end
|
|
1580
1885
|
|
|
@@ -1584,31 +1889,31 @@ module ApiSdkRb
|
|
|
1584
1889
|
# @param table [String] Name of the database table
|
|
1585
1890
|
# @param record_id [String] ID of the record to retrieve
|
|
1586
1891
|
# @param [Hash] opts the optional parameters
|
|
1587
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1588
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1589
|
-
# @return [Array<(
|
|
1590
|
-
def
|
|
1892
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1893
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1894
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
1895
|
+
def get_composition_database_record_with_http_info(id, table, record_id, opts = {})
|
|
1591
1896
|
if @api_client.config.debugging
|
|
1592
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1897
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_database_record ...'
|
|
1593
1898
|
end
|
|
1594
1899
|
# verify the required parameter 'id' is set
|
|
1595
1900
|
if @api_client.config.client_side_validation && id.nil?
|
|
1596
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1901
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_database_record"
|
|
1597
1902
|
end
|
|
1598
1903
|
# verify the required parameter 'table' is set
|
|
1599
1904
|
if @api_client.config.client_side_validation && table.nil?
|
|
1600
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
1905
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.get_composition_database_record"
|
|
1601
1906
|
end
|
|
1602
1907
|
# verify the required parameter 'record_id' is set
|
|
1603
1908
|
if @api_client.config.client_side_validation && record_id.nil?
|
|
1604
|
-
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.
|
|
1909
|
+
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.get_composition_database_record"
|
|
1605
1910
|
end
|
|
1606
1911
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1607
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1912
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
1608
1913
|
end
|
|
1609
1914
|
|
|
1610
1915
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1611
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1916
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_record, the character length must be great than or equal to 1.'
|
|
1612
1917
|
end
|
|
1613
1918
|
|
|
1614
1919
|
# resource path
|
|
@@ -1631,13 +1936,13 @@ module ApiSdkRb
|
|
|
1631
1936
|
post_body = opts[:debug_body]
|
|
1632
1937
|
|
|
1633
1938
|
# return_type
|
|
1634
|
-
return_type = opts[:debug_return_type] || '
|
|
1939
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
1635
1940
|
|
|
1636
1941
|
# auth_names
|
|
1637
1942
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1638
1943
|
|
|
1639
1944
|
new_options = opts.merge(
|
|
1640
|
-
:operation => :"CompositionsApi.
|
|
1945
|
+
:operation => :"CompositionsApi.get_composition_database_record",
|
|
1641
1946
|
:header_params => header_params,
|
|
1642
1947
|
:query_params => query_params,
|
|
1643
1948
|
:form_params => form_params,
|
|
@@ -1648,7 +1953,7 @@ module ApiSdkRb
|
|
|
1648
1953
|
|
|
1649
1954
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1650
1955
|
if @api_client.config.debugging
|
|
1651
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1956
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1652
1957
|
end
|
|
1653
1958
|
return data, status_code, headers
|
|
1654
1959
|
end
|
|
@@ -1658,11 +1963,11 @@ module ApiSdkRb
|
|
|
1658
1963
|
# @param id [String] ID of the composition
|
|
1659
1964
|
# @param table [String] Name of the database table
|
|
1660
1965
|
# @param [Hash] opts the optional parameters
|
|
1661
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1662
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1966
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1967
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1663
1968
|
# @return [GetCompositionDatabaseRecords200Response]
|
|
1664
|
-
def
|
|
1665
|
-
data, _status_code, _headers =
|
|
1969
|
+
def get_composition_database_records(id, table, opts = {})
|
|
1970
|
+
data, _status_code, _headers = get_composition_database_records_with_http_info(id, table, opts)
|
|
1666
1971
|
data
|
|
1667
1972
|
end
|
|
1668
1973
|
|
|
@@ -1671,27 +1976,27 @@ module ApiSdkRb
|
|
|
1671
1976
|
# @param id [String] ID of the composition
|
|
1672
1977
|
# @param table [String] Name of the database table
|
|
1673
1978
|
# @param [Hash] opts the optional parameters
|
|
1674
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1675
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
1979
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1980
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1676
1981
|
# @return [Array<(GetCompositionDatabaseRecords200Response, Integer, Hash)>] GetCompositionDatabaseRecords200Response data, response status code and response headers
|
|
1677
|
-
def
|
|
1982
|
+
def get_composition_database_records_with_http_info(id, table, opts = {})
|
|
1678
1983
|
if @api_client.config.debugging
|
|
1679
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1984
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_database_records ...'
|
|
1680
1985
|
end
|
|
1681
1986
|
# verify the required parameter 'id' is set
|
|
1682
1987
|
if @api_client.config.client_side_validation && id.nil?
|
|
1683
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1988
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_database_records"
|
|
1684
1989
|
end
|
|
1685
1990
|
# verify the required parameter 'table' is set
|
|
1686
1991
|
if @api_client.config.client_side_validation && table.nil?
|
|
1687
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
1992
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.get_composition_database_records"
|
|
1688
1993
|
end
|
|
1689
1994
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1690
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1995
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_records, the character length must be smaller than or equal to 255.'
|
|
1691
1996
|
end
|
|
1692
1997
|
|
|
1693
1998
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1694
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1999
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_records, the character length must be great than or equal to 1.'
|
|
1695
2000
|
end
|
|
1696
2001
|
|
|
1697
2002
|
# resource path
|
|
@@ -1720,7 +2025,7 @@ module ApiSdkRb
|
|
|
1720
2025
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1721
2026
|
|
|
1722
2027
|
new_options = opts.merge(
|
|
1723
|
-
:operation => :"CompositionsApi.
|
|
2028
|
+
:operation => :"CompositionsApi.get_composition_database_records",
|
|
1724
2029
|
:header_params => header_params,
|
|
1725
2030
|
:query_params => query_params,
|
|
1726
2031
|
:form_params => form_params,
|
|
@@ -1731,7 +2036,7 @@ module ApiSdkRb
|
|
|
1731
2036
|
|
|
1732
2037
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1733
2038
|
if @api_client.config.debugging
|
|
1734
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2039
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_database_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1735
2040
|
end
|
|
1736
2041
|
return data, status_code, headers
|
|
1737
2042
|
end
|
|
@@ -1740,11 +2045,11 @@ module ApiSdkRb
|
|
|
1740
2045
|
# Retrieves only the design field from a composition.
|
|
1741
2046
|
# @param id [String] ID of the composition
|
|
1742
2047
|
# @param [Hash] opts the optional parameters
|
|
1743
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1744
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2048
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2049
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1745
2050
|
# @return [GetCompositionDesignResponse]
|
|
1746
|
-
def
|
|
1747
|
-
data, _status_code, _headers =
|
|
2051
|
+
def get_composition_design(id, opts = {})
|
|
2052
|
+
data, _status_code, _headers = get_composition_design_with_http_info(id, opts)
|
|
1748
2053
|
data
|
|
1749
2054
|
end
|
|
1750
2055
|
|
|
@@ -1752,23 +2057,23 @@ module ApiSdkRb
|
|
|
1752
2057
|
# Retrieves only the design field from a composition.
|
|
1753
2058
|
# @param id [String] ID of the composition
|
|
1754
2059
|
# @param [Hash] opts the optional parameters
|
|
1755
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1756
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2060
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2061
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1757
2062
|
# @return [Array<(GetCompositionDesignResponse, Integer, Hash)>] GetCompositionDesignResponse data, response status code and response headers
|
|
1758
|
-
def
|
|
2063
|
+
def get_composition_design_with_http_info(id, opts = {})
|
|
1759
2064
|
if @api_client.config.debugging
|
|
1760
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2065
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_design ...'
|
|
1761
2066
|
end
|
|
1762
2067
|
# verify the required parameter 'id' is set
|
|
1763
2068
|
if @api_client.config.client_side_validation && id.nil?
|
|
1764
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2069
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_design"
|
|
1765
2070
|
end
|
|
1766
2071
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1767
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2072
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design, the character length must be smaller than or equal to 255.'
|
|
1768
2073
|
end
|
|
1769
2074
|
|
|
1770
2075
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1771
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2076
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design, the character length must be great than or equal to 1.'
|
|
1772
2077
|
end
|
|
1773
2078
|
|
|
1774
2079
|
# resource path
|
|
@@ -1797,7 +2102,7 @@ module ApiSdkRb
|
|
|
1797
2102
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1798
2103
|
|
|
1799
2104
|
new_options = opts.merge(
|
|
1800
|
-
:operation => :"CompositionsApi.
|
|
2105
|
+
:operation => :"CompositionsApi.get_composition_design",
|
|
1801
2106
|
:header_params => header_params,
|
|
1802
2107
|
:query_params => query_params,
|
|
1803
2108
|
:form_params => form_params,
|
|
@@ -1808,7 +2113,7 @@ module ApiSdkRb
|
|
|
1808
2113
|
|
|
1809
2114
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1810
2115
|
if @api_client.config.debugging
|
|
1811
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2116
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_design\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1812
2117
|
end
|
|
1813
2118
|
return data, status_code, headers
|
|
1814
2119
|
end
|
|
@@ -1817,11 +2122,11 @@ module ApiSdkRb
|
|
|
1817
2122
|
# Retrieves the design schema for a composition based on its widget type
|
|
1818
2123
|
# @param id [String] ID of the composition
|
|
1819
2124
|
# @param [Hash] opts the optional parameters
|
|
1820
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1821
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2125
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2126
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1822
2127
|
# @return [GetCompositionDesignSchemaResponse]
|
|
1823
|
-
def
|
|
1824
|
-
data, _status_code, _headers =
|
|
2128
|
+
def get_composition_design_schema(id, opts = {})
|
|
2129
|
+
data, _status_code, _headers = get_composition_design_schema_with_http_info(id, opts)
|
|
1825
2130
|
data
|
|
1826
2131
|
end
|
|
1827
2132
|
|
|
@@ -1829,23 +2134,23 @@ module ApiSdkRb
|
|
|
1829
2134
|
# Retrieves the design schema for a composition based on its widget type
|
|
1830
2135
|
# @param id [String] ID of the composition
|
|
1831
2136
|
# @param [Hash] opts the optional parameters
|
|
1832
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1833
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2137
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2138
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1834
2139
|
# @return [Array<(GetCompositionDesignSchemaResponse, Integer, Hash)>] GetCompositionDesignSchemaResponse data, response status code and response headers
|
|
1835
|
-
def
|
|
2140
|
+
def get_composition_design_schema_with_http_info(id, opts = {})
|
|
1836
2141
|
if @api_client.config.debugging
|
|
1837
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2142
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_design_schema ...'
|
|
1838
2143
|
end
|
|
1839
2144
|
# verify the required parameter 'id' is set
|
|
1840
2145
|
if @api_client.config.client_side_validation && id.nil?
|
|
1841
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2146
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_design_schema"
|
|
1842
2147
|
end
|
|
1843
2148
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1844
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2149
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design_schema, the character length must be smaller than or equal to 255.'
|
|
1845
2150
|
end
|
|
1846
2151
|
|
|
1847
2152
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1848
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2153
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design_schema, the character length must be great than or equal to 1.'
|
|
1849
2154
|
end
|
|
1850
2155
|
|
|
1851
2156
|
# resource path
|
|
@@ -1874,7 +2179,7 @@ module ApiSdkRb
|
|
|
1874
2179
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1875
2180
|
|
|
1876
2181
|
new_options = opts.merge(
|
|
1877
|
-
:operation => :"CompositionsApi.
|
|
2182
|
+
:operation => :"CompositionsApi.get_composition_design_schema",
|
|
1878
2183
|
:header_params => header_params,
|
|
1879
2184
|
:query_params => query_params,
|
|
1880
2185
|
:form_params => form_params,
|
|
@@ -1885,7 +2190,7 @@ module ApiSdkRb
|
|
|
1885
2190
|
|
|
1886
2191
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1887
2192
|
if @api_client.config.debugging
|
|
1888
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2193
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_design_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1889
2194
|
end
|
|
1890
2195
|
return data, status_code, headers
|
|
1891
2196
|
end
|
|
@@ -1894,11 +2199,11 @@ module ApiSdkRb
|
|
|
1894
2199
|
# Retrieves the definition of the composition's Embed tab: which settings exist, what each one holds, what it defaults to, and when its control is shown. It is the third tab beside `schema/content` and `schema/design`, in the same format (`componentGroups` → `components` → `propertyGroups` → `properties`, each property with a `type`, a `defaultValue` and an `inputController`), so a client that draws those two tabs draws this one with the same code. The schema is the same for every composition (it is the one Widgetic's own Embed Editor draws). The composition id decides who may ask: the caller must be able to read the composition. Reading and saving the values: - `GET /compositions/{id}/embed-settings` returns what the composition saved. A composition whose Embed tab was never saved has nothing to return; seed the form from `defaults`, which holds the `defaultValue` of every setting that declares one. - `PUT /compositions/{id}` with `embedSettings` saves them. The gateway stores `embedSettings` as given and does not check it against this schema; the schema is how a client knows what to put there. A property's `visibilityCondition` says when its control is shown: `condition` is a comparison of the current values of the properties named in `dependsOn` (`useIframe === false`, `embedTarget === 'mixed' && keepDimensions === false`). While it is false the Embed Editor does not show the control. A colour picker with `showOpacityControls` saves its opacity next to the colour, under the key `<name>_opacity` as a number from 0 to 1 (`overlayBackgroundColor` → `overlayBackgroundColor_opacity`). Its `defaultTransparency` is a percentage and the saved value a fraction (50 → 0.5).
|
|
1895
2200
|
# @param id [String] ID of the composition
|
|
1896
2201
|
# @param [Hash] opts the optional parameters
|
|
1897
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1898
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2202
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2203
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1899
2204
|
# @return [GetCompositionEmbedSchemaResponse]
|
|
1900
|
-
def
|
|
1901
|
-
data, _status_code, _headers =
|
|
2205
|
+
def get_composition_embed_schema(id, opts = {})
|
|
2206
|
+
data, _status_code, _headers = get_composition_embed_schema_with_http_info(id, opts)
|
|
1902
2207
|
data
|
|
1903
2208
|
end
|
|
1904
2209
|
|
|
@@ -1906,23 +2211,23 @@ module ApiSdkRb
|
|
|
1906
2211
|
# Retrieves the definition of the composition's Embed tab: which settings exist, what each one holds, what it defaults to, and when its control is shown. It is the third tab beside `schema/content` and `schema/design`, in the same format (`componentGroups` → `components` → `propertyGroups` → `properties`, each property with a `type`, a `defaultValue` and an `inputController`), so a client that draws those two tabs draws this one with the same code. The schema is the same for every composition (it is the one Widgetic's own Embed Editor draws). The composition id decides who may ask: the caller must be able to read the composition. Reading and saving the values: - `GET /compositions/{id}/embed-settings` returns what the composition saved. A composition whose Embed tab was never saved has nothing to return; seed the form from `defaults`, which holds the `defaultValue` of every setting that declares one. - `PUT /compositions/{id}` with `embedSettings` saves them. The gateway stores `embedSettings` as given and does not check it against this schema; the schema is how a client knows what to put there. A property's `visibilityCondition` says when its control is shown: `condition` is a comparison of the current values of the properties named in `dependsOn` (`useIframe === false`, `embedTarget === 'mixed' && keepDimensions === false`). While it is false the Embed Editor does not show the control. A colour picker with `showOpacityControls` saves its opacity next to the colour, under the key `<name>_opacity` as a number from 0 to 1 (`overlayBackgroundColor` → `overlayBackgroundColor_opacity`). Its `defaultTransparency` is a percentage and the saved value a fraction (50 → 0.5).
|
|
1907
2212
|
# @param id [String] ID of the composition
|
|
1908
2213
|
# @param [Hash] opts the optional parameters
|
|
1909
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1910
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2214
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2215
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1911
2216
|
# @return [Array<(GetCompositionEmbedSchemaResponse, Integer, Hash)>] GetCompositionEmbedSchemaResponse data, response status code and response headers
|
|
1912
|
-
def
|
|
2217
|
+
def get_composition_embed_schema_with_http_info(id, opts = {})
|
|
1913
2218
|
if @api_client.config.debugging
|
|
1914
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2219
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_embed_schema ...'
|
|
1915
2220
|
end
|
|
1916
2221
|
# verify the required parameter 'id' is set
|
|
1917
2222
|
if @api_client.config.client_side_validation && id.nil?
|
|
1918
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2223
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_embed_schema"
|
|
1919
2224
|
end
|
|
1920
2225
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1921
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2226
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_schema, the character length must be smaller than or equal to 255.'
|
|
1922
2227
|
end
|
|
1923
2228
|
|
|
1924
2229
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1925
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2230
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_schema, the character length must be great than or equal to 1.'
|
|
1926
2231
|
end
|
|
1927
2232
|
|
|
1928
2233
|
# resource path
|
|
@@ -1951,7 +2256,7 @@ module ApiSdkRb
|
|
|
1951
2256
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1952
2257
|
|
|
1953
2258
|
new_options = opts.merge(
|
|
1954
|
-
:operation => :"CompositionsApi.
|
|
2259
|
+
:operation => :"CompositionsApi.get_composition_embed_schema",
|
|
1955
2260
|
:header_params => header_params,
|
|
1956
2261
|
:query_params => query_params,
|
|
1957
2262
|
:form_params => form_params,
|
|
@@ -1962,7 +2267,7 @@ module ApiSdkRb
|
|
|
1962
2267
|
|
|
1963
2268
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1964
2269
|
if @api_client.config.debugging
|
|
1965
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2270
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_embed_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1966
2271
|
end
|
|
1967
2272
|
return data, status_code, headers
|
|
1968
2273
|
end
|
|
@@ -1971,11 +2276,11 @@ module ApiSdkRb
|
|
|
1971
2276
|
# Retrieves only the embedSettings field from a composition.
|
|
1972
2277
|
# @param id [String] ID of the composition
|
|
1973
2278
|
# @param [Hash] opts the optional parameters
|
|
1974
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1975
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2279
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2280
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1976
2281
|
# @return [GetCompositionEmbedSettingsResponse]
|
|
1977
|
-
def
|
|
1978
|
-
data, _status_code, _headers =
|
|
2282
|
+
def get_composition_embed_settings(id, opts = {})
|
|
2283
|
+
data, _status_code, _headers = get_composition_embed_settings_with_http_info(id, opts)
|
|
1979
2284
|
data
|
|
1980
2285
|
end
|
|
1981
2286
|
|
|
@@ -1983,23 +2288,23 @@ module ApiSdkRb
|
|
|
1983
2288
|
# Retrieves only the embedSettings field from a composition.
|
|
1984
2289
|
# @param id [String] ID of the composition
|
|
1985
2290
|
# @param [Hash] opts the optional parameters
|
|
1986
|
-
# @option opts [String] :x_managed_user_id 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
|
|
1987
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2291
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2292
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1988
2293
|
# @return [Array<(GetCompositionEmbedSettingsResponse, Integer, Hash)>] GetCompositionEmbedSettingsResponse data, response status code and response headers
|
|
1989
|
-
def
|
|
2294
|
+
def get_composition_embed_settings_with_http_info(id, opts = {})
|
|
1990
2295
|
if @api_client.config.debugging
|
|
1991
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2296
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_embed_settings ...'
|
|
1992
2297
|
end
|
|
1993
2298
|
# verify the required parameter 'id' is set
|
|
1994
2299
|
if @api_client.config.client_side_validation && id.nil?
|
|
1995
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2300
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_embed_settings"
|
|
1996
2301
|
end
|
|
1997
2302
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1998
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2303
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_settings, the character length must be smaller than or equal to 255.'
|
|
1999
2304
|
end
|
|
2000
2305
|
|
|
2001
2306
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2002
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2307
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_settings, the character length must be great than or equal to 1.'
|
|
2003
2308
|
end
|
|
2004
2309
|
|
|
2005
2310
|
# resource path
|
|
@@ -2028,7 +2333,7 @@ module ApiSdkRb
|
|
|
2028
2333
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2029
2334
|
|
|
2030
2335
|
new_options = opts.merge(
|
|
2031
|
-
:operation => :"CompositionsApi.
|
|
2336
|
+
:operation => :"CompositionsApi.get_composition_embed_settings",
|
|
2032
2337
|
:header_params => header_params,
|
|
2033
2338
|
:query_params => query_params,
|
|
2034
2339
|
:form_params => form_params,
|
|
@@ -2039,7 +2344,7 @@ module ApiSdkRb
|
|
|
2039
2344
|
|
|
2040
2345
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2041
2346
|
if @api_client.config.debugging
|
|
2042
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2347
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_embed_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2043
2348
|
end
|
|
2044
2349
|
return data, status_code, headers
|
|
2045
2350
|
end
|
|
@@ -2048,11 +2353,11 @@ module ApiSdkRb
|
|
|
2048
2353
|
# Returns the address of the page an editor shows the composition in: the page of the widget's published version on the CDN, with the widget and version it is. Load it in a frame, then send the frame what to show (the content, design and embed settings you read from the composition, and every change the user makes) with `postMessage`: `{ type: 'widgetic:update', design }`, `{ type: 'widgetic:update', content }` or `{ type: 'widgetic:update', contentItems }`. The version is the one embeds show, so the editor previews what a visitor gets. The address does not carry the composition id: an embed uses the id to fetch the saved composition itself, while an editor sends the current state (unsaved changes included). A widget that has never been published has no page to show: the answer is 409 `WIDGET_NOT_PUBLISHED`.
|
|
2049
2354
|
# @param id [String] ID of the composition
|
|
2050
2355
|
# @param [Hash] opts the optional parameters
|
|
2051
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2052
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2356
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2357
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2053
2358
|
# @return [GetCompositionPreviewResponse]
|
|
2054
|
-
def
|
|
2055
|
-
data, _status_code, _headers =
|
|
2359
|
+
def get_composition_preview(id, opts = {})
|
|
2360
|
+
data, _status_code, _headers = get_composition_preview_with_http_info(id, opts)
|
|
2056
2361
|
data
|
|
2057
2362
|
end
|
|
2058
2363
|
|
|
@@ -2060,23 +2365,23 @@ module ApiSdkRb
|
|
|
2060
2365
|
# Returns the address of the page an editor shows the composition in: the page of the widget's published version on the CDN, with the widget and version it is. Load it in a frame, then send the frame what to show (the content, design and embed settings you read from the composition, and every change the user makes) with `postMessage`: `{ type: 'widgetic:update', design }`, `{ type: 'widgetic:update', content }` or `{ type: 'widgetic:update', contentItems }`. The version is the one embeds show, so the editor previews what a visitor gets. The address does not carry the composition id: an embed uses the id to fetch the saved composition itself, while an editor sends the current state (unsaved changes included). A widget that has never been published has no page to show: the answer is 409 `WIDGET_NOT_PUBLISHED`.
|
|
2061
2366
|
# @param id [String] ID of the composition
|
|
2062
2367
|
# @param [Hash] opts the optional parameters
|
|
2063
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2064
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2368
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2369
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2065
2370
|
# @return [Array<(GetCompositionPreviewResponse, Integer, Hash)>] GetCompositionPreviewResponse data, response status code and response headers
|
|
2066
|
-
def
|
|
2371
|
+
def get_composition_preview_with_http_info(id, opts = {})
|
|
2067
2372
|
if @api_client.config.debugging
|
|
2068
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2373
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_preview ...'
|
|
2069
2374
|
end
|
|
2070
2375
|
# verify the required parameter 'id' is set
|
|
2071
2376
|
if @api_client.config.client_side_validation && id.nil?
|
|
2072
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2377
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_preview"
|
|
2073
2378
|
end
|
|
2074
2379
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2075
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2380
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_preview, the character length must be smaller than or equal to 255.'
|
|
2076
2381
|
end
|
|
2077
2382
|
|
|
2078
2383
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2079
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2384
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_preview, the character length must be great than or equal to 1.'
|
|
2080
2385
|
end
|
|
2081
2386
|
|
|
2082
2387
|
# resource path
|
|
@@ -2105,7 +2410,7 @@ module ApiSdkRb
|
|
|
2105
2410
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2106
2411
|
|
|
2107
2412
|
new_options = opts.merge(
|
|
2108
|
-
:operation => :"CompositionsApi.
|
|
2413
|
+
:operation => :"CompositionsApi.get_composition_preview",
|
|
2109
2414
|
:header_params => header_params,
|
|
2110
2415
|
:query_params => query_params,
|
|
2111
2416
|
:form_params => form_params,
|
|
@@ -2116,7 +2421,7 @@ module ApiSdkRb
|
|
|
2116
2421
|
|
|
2117
2422
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2118
2423
|
if @api_client.config.debugging
|
|
2119
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2424
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2120
2425
|
end
|
|
2121
2426
|
return data, status_code, headers
|
|
2122
2427
|
end
|
|
@@ -2125,11 +2430,11 @@ module ApiSdkRb
|
|
|
2125
2430
|
# Retrieves version history for a specific composition.
|
|
2126
2431
|
# @param id [String] Composition ID
|
|
2127
2432
|
# @param [Hash] opts the optional parameters
|
|
2128
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2129
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2433
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2434
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2130
2435
|
# @return [GetCompositionVersions200Response]
|
|
2131
|
-
def
|
|
2132
|
-
data, _status_code, _headers =
|
|
2436
|
+
def get_composition_versions(id, opts = {})
|
|
2437
|
+
data, _status_code, _headers = get_composition_versions_with_http_info(id, opts)
|
|
2133
2438
|
data
|
|
2134
2439
|
end
|
|
2135
2440
|
|
|
@@ -2137,23 +2442,23 @@ module ApiSdkRb
|
|
|
2137
2442
|
# Retrieves version history for a specific composition.
|
|
2138
2443
|
# @param id [String] Composition ID
|
|
2139
2444
|
# @param [Hash] opts the optional parameters
|
|
2140
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2141
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2445
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2446
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2142
2447
|
# @return [Array<(GetCompositionVersions200Response, Integer, Hash)>] GetCompositionVersions200Response data, response status code and response headers
|
|
2143
|
-
def
|
|
2448
|
+
def get_composition_versions_with_http_info(id, opts = {})
|
|
2144
2449
|
if @api_client.config.debugging
|
|
2145
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2450
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_versions ...'
|
|
2146
2451
|
end
|
|
2147
2452
|
# verify the required parameter 'id' is set
|
|
2148
2453
|
if @api_client.config.client_side_validation && id.nil?
|
|
2149
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2454
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_versions"
|
|
2150
2455
|
end
|
|
2151
2456
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2152
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2457
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_versions, the character length must be smaller than or equal to 255.'
|
|
2153
2458
|
end
|
|
2154
2459
|
|
|
2155
2460
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2156
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2461
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_versions, the character length must be great than or equal to 1.'
|
|
2157
2462
|
end
|
|
2158
2463
|
|
|
2159
2464
|
# resource path
|
|
@@ -2182,7 +2487,7 @@ module ApiSdkRb
|
|
|
2182
2487
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2183
2488
|
|
|
2184
2489
|
new_options = opts.merge(
|
|
2185
|
-
:operation => :"CompositionsApi.
|
|
2490
|
+
:operation => :"CompositionsApi.get_composition_versions",
|
|
2186
2491
|
:header_params => header_params,
|
|
2187
2492
|
:query_params => query_params,
|
|
2188
2493
|
:form_params => form_params,
|
|
@@ -2193,7 +2498,7 @@ module ApiSdkRb
|
|
|
2193
2498
|
|
|
2194
2499
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2195
2500
|
if @api_client.config.debugging
|
|
2196
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2501
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2197
2502
|
end
|
|
2198
2503
|
return data, status_code, headers
|
|
2199
2504
|
end
|
|
@@ -2203,8 +2508,8 @@ module ApiSdkRb
|
|
|
2203
2508
|
# @param get_compositions_batch_request [GetCompositionsBatchRequest]
|
|
2204
2509
|
# @param [Hash] opts the optional parameters
|
|
2205
2510
|
# @return [GetCompositionsBatchResponse]
|
|
2206
|
-
def
|
|
2207
|
-
data, _status_code, _headers =
|
|
2511
|
+
def get_compositions_batch(get_compositions_batch_request, opts = {})
|
|
2512
|
+
data, _status_code, _headers = get_compositions_batch_with_http_info(get_compositions_batch_request, opts)
|
|
2208
2513
|
data
|
|
2209
2514
|
end
|
|
2210
2515
|
|
|
@@ -2213,13 +2518,13 @@ module ApiSdkRb
|
|
|
2213
2518
|
# @param get_compositions_batch_request [GetCompositionsBatchRequest]
|
|
2214
2519
|
# @param [Hash] opts the optional parameters
|
|
2215
2520
|
# @return [Array<(GetCompositionsBatchResponse, Integer, Hash)>] GetCompositionsBatchResponse data, response status code and response headers
|
|
2216
|
-
def
|
|
2521
|
+
def get_compositions_batch_with_http_info(get_compositions_batch_request, opts = {})
|
|
2217
2522
|
if @api_client.config.debugging
|
|
2218
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2523
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_compositions_batch ...'
|
|
2219
2524
|
end
|
|
2220
2525
|
# verify the required parameter 'get_compositions_batch_request' is set
|
|
2221
2526
|
if @api_client.config.client_side_validation && get_compositions_batch_request.nil?
|
|
2222
|
-
fail ArgumentError, "Missing the required parameter 'get_compositions_batch_request' when calling CompositionsApi.
|
|
2527
|
+
fail ArgumentError, "Missing the required parameter 'get_compositions_batch_request' when calling CompositionsApi.get_compositions_batch"
|
|
2223
2528
|
end
|
|
2224
2529
|
# resource path
|
|
2225
2530
|
local_var_path = '/compositions/batch'
|
|
@@ -2250,7 +2555,7 @@ module ApiSdkRb
|
|
|
2250
2555
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2251
2556
|
|
|
2252
2557
|
new_options = opts.merge(
|
|
2253
|
-
:operation => :"CompositionsApi.
|
|
2558
|
+
:operation => :"CompositionsApi.get_compositions_batch",
|
|
2254
2559
|
:header_params => header_params,
|
|
2255
2560
|
:query_params => query_params,
|
|
2256
2561
|
:form_params => form_params,
|
|
@@ -2261,7 +2566,127 @@ module ApiSdkRb
|
|
|
2261
2566
|
|
|
2262
2567
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2263
2568
|
if @api_client.config.debugging
|
|
2264
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2569
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_compositions_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2570
|
+
end
|
|
2571
|
+
return data, status_code, headers
|
|
2572
|
+
end
|
|
2573
|
+
|
|
2574
|
+
# List composition entry items with paging and filters
|
|
2575
|
+
# 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.
|
|
2576
|
+
# @param id [String]
|
|
2577
|
+
# @param table [String]
|
|
2578
|
+
# @param [Hash] opts the optional parameters
|
|
2579
|
+
# @option opts [Integer] :limit (default to 25)
|
|
2580
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
2581
|
+
# @option opts [Time] :since 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`.
|
|
2582
|
+
# @option opts [Time] :_until 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`).
|
|
2583
|
+
# @option opts [String] :cursor
|
|
2584
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
2585
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
2586
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2587
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2588
|
+
# @return [CompositionEntryItemsPageSuccess]
|
|
2589
|
+
def list_composition_entry_items(id, table, opts = {})
|
|
2590
|
+
data, _status_code, _headers = list_composition_entry_items_with_http_info(id, table, opts)
|
|
2591
|
+
data
|
|
2592
|
+
end
|
|
2593
|
+
|
|
2594
|
+
# List composition entry items with paging and filters
|
|
2595
|
+
# 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.
|
|
2596
|
+
# @param id [String]
|
|
2597
|
+
# @param table [String]
|
|
2598
|
+
# @param [Hash] opts the optional parameters
|
|
2599
|
+
# @option opts [Integer] :limit (default to 25)
|
|
2600
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
2601
|
+
# @option opts [Time] :since 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`.
|
|
2602
|
+
# @option opts [Time] :_until 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`).
|
|
2603
|
+
# @option opts [String] :cursor
|
|
2604
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
2605
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
2606
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2607
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2608
|
+
# @return [Array<(CompositionEntryItemsPageSuccess, Integer, Hash)>] CompositionEntryItemsPageSuccess data, response status code and response headers
|
|
2609
|
+
def list_composition_entry_items_with_http_info(id, table, opts = {})
|
|
2610
|
+
if @api_client.config.debugging
|
|
2611
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.list_composition_entry_items ...'
|
|
2612
|
+
end
|
|
2613
|
+
# verify the required parameter 'id' is set
|
|
2614
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
2615
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.list_composition_entry_items"
|
|
2616
|
+
end
|
|
2617
|
+
# verify the required parameter 'table' is set
|
|
2618
|
+
if @api_client.config.client_side_validation && table.nil?
|
|
2619
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.list_composition_entry_items"
|
|
2620
|
+
end
|
|
2621
|
+
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
2622
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.list_composition_entry_items, the character length must be smaller than or equal to 63.'
|
|
2623
|
+
end
|
|
2624
|
+
|
|
2625
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
2626
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompositionsApi.list_composition_entry_items, must be smaller than or equal to 100.'
|
|
2627
|
+
end
|
|
2628
|
+
|
|
2629
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
2630
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompositionsApi.list_composition_entry_items, must be greater than or equal to 1.'
|
|
2631
|
+
end
|
|
2632
|
+
|
|
2633
|
+
allowable_values = ["asc", "desc"]
|
|
2634
|
+
if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
|
|
2635
|
+
fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
|
|
2636
|
+
end
|
|
2637
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2638
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.list_composition_entry_items, the character length must be smaller than or equal to 255.'
|
|
2639
|
+
end
|
|
2640
|
+
|
|
2641
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2642
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.list_composition_entry_items, the character length must be great than or equal to 1.'
|
|
2643
|
+
end
|
|
2644
|
+
|
|
2645
|
+
# resource path
|
|
2646
|
+
local_var_path = '/compositions/{id}/entries/{table}/items'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'table' + '}', CGI.escape(table.to_s))
|
|
2647
|
+
|
|
2648
|
+
# query parameters
|
|
2649
|
+
query_params = opts[:query_params] || {}
|
|
2650
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
2651
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
2652
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
2653
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
2654
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
2655
|
+
query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
|
|
2656
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
2657
|
+
|
|
2658
|
+
# header parameters
|
|
2659
|
+
header_params = opts[:header_params] || {}
|
|
2660
|
+
# HTTP header 'Accept' (if needed)
|
|
2661
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2662
|
+
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
2663
|
+
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
2664
|
+
|
|
2665
|
+
# form parameters
|
|
2666
|
+
form_params = opts[:form_params] || {}
|
|
2667
|
+
|
|
2668
|
+
# http body (model)
|
|
2669
|
+
post_body = opts[:debug_body]
|
|
2670
|
+
|
|
2671
|
+
# return_type
|
|
2672
|
+
return_type = opts[:debug_return_type] || 'CompositionEntryItemsPageSuccess'
|
|
2673
|
+
|
|
2674
|
+
# auth_names
|
|
2675
|
+
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2676
|
+
|
|
2677
|
+
new_options = opts.merge(
|
|
2678
|
+
:operation => :"CompositionsApi.list_composition_entry_items",
|
|
2679
|
+
:header_params => header_params,
|
|
2680
|
+
:query_params => query_params,
|
|
2681
|
+
:form_params => form_params,
|
|
2682
|
+
:body => post_body,
|
|
2683
|
+
:auth_names => auth_names,
|
|
2684
|
+
:return_type => return_type
|
|
2685
|
+
)
|
|
2686
|
+
|
|
2687
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2688
|
+
if @api_client.config.debugging
|
|
2689
|
+
@api_client.config.logger.debug "API called: CompositionsApi#list_composition_entry_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2265
2690
|
end
|
|
2266
2691
|
return data, status_code, headers
|
|
2267
2692
|
end
|
|
@@ -2274,11 +2699,11 @@ module ApiSdkRb
|
|
|
2274
2699
|
# @param request_body [Hash<String, Object>]
|
|
2275
2700
|
# @param [Hash] opts the optional parameters
|
|
2276
2701
|
# @option opts [String] :if_match
|
|
2277
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2278
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2279
|
-
# @return [
|
|
2280
|
-
def
|
|
2281
|
-
data, _status_code, _headers =
|
|
2702
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2703
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2704
|
+
# @return [ContentItemWriteResultResponse]
|
|
2705
|
+
def patch_composition_content_item(id, list, item_id, idempotency_key, request_body, opts = {})
|
|
2706
|
+
data, _status_code, _headers = patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts)
|
|
2282
2707
|
data
|
|
2283
2708
|
end
|
|
2284
2709
|
|
|
@@ -2290,52 +2715,52 @@ module ApiSdkRb
|
|
|
2290
2715
|
# @param request_body [Hash<String, Object>]
|
|
2291
2716
|
# @param [Hash] opts the optional parameters
|
|
2292
2717
|
# @option opts [String] :if_match
|
|
2293
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2294
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2295
|
-
# @return [Array<(
|
|
2296
|
-
def
|
|
2718
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2719
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2720
|
+
# @return [Array<(ContentItemWriteResultResponse, Integer, Hash)>] ContentItemWriteResultResponse data, response status code and response headers
|
|
2721
|
+
def patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts = {})
|
|
2297
2722
|
if @api_client.config.debugging
|
|
2298
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2723
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.patch_composition_content_item ...'
|
|
2299
2724
|
end
|
|
2300
2725
|
# verify the required parameter 'id' is set
|
|
2301
2726
|
if @api_client.config.client_side_validation && id.nil?
|
|
2302
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2727
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.patch_composition_content_item"
|
|
2303
2728
|
end
|
|
2304
2729
|
# verify the required parameter 'list' is set
|
|
2305
2730
|
if @api_client.config.client_side_validation && list.nil?
|
|
2306
|
-
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.
|
|
2731
|
+
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.patch_composition_content_item"
|
|
2307
2732
|
end
|
|
2308
2733
|
# verify the required parameter 'item_id' is set
|
|
2309
2734
|
if @api_client.config.client_side_validation && item_id.nil?
|
|
2310
|
-
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.
|
|
2735
|
+
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.patch_composition_content_item"
|
|
2311
2736
|
end
|
|
2312
2737
|
# verify the required parameter 'idempotency_key' is set
|
|
2313
2738
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2314
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
2739
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.patch_composition_content_item"
|
|
2315
2740
|
end
|
|
2316
2741
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2317
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
2742
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.patch_composition_content_item, the character length must be smaller than or equal to 50.'
|
|
2318
2743
|
end
|
|
2319
2744
|
|
|
2320
2745
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2321
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
2746
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.patch_composition_content_item, the character length must be great than or equal to 8.'
|
|
2322
2747
|
end
|
|
2323
2748
|
|
|
2324
2749
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2325
2750
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2326
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
2751
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.patch_composition_content_item, must conform to the pattern #{pattern}."
|
|
2327
2752
|
end
|
|
2328
2753
|
|
|
2329
2754
|
# verify the required parameter 'request_body' is set
|
|
2330
2755
|
if @api_client.config.client_side_validation && request_body.nil?
|
|
2331
|
-
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.
|
|
2756
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.patch_composition_content_item"
|
|
2332
2757
|
end
|
|
2333
2758
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2334
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2759
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.patch_composition_content_item, the character length must be smaller than or equal to 255.'
|
|
2335
2760
|
end
|
|
2336
2761
|
|
|
2337
2762
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2338
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2763
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.patch_composition_content_item, the character length must be great than or equal to 1.'
|
|
2339
2764
|
end
|
|
2340
2765
|
|
|
2341
2766
|
# resource path
|
|
@@ -2365,13 +2790,13 @@ module ApiSdkRb
|
|
|
2365
2790
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
|
2366
2791
|
|
|
2367
2792
|
# return_type
|
|
2368
|
-
return_type = opts[:debug_return_type] || '
|
|
2793
|
+
return_type = opts[:debug_return_type] || 'ContentItemWriteResultResponse'
|
|
2369
2794
|
|
|
2370
2795
|
# auth_names
|
|
2371
2796
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2372
2797
|
|
|
2373
2798
|
new_options = opts.merge(
|
|
2374
|
-
:operation => :"CompositionsApi.
|
|
2799
|
+
:operation => :"CompositionsApi.patch_composition_content_item",
|
|
2375
2800
|
:header_params => header_params,
|
|
2376
2801
|
:query_params => query_params,
|
|
2377
2802
|
:form_params => form_params,
|
|
@@ -2382,7 +2807,7 @@ module ApiSdkRb
|
|
|
2382
2807
|
|
|
2383
2808
|
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
2384
2809
|
if @api_client.config.debugging
|
|
2385
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2810
|
+
@api_client.config.logger.debug "API called: CompositionsApi#patch_composition_content_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2386
2811
|
end
|
|
2387
2812
|
return data, status_code, headers
|
|
2388
2813
|
end
|
|
@@ -2400,11 +2825,11 @@ module ApiSdkRb
|
|
|
2400
2825
|
# @option opts [Time] :_until 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`).
|
|
2401
2826
|
# @option opts [Hash<String, String>] :context 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.
|
|
2402
2827
|
# @option opts [Hash<String, String>] :filter 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`.
|
|
2403
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2404
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2828
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2829
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2405
2830
|
# @return [CompositionEntriesReadingResponse]
|
|
2406
|
-
def
|
|
2407
|
-
data, _status_code, _headers =
|
|
2831
|
+
def read_composition_entries(id, table, opts = {})
|
|
2832
|
+
data, _status_code, _headers = read_composition_entries_with_http_info(id, table, opts)
|
|
2408
2833
|
data
|
|
2409
2834
|
end
|
|
2410
2835
|
|
|
@@ -2421,51 +2846,51 @@ module ApiSdkRb
|
|
|
2421
2846
|
# @option opts [Time] :_until 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`).
|
|
2422
2847
|
# @option opts [Hash<String, String>] :context 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.
|
|
2423
2848
|
# @option opts [Hash<String, String>] :filter 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`.
|
|
2424
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2425
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2849
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2850
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2426
2851
|
# @return [Array<(CompositionEntriesReadingResponse, Integer, Hash)>] CompositionEntriesReadingResponse data, response status code and response headers
|
|
2427
|
-
def
|
|
2852
|
+
def read_composition_entries_with_http_info(id, table, opts = {})
|
|
2428
2853
|
if @api_client.config.debugging
|
|
2429
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2854
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.read_composition_entries ...'
|
|
2430
2855
|
end
|
|
2431
2856
|
# verify the required parameter 'id' is set
|
|
2432
2857
|
if @api_client.config.client_side_validation && id.nil?
|
|
2433
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2858
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.read_composition_entries"
|
|
2434
2859
|
end
|
|
2435
2860
|
# verify the required parameter 'table' is set
|
|
2436
2861
|
if @api_client.config.client_side_validation && table.nil?
|
|
2437
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
2862
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.read_composition_entries"
|
|
2438
2863
|
end
|
|
2439
2864
|
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
2440
|
-
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.
|
|
2865
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 63.'
|
|
2441
2866
|
end
|
|
2442
2867
|
|
|
2443
2868
|
if @api_client.config.client_side_validation && !opts[:'group_by'].nil? && opts[:'group_by'].to_s.length > 63
|
|
2444
|
-
fail ArgumentError, 'invalid value for "opts[:"group_by"]" when calling CompositionsApi.
|
|
2869
|
+
fail ArgumentError, 'invalid value for "opts[:"group_by"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 63.'
|
|
2445
2870
|
end
|
|
2446
2871
|
|
|
2447
2872
|
if @api_client.config.client_side_validation && !opts[:'rows'].nil? && opts[:'rows'] > 25
|
|
2448
|
-
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.
|
|
2873
|
+
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.read_composition_entries, must be smaller than or equal to 25.'
|
|
2449
2874
|
end
|
|
2450
2875
|
|
|
2451
2876
|
if @api_client.config.client_side_validation && !opts[:'rows'].nil? && opts[:'rows'] < 0
|
|
2452
|
-
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.
|
|
2877
|
+
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.read_composition_entries, must be greater than or equal to 0.'
|
|
2453
2878
|
end
|
|
2454
2879
|
|
|
2455
2880
|
if @api_client.config.client_side_validation && !opts[:'aggregate'].nil? && opts[:'aggregate'].to_s.length > 100
|
|
2456
|
-
fail ArgumentError, 'invalid value for "opts[:"aggregate"]" when calling CompositionsApi.
|
|
2881
|
+
fail ArgumentError, 'invalid value for "opts[:"aggregate"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 100.'
|
|
2457
2882
|
end
|
|
2458
2883
|
|
|
2459
2884
|
if @api_client.config.client_side_validation && !opts[:'column'].nil? && opts[:'column'].to_s.length > 63
|
|
2460
|
-
fail ArgumentError, 'invalid value for "opts[:"column"]" when calling CompositionsApi.
|
|
2885
|
+
fail ArgumentError, 'invalid value for "opts[:"column"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 63.'
|
|
2461
2886
|
end
|
|
2462
2887
|
|
|
2463
2888
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2464
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2889
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 255.'
|
|
2465
2890
|
end
|
|
2466
2891
|
|
|
2467
2892
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2468
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2893
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.read_composition_entries, the character length must be great than or equal to 1.'
|
|
2469
2894
|
end
|
|
2470
2895
|
|
|
2471
2896
|
# resource path
|
|
@@ -2502,7 +2927,7 @@ module ApiSdkRb
|
|
|
2502
2927
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2503
2928
|
|
|
2504
2929
|
new_options = opts.merge(
|
|
2505
|
-
:operation => :"CompositionsApi.
|
|
2930
|
+
:operation => :"CompositionsApi.read_composition_entries",
|
|
2506
2931
|
:header_params => header_params,
|
|
2507
2932
|
:query_params => query_params,
|
|
2508
2933
|
:form_params => form_params,
|
|
@@ -2513,7 +2938,7 @@ module ApiSdkRb
|
|
|
2513
2938
|
|
|
2514
2939
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2515
2940
|
if @api_client.config.debugging
|
|
2516
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2941
|
+
@api_client.config.logger.debug "API called: CompositionsApi#read_composition_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2517
2942
|
end
|
|
2518
2943
|
return data, status_code, headers
|
|
2519
2944
|
end
|
|
@@ -2523,11 +2948,11 @@ module ApiSdkRb
|
|
|
2523
2948
|
# @param id [String] The widget (composition) the document is in
|
|
2524
2949
|
# @param document_id [String] The document to remove
|
|
2525
2950
|
# @param [Hash] opts the optional parameters
|
|
2526
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2527
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2951
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2952
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2528
2953
|
# @return [RemoveAiAnswersKnowledgeDocument200Response]
|
|
2529
|
-
def
|
|
2530
|
-
data, _status_code, _headers =
|
|
2954
|
+
def remove_ai_answers_knowledge_document(id, document_id, opts = {})
|
|
2955
|
+
data, _status_code, _headers = remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts)
|
|
2531
2956
|
data
|
|
2532
2957
|
end
|
|
2533
2958
|
|
|
@@ -2536,27 +2961,27 @@ module ApiSdkRb
|
|
|
2536
2961
|
# @param id [String] The widget (composition) the document is in
|
|
2537
2962
|
# @param document_id [String] The document to remove
|
|
2538
2963
|
# @param [Hash] opts the optional parameters
|
|
2539
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2540
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2964
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2965
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2541
2966
|
# @return [Array<(RemoveAiAnswersKnowledgeDocument200Response, Integer, Hash)>] RemoveAiAnswersKnowledgeDocument200Response data, response status code and response headers
|
|
2542
|
-
def
|
|
2967
|
+
def remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts = {})
|
|
2543
2968
|
if @api_client.config.debugging
|
|
2544
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2969
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.remove_ai_answers_knowledge_document ...'
|
|
2545
2970
|
end
|
|
2546
2971
|
# verify the required parameter 'id' is set
|
|
2547
2972
|
if @api_client.config.client_side_validation && id.nil?
|
|
2548
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2973
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.remove_ai_answers_knowledge_document"
|
|
2549
2974
|
end
|
|
2550
2975
|
# verify the required parameter 'document_id' is set
|
|
2551
2976
|
if @api_client.config.client_side_validation && document_id.nil?
|
|
2552
|
-
fail ArgumentError, "Missing the required parameter 'document_id' when calling CompositionsApi.
|
|
2977
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling CompositionsApi.remove_ai_answers_knowledge_document"
|
|
2553
2978
|
end
|
|
2554
2979
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2555
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2980
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.remove_ai_answers_knowledge_document, the character length must be smaller than or equal to 255.'
|
|
2556
2981
|
end
|
|
2557
2982
|
|
|
2558
2983
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2559
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2984
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.remove_ai_answers_knowledge_document, the character length must be great than or equal to 1.'
|
|
2560
2985
|
end
|
|
2561
2986
|
|
|
2562
2987
|
# resource path
|
|
@@ -2585,7 +3010,7 @@ module ApiSdkRb
|
|
|
2585
3010
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2586
3011
|
|
|
2587
3012
|
new_options = opts.merge(
|
|
2588
|
-
:operation => :"CompositionsApi.
|
|
3013
|
+
:operation => :"CompositionsApi.remove_ai_answers_knowledge_document",
|
|
2589
3014
|
:header_params => header_params,
|
|
2590
3015
|
:query_params => query_params,
|
|
2591
3016
|
:form_params => form_params,
|
|
@@ -2596,7 +3021,7 @@ module ApiSdkRb
|
|
|
2596
3021
|
|
|
2597
3022
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
2598
3023
|
if @api_client.config.debugging
|
|
2599
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3024
|
+
@api_client.config.logger.debug "API called: CompositionsApi#remove_ai_answers_knowledge_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2600
3025
|
end
|
|
2601
3026
|
return data, status_code, headers
|
|
2602
3027
|
end
|
|
@@ -2607,11 +3032,11 @@ module ApiSdkRb
|
|
|
2607
3032
|
# @param 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`).
|
|
2608
3033
|
# @param set_composition_data_source_request [SetCompositionDataSourceRequest]
|
|
2609
3034
|
# @param [Hash] opts the optional parameters
|
|
2610
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2611
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3035
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3036
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2612
3037
|
# @return [CompositionDataSourceResponse]
|
|
2613
|
-
def
|
|
2614
|
-
data, _status_code, _headers =
|
|
3038
|
+
def set_composition_data_source(id, idempotency_key, set_composition_data_source_request, opts = {})
|
|
3039
|
+
data, _status_code, _headers = set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2615
3040
|
data
|
|
2616
3041
|
end
|
|
2617
3042
|
|
|
@@ -2621,44 +3046,44 @@ module ApiSdkRb
|
|
|
2621
3046
|
# @param 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`).
|
|
2622
3047
|
# @param set_composition_data_source_request [SetCompositionDataSourceRequest]
|
|
2623
3048
|
# @param [Hash] opts the optional parameters
|
|
2624
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2625
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3049
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3050
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2626
3051
|
# @return [Array<(CompositionDataSourceResponse, Integer, Hash)>] CompositionDataSourceResponse data, response status code and response headers
|
|
2627
|
-
def
|
|
3052
|
+
def set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts = {})
|
|
2628
3053
|
if @api_client.config.debugging
|
|
2629
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3054
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.set_composition_data_source ...'
|
|
2630
3055
|
end
|
|
2631
3056
|
# verify the required parameter 'id' is set
|
|
2632
3057
|
if @api_client.config.client_side_validation && id.nil?
|
|
2633
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3058
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.set_composition_data_source"
|
|
2634
3059
|
end
|
|
2635
3060
|
# verify the required parameter 'idempotency_key' is set
|
|
2636
3061
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2637
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3062
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.set_composition_data_source"
|
|
2638
3063
|
end
|
|
2639
3064
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2640
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3065
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_composition_data_source, the character length must be smaller than or equal to 50.'
|
|
2641
3066
|
end
|
|
2642
3067
|
|
|
2643
3068
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2644
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3069
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_composition_data_source, the character length must be great than or equal to 8.'
|
|
2645
3070
|
end
|
|
2646
3071
|
|
|
2647
3072
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2648
3073
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2649
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3074
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.set_composition_data_source, must conform to the pattern #{pattern}."
|
|
2650
3075
|
end
|
|
2651
3076
|
|
|
2652
3077
|
# verify the required parameter 'set_composition_data_source_request' is set
|
|
2653
3078
|
if @api_client.config.client_side_validation && set_composition_data_source_request.nil?
|
|
2654
|
-
fail ArgumentError, "Missing the required parameter 'set_composition_data_source_request' when calling CompositionsApi.
|
|
3079
|
+
fail ArgumentError, "Missing the required parameter 'set_composition_data_source_request' when calling CompositionsApi.set_composition_data_source"
|
|
2655
3080
|
end
|
|
2656
3081
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2657
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3082
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_composition_data_source, the character length must be smaller than or equal to 255.'
|
|
2658
3083
|
end
|
|
2659
3084
|
|
|
2660
3085
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2661
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3086
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_composition_data_source, the character length must be great than or equal to 1.'
|
|
2662
3087
|
end
|
|
2663
3088
|
|
|
2664
3089
|
# resource path
|
|
@@ -2693,7 +3118,7 @@ module ApiSdkRb
|
|
|
2693
3118
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2694
3119
|
|
|
2695
3120
|
new_options = opts.merge(
|
|
2696
|
-
:operation => :"CompositionsApi.
|
|
3121
|
+
:operation => :"CompositionsApi.set_composition_data_source",
|
|
2697
3122
|
:header_params => header_params,
|
|
2698
3123
|
:query_params => query_params,
|
|
2699
3124
|
:form_params => form_params,
|
|
@@ -2704,7 +3129,7 @@ module ApiSdkRb
|
|
|
2704
3129
|
|
|
2705
3130
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2706
3131
|
if @api_client.config.debugging
|
|
2707
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3132
|
+
@api_client.config.logger.debug "API called: CompositionsApi#set_composition_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2708
3133
|
end
|
|
2709
3134
|
return data, status_code, headers
|
|
2710
3135
|
end
|
|
@@ -2716,11 +3141,11 @@ module ApiSdkRb
|
|
|
2716
3141
|
# @param set_dynamic_content_request [SetDynamicContentRequest]
|
|
2717
3142
|
# @param [Hash] opts the optional parameters
|
|
2718
3143
|
# @option opts [String] :if_match Optional content version from ETag (`\"3\"`, `3`, or `*`)
|
|
2719
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2720
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3144
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3145
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2721
3146
|
# @return [SetDynamicContentResponse]
|
|
2722
|
-
def
|
|
2723
|
-
data, _status_code, _headers =
|
|
3147
|
+
def set_dynamic_content(id, idempotency_key, set_dynamic_content_request, opts = {})
|
|
3148
|
+
data, _status_code, _headers = set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2724
3149
|
data
|
|
2725
3150
|
end
|
|
2726
3151
|
|
|
@@ -2731,44 +3156,44 @@ module ApiSdkRb
|
|
|
2731
3156
|
# @param set_dynamic_content_request [SetDynamicContentRequest]
|
|
2732
3157
|
# @param [Hash] opts the optional parameters
|
|
2733
3158
|
# @option opts [String] :if_match Optional content version from ETag (`\"3\"`, `3`, or `*`)
|
|
2734
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2735
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3159
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3160
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2736
3161
|
# @return [Array<(SetDynamicContentResponse, Integer, Hash)>] SetDynamicContentResponse data, response status code and response headers
|
|
2737
|
-
def
|
|
3162
|
+
def set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts = {})
|
|
2738
3163
|
if @api_client.config.debugging
|
|
2739
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3164
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.set_dynamic_content ...'
|
|
2740
3165
|
end
|
|
2741
3166
|
# verify the required parameter 'id' is set
|
|
2742
3167
|
if @api_client.config.client_side_validation && id.nil?
|
|
2743
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3168
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.set_dynamic_content"
|
|
2744
3169
|
end
|
|
2745
3170
|
# verify the required parameter 'idempotency_key' is set
|
|
2746
3171
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2747
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3172
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.set_dynamic_content"
|
|
2748
3173
|
end
|
|
2749
3174
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2750
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3175
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_dynamic_content, the character length must be smaller than or equal to 50.'
|
|
2751
3176
|
end
|
|
2752
3177
|
|
|
2753
3178
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2754
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3179
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_dynamic_content, the character length must be great than or equal to 8.'
|
|
2755
3180
|
end
|
|
2756
3181
|
|
|
2757
3182
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2758
3183
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2759
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3184
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.set_dynamic_content, must conform to the pattern #{pattern}."
|
|
2760
3185
|
end
|
|
2761
3186
|
|
|
2762
3187
|
# verify the required parameter 'set_dynamic_content_request' is set
|
|
2763
3188
|
if @api_client.config.client_side_validation && set_dynamic_content_request.nil?
|
|
2764
|
-
fail ArgumentError, "Missing the required parameter 'set_dynamic_content_request' when calling CompositionsApi.
|
|
3189
|
+
fail ArgumentError, "Missing the required parameter 'set_dynamic_content_request' when calling CompositionsApi.set_dynamic_content"
|
|
2765
3190
|
end
|
|
2766
3191
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2767
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3192
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_dynamic_content, the character length must be smaller than or equal to 255.'
|
|
2768
3193
|
end
|
|
2769
3194
|
|
|
2770
3195
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2771
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3196
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_dynamic_content, the character length must be great than or equal to 1.'
|
|
2772
3197
|
end
|
|
2773
3198
|
|
|
2774
3199
|
# resource path
|
|
@@ -2804,7 +3229,7 @@ module ApiSdkRb
|
|
|
2804
3229
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2805
3230
|
|
|
2806
3231
|
new_options = opts.merge(
|
|
2807
|
-
:operation => :"CompositionsApi.
|
|
3232
|
+
:operation => :"CompositionsApi.set_dynamic_content",
|
|
2808
3233
|
:header_params => header_params,
|
|
2809
3234
|
:query_params => query_params,
|
|
2810
3235
|
:form_params => form_params,
|
|
@@ -2815,69 +3240,71 @@ module ApiSdkRb
|
|
|
2815
3240
|
|
|
2816
3241
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2817
3242
|
if @api_client.config.debugging
|
|
2818
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3243
|
+
@api_client.config.logger.debug "API called: CompositionsApi#set_dynamic_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2819
3244
|
end
|
|
2820
3245
|
return data, status_code, headers
|
|
2821
3246
|
end
|
|
2822
3247
|
|
|
2823
3248
|
# Update Composition
|
|
2824
|
-
# 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.
|
|
3249
|
+
# 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.
|
|
2825
3250
|
# @param id [String] Composition ID
|
|
2826
3251
|
# @param 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`).
|
|
2827
3252
|
# @param update_composition [UpdateComposition]
|
|
2828
3253
|
# @param [Hash] opts the optional parameters
|
|
2829
|
-
# @option opts [String] :
|
|
2830
|
-
# @option opts [String] :
|
|
2831
|
-
# @
|
|
2832
|
-
|
|
2833
|
-
|
|
3254
|
+
# @option opts [String] :if_match Optional content version from `contentVersion` or an `ETag` (`\"3\"`, `3`, or `*`). Read only when the body has `content`.
|
|
3255
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3256
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3257
|
+
# @return [CompositionResponse]
|
|
3258
|
+
def update_composition(id, idempotency_key, update_composition, opts = {})
|
|
3259
|
+
data, _status_code, _headers = update_composition_with_http_info(id, idempotency_key, update_composition, opts)
|
|
2834
3260
|
data
|
|
2835
3261
|
end
|
|
2836
3262
|
|
|
2837
3263
|
# Update Composition
|
|
2838
|
-
# 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.
|
|
3264
|
+
# 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.
|
|
2839
3265
|
# @param id [String] Composition ID
|
|
2840
3266
|
# @param 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`).
|
|
2841
3267
|
# @param update_composition [UpdateComposition]
|
|
2842
3268
|
# @param [Hash] opts the optional parameters
|
|
2843
|
-
# @option opts [String] :
|
|
2844
|
-
# @option opts [String] :
|
|
2845
|
-
# @
|
|
2846
|
-
|
|
3269
|
+
# @option opts [String] :if_match Optional content version from `contentVersion` or an `ETag` (`\"3\"`, `3`, or `*`). Read only when the body has `content`.
|
|
3270
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3271
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3272
|
+
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
3273
|
+
def update_composition_with_http_info(id, idempotency_key, update_composition, opts = {})
|
|
2847
3274
|
if @api_client.config.debugging
|
|
2848
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3275
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.update_composition ...'
|
|
2849
3276
|
end
|
|
2850
3277
|
# verify the required parameter 'id' is set
|
|
2851
3278
|
if @api_client.config.client_side_validation && id.nil?
|
|
2852
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3279
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.update_composition"
|
|
2853
3280
|
end
|
|
2854
3281
|
# verify the required parameter 'idempotency_key' is set
|
|
2855
3282
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2856
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3283
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.update_composition"
|
|
2857
3284
|
end
|
|
2858
3285
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2859
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3286
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition, the character length must be smaller than or equal to 50.'
|
|
2860
3287
|
end
|
|
2861
3288
|
|
|
2862
3289
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2863
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3290
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition, the character length must be great than or equal to 8.'
|
|
2864
3291
|
end
|
|
2865
3292
|
|
|
2866
3293
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2867
3294
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2868
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3295
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.update_composition, must conform to the pattern #{pattern}."
|
|
2869
3296
|
end
|
|
2870
3297
|
|
|
2871
3298
|
# verify the required parameter 'update_composition' is set
|
|
2872
3299
|
if @api_client.config.client_side_validation && update_composition.nil?
|
|
2873
|
-
fail ArgumentError, "Missing the required parameter 'update_composition' when calling CompositionsApi.
|
|
3300
|
+
fail ArgumentError, "Missing the required parameter 'update_composition' when calling CompositionsApi.update_composition"
|
|
2874
3301
|
end
|
|
2875
3302
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2876
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3303
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition, the character length must be smaller than or equal to 255.'
|
|
2877
3304
|
end
|
|
2878
3305
|
|
|
2879
3306
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2880
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3307
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition, the character length must be great than or equal to 1.'
|
|
2881
3308
|
end
|
|
2882
3309
|
|
|
2883
3310
|
# resource path
|
|
@@ -2896,6 +3323,7 @@ module ApiSdkRb
|
|
|
2896
3323
|
header_params['Content-Type'] = content_type
|
|
2897
3324
|
end
|
|
2898
3325
|
header_params[:'Idempotency-Key'] = idempotency_key
|
|
3326
|
+
header_params[:'If-Match'] = opts[:'if_match'] if !opts[:'if_match'].nil?
|
|
2899
3327
|
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
2900
3328
|
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
2901
3329
|
|
|
@@ -2906,13 +3334,13 @@ module ApiSdkRb
|
|
|
2906
3334
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_composition)
|
|
2907
3335
|
|
|
2908
3336
|
# return_type
|
|
2909
|
-
return_type = opts[:debug_return_type] || '
|
|
3337
|
+
return_type = opts[:debug_return_type] || 'CompositionResponse'
|
|
2910
3338
|
|
|
2911
3339
|
# auth_names
|
|
2912
3340
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2913
3341
|
|
|
2914
3342
|
new_options = opts.merge(
|
|
2915
|
-
:operation => :"CompositionsApi.
|
|
3343
|
+
:operation => :"CompositionsApi.update_composition",
|
|
2916
3344
|
:header_params => header_params,
|
|
2917
3345
|
:query_params => query_params,
|
|
2918
3346
|
:form_params => form_params,
|
|
@@ -2923,7 +3351,7 @@ module ApiSdkRb
|
|
|
2923
3351
|
|
|
2924
3352
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2925
3353
|
if @api_client.config.debugging
|
|
2926
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3354
|
+
@api_client.config.logger.debug "API called: CompositionsApi#update_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2927
3355
|
end
|
|
2928
3356
|
return data, status_code, headers
|
|
2929
3357
|
end
|
|
@@ -2936,11 +3364,11 @@ module ApiSdkRb
|
|
|
2936
3364
|
# @param 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`).
|
|
2937
3365
|
# @param body [Object]
|
|
2938
3366
|
# @param [Hash] opts the optional parameters
|
|
2939
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2940
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2941
|
-
# @return [
|
|
2942
|
-
def
|
|
2943
|
-
data, _status_code, _headers =
|
|
3367
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3368
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3369
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
3370
|
+
def update_composition_database_record(id, table, record_id, idempotency_key, body, opts = {})
|
|
3371
|
+
data, _status_code, _headers = update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts)
|
|
2944
3372
|
data
|
|
2945
3373
|
end
|
|
2946
3374
|
|
|
@@ -2952,52 +3380,52 @@ module ApiSdkRb
|
|
|
2952
3380
|
# @param 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`).
|
|
2953
3381
|
# @param body [Object]
|
|
2954
3382
|
# @param [Hash] opts the optional parameters
|
|
2955
|
-
# @option opts [String] :x_managed_user_id 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
|
|
2956
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
2957
|
-
# @return [Array<(
|
|
2958
|
-
def
|
|
3383
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3384
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3385
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
3386
|
+
def update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts = {})
|
|
2959
3387
|
if @api_client.config.debugging
|
|
2960
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3388
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.update_composition_database_record ...'
|
|
2961
3389
|
end
|
|
2962
3390
|
# verify the required parameter 'id' is set
|
|
2963
3391
|
if @api_client.config.client_side_validation && id.nil?
|
|
2964
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3392
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.update_composition_database_record"
|
|
2965
3393
|
end
|
|
2966
3394
|
# verify the required parameter 'table' is set
|
|
2967
3395
|
if @api_client.config.client_side_validation && table.nil?
|
|
2968
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
3396
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.update_composition_database_record"
|
|
2969
3397
|
end
|
|
2970
3398
|
# verify the required parameter 'record_id' is set
|
|
2971
3399
|
if @api_client.config.client_side_validation && record_id.nil?
|
|
2972
|
-
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.
|
|
3400
|
+
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.update_composition_database_record"
|
|
2973
3401
|
end
|
|
2974
3402
|
# verify the required parameter 'idempotency_key' is set
|
|
2975
3403
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2976
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3404
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.update_composition_database_record"
|
|
2977
3405
|
end
|
|
2978
3406
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2979
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3407
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_database_record, the character length must be smaller than or equal to 50.'
|
|
2980
3408
|
end
|
|
2981
3409
|
|
|
2982
3410
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2983
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3411
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_database_record, the character length must be great than or equal to 8.'
|
|
2984
3412
|
end
|
|
2985
3413
|
|
|
2986
3414
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2987
3415
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2988
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3416
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.update_composition_database_record, must conform to the pattern #{pattern}."
|
|
2989
3417
|
end
|
|
2990
3418
|
|
|
2991
3419
|
# verify the required parameter 'body' is set
|
|
2992
3420
|
if @api_client.config.client_side_validation && body.nil?
|
|
2993
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.
|
|
3421
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.update_composition_database_record"
|
|
2994
3422
|
end
|
|
2995
3423
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2996
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3424
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
2997
3425
|
end
|
|
2998
3426
|
|
|
2999
3427
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
3000
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3428
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_database_record, the character length must be great than or equal to 1.'
|
|
3001
3429
|
end
|
|
3002
3430
|
|
|
3003
3431
|
# resource path
|
|
@@ -3026,13 +3454,13 @@ module ApiSdkRb
|
|
|
3026
3454
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
|
3027
3455
|
|
|
3028
3456
|
# return_type
|
|
3029
|
-
return_type = opts[:debug_return_type] || '
|
|
3457
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
3030
3458
|
|
|
3031
3459
|
# auth_names
|
|
3032
3460
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
3033
3461
|
|
|
3034
3462
|
new_options = opts.merge(
|
|
3035
|
-
:operation => :"CompositionsApi.
|
|
3463
|
+
:operation => :"CompositionsApi.update_composition_database_record",
|
|
3036
3464
|
:header_params => header_params,
|
|
3037
3465
|
:query_params => query_params,
|
|
3038
3466
|
:form_params => form_params,
|
|
@@ -3043,7 +3471,7 @@ module ApiSdkRb
|
|
|
3043
3471
|
|
|
3044
3472
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
3045
3473
|
if @api_client.config.debugging
|
|
3046
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3474
|
+
@api_client.config.logger.debug "API called: CompositionsApi#update_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3047
3475
|
end
|
|
3048
3476
|
return data, status_code, headers
|
|
3049
3477
|
end
|
|
@@ -3054,11 +3482,11 @@ module ApiSdkRb
|
|
|
3054
3482
|
# @param 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`).
|
|
3055
3483
|
# @param update_composition_status_request [UpdateCompositionStatusRequest]
|
|
3056
3484
|
# @param [Hash] opts the optional parameters
|
|
3057
|
-
# @option opts [String] :x_managed_user_id 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
|
|
3058
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3485
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3486
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3059
3487
|
# @return [CompositionResponse]
|
|
3060
|
-
def
|
|
3061
|
-
data, _status_code, _headers =
|
|
3488
|
+
def update_composition_status(id, idempotency_key, update_composition_status_request, opts = {})
|
|
3489
|
+
data, _status_code, _headers = update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts)
|
|
3062
3490
|
data
|
|
3063
3491
|
end
|
|
3064
3492
|
|
|
@@ -3068,44 +3496,44 @@ module ApiSdkRb
|
|
|
3068
3496
|
# @param 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`).
|
|
3069
3497
|
# @param update_composition_status_request [UpdateCompositionStatusRequest]
|
|
3070
3498
|
# @param [Hash] opts the optional parameters
|
|
3071
|
-
# @option opts [String] :x_managed_user_id 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
|
|
3072
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3499
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3500
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3073
3501
|
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
3074
|
-
def
|
|
3502
|
+
def update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts = {})
|
|
3075
3503
|
if @api_client.config.debugging
|
|
3076
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3504
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.update_composition_status ...'
|
|
3077
3505
|
end
|
|
3078
3506
|
# verify the required parameter 'id' is set
|
|
3079
3507
|
if @api_client.config.client_side_validation && id.nil?
|
|
3080
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3508
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.update_composition_status"
|
|
3081
3509
|
end
|
|
3082
3510
|
# verify the required parameter 'idempotency_key' is set
|
|
3083
3511
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
3084
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3512
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.update_composition_status"
|
|
3085
3513
|
end
|
|
3086
3514
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
3087
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3515
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_status, the character length must be smaller than or equal to 50.'
|
|
3088
3516
|
end
|
|
3089
3517
|
|
|
3090
3518
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
3091
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3519
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_status, the character length must be great than or equal to 8.'
|
|
3092
3520
|
end
|
|
3093
3521
|
|
|
3094
3522
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
3095
3523
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
3096
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3524
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.update_composition_status, must conform to the pattern #{pattern}."
|
|
3097
3525
|
end
|
|
3098
3526
|
|
|
3099
3527
|
# verify the required parameter 'update_composition_status_request' is set
|
|
3100
3528
|
if @api_client.config.client_side_validation && update_composition_status_request.nil?
|
|
3101
|
-
fail ArgumentError, "Missing the required parameter 'update_composition_status_request' when calling CompositionsApi.
|
|
3529
|
+
fail ArgumentError, "Missing the required parameter 'update_composition_status_request' when calling CompositionsApi.update_composition_status"
|
|
3102
3530
|
end
|
|
3103
3531
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
3104
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3532
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_status, the character length must be smaller than or equal to 255.'
|
|
3105
3533
|
end
|
|
3106
3534
|
|
|
3107
3535
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
3108
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3536
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_status, the character length must be great than or equal to 1.'
|
|
3109
3537
|
end
|
|
3110
3538
|
|
|
3111
3539
|
# resource path
|
|
@@ -3140,7 +3568,7 @@ module ApiSdkRb
|
|
|
3140
3568
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
3141
3569
|
|
|
3142
3570
|
new_options = opts.merge(
|
|
3143
|
-
:operation => :"CompositionsApi.
|
|
3571
|
+
:operation => :"CompositionsApi.update_composition_status",
|
|
3144
3572
|
:header_params => header_params,
|
|
3145
3573
|
:query_params => query_params,
|
|
3146
3574
|
:form_params => form_params,
|
|
@@ -3151,7 +3579,7 @@ module ApiSdkRb
|
|
|
3151
3579
|
|
|
3152
3580
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
3153
3581
|
if @api_client.config.debugging
|
|
3154
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3582
|
+
@api_client.config.logger.debug "API called: CompositionsApi#update_composition_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3155
3583
|
end
|
|
3156
3584
|
return data, status_code, headers
|
|
3157
3585
|
end
|
|
@@ -3162,11 +3590,11 @@ module ApiSdkRb
|
|
|
3162
3590
|
# @param 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`).
|
|
3163
3591
|
# @param request_body [Hash<String, Object>]
|
|
3164
3592
|
# @param [Hash] opts the optional parameters
|
|
3165
|
-
# @option opts [String] :x_managed_user_id 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
|
|
3166
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3593
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3594
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3167
3595
|
# @return [ValidateCompositionContentResponse]
|
|
3168
|
-
def
|
|
3169
|
-
data, _status_code, _headers =
|
|
3596
|
+
def validate_composition_content(id, idempotency_key, request_body, opts = {})
|
|
3597
|
+
data, _status_code, _headers = validate_composition_content_with_http_info(id, idempotency_key, request_body, opts)
|
|
3170
3598
|
data
|
|
3171
3599
|
end
|
|
3172
3600
|
|
|
@@ -3176,44 +3604,44 @@ module ApiSdkRb
|
|
|
3176
3604
|
# @param 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`).
|
|
3177
3605
|
# @param request_body [Hash<String, Object>]
|
|
3178
3606
|
# @param [Hash] opts the optional parameters
|
|
3179
|
-
# @option opts [String] :x_managed_user_id 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
|
|
3180
|
-
# @option opts [String] :x_managed_user_external_id 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
|
|
3607
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
3608
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
3181
3609
|
# @return [Array<(ValidateCompositionContentResponse, Integer, Hash)>] ValidateCompositionContentResponse data, response status code and response headers
|
|
3182
|
-
def
|
|
3610
|
+
def validate_composition_content_with_http_info(id, idempotency_key, request_body, opts = {})
|
|
3183
3611
|
if @api_client.config.debugging
|
|
3184
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3612
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.validate_composition_content ...'
|
|
3185
3613
|
end
|
|
3186
3614
|
# verify the required parameter 'id' is set
|
|
3187
3615
|
if @api_client.config.client_side_validation && id.nil?
|
|
3188
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3616
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.validate_composition_content"
|
|
3189
3617
|
end
|
|
3190
3618
|
# verify the required parameter 'idempotency_key' is set
|
|
3191
3619
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
3192
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3620
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.validate_composition_content"
|
|
3193
3621
|
end
|
|
3194
3622
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
3195
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3623
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.validate_composition_content, the character length must be smaller than or equal to 50.'
|
|
3196
3624
|
end
|
|
3197
3625
|
|
|
3198
3626
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
3199
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3627
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.validate_composition_content, the character length must be great than or equal to 8.'
|
|
3200
3628
|
end
|
|
3201
3629
|
|
|
3202
3630
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
3203
3631
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
3204
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3632
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.validate_composition_content, must conform to the pattern #{pattern}."
|
|
3205
3633
|
end
|
|
3206
3634
|
|
|
3207
3635
|
# verify the required parameter 'request_body' is set
|
|
3208
3636
|
if @api_client.config.client_side_validation && request_body.nil?
|
|
3209
|
-
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.
|
|
3637
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.validate_composition_content"
|
|
3210
3638
|
end
|
|
3211
3639
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
3212
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3640
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.validate_composition_content, the character length must be smaller than or equal to 255.'
|
|
3213
3641
|
end
|
|
3214
3642
|
|
|
3215
3643
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
3216
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3644
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.validate_composition_content, the character length must be great than or equal to 1.'
|
|
3217
3645
|
end
|
|
3218
3646
|
|
|
3219
3647
|
# resource path
|
|
@@ -3248,7 +3676,7 @@ module ApiSdkRb
|
|
|
3248
3676
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
3249
3677
|
|
|
3250
3678
|
new_options = opts.merge(
|
|
3251
|
-
:operation => :"CompositionsApi.
|
|
3679
|
+
:operation => :"CompositionsApi.validate_composition_content",
|
|
3252
3680
|
:header_params => header_params,
|
|
3253
3681
|
:query_params => query_params,
|
|
3254
3682
|
:form_params => form_params,
|
|
@@ -3259,7 +3687,7 @@ module ApiSdkRb
|
|
|
3259
3687
|
|
|
3260
3688
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
3261
3689
|
if @api_client.config.debugging
|
|
3262
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3690
|
+
@api_client.config.logger.debug "API called: CompositionsApi#validate_composition_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3263
3691
|
end
|
|
3264
3692
|
return data, status_code, headers
|
|
3265
3693
|
end
|