api-sdk-rb 1.11.66 → 1.11.133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +294 -285
- data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
- data/docs/AdapterConnection.md +7 -1
- data/docs/{GetUserAdapterConnections200Response.md → AdapterConnectionListResponse.md} +2 -2
- data/docs/{RemoveUserAdapterConnection200Response.md → AdapterConnectionRemovalResponse.md} +2 -2
- data/docs/{SetUserAdapterConnection200Response.md → AdapterConnectionResponse.md} +2 -2
- data/docs/{AddAiAnswersKnowledgeDocument201Response.md → AiAnswersKnowledgeDocumentResponse.md} +2 -2
- data/docs/BrandColor.md +22 -0
- data/docs/BrandFont.md +24 -0
- data/docs/BrandKitApi.md +593 -0
- data/docs/BrandKitAssetView.md +42 -0
- data/docs/BrandKitFigmaSource.md +26 -0
- data/docs/BrandKitTokens.md +26 -0
- data/docs/BrandKitTokensFonts.md +24 -0
- data/docs/BrandKitView.md +36 -0
- data/docs/BrandKitViewOwner.md +20 -0
- data/docs/{OperationsIdGetResponse.md → BrandKitViewResponse.md} +3 -3
- data/docs/BrandSpacing.md +32 -0
- data/docs/BrandTextStyle.md +22 -0
- data/docs/CanvasesApi.md +45 -45
- data/docs/Composition.md +5 -1
- data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
- data/docs/CompositionLastEditedBy.md +20 -0
- data/docs/CompositionsApi.md +821 -473
- data/docs/ConfirmAdapterConnectionRequest.md +18 -0
- data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
- data/docs/CreateWidget201ResponseData.md +2 -4
- data/docs/CreateWorkspaceWorkflowFromPresetRequest.md +20 -0
- data/docs/CreateWorkspaceWorkflowRequest.md +22 -0
- data/docs/CreditsApi.md +20 -20
- data/docs/DeleteUpload200Response.md +22 -0
- data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
- data/docs/DeleteWorkspaceWorkflow200Response.md +22 -0
- data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
- data/docs/EntitlementsApi.md +18 -18
- data/docs/GetOperationResponse.md +22 -0
- data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
- data/docs/GetOperationResponseDataMetadata.md +24 -0
- data/docs/GetPublicCompositionEmbed200Response.md +7 -1
- data/docs/GetPublicCompositionEmbed200ResponseAdapters.md +20 -0
- data/docs/GetPublicCompositionEmbed200ResponseAdaptersCaptcha.md +18 -0
- data/docs/GetPublicCompositionEmbed200ResponseEntries.md +20 -0
- data/docs/GetPublicCompositionEmbed200ResponseMedia.md +18 -0
- data/docs/GetWorkspaceWorkflowStats200Response.md +22 -0
- data/docs/GetWorkspaceWorkflowVersion200Response.md +22 -0
- data/docs/InvoicesApi.md +9 -9
- data/docs/ListPartnerWorkflowPresets200Response.md +22 -0
- data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
- data/docs/ListWorkspaceWorkflowCompositionOptions200Response.md +22 -0
- data/docs/ListWorkspaceWorkflowPresets200Response.md +22 -0
- data/docs/ListWorkspaceWorkflowVersions200Response.md +22 -0
- data/docs/ListWorkspaceWorkflows200Response.md +22 -0
- data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
- data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
- data/docs/ManagedUsersApi.md +261 -171
- data/docs/NewComposition.md +1 -1
- data/docs/NewEditorSession.md +1 -1
- data/docs/OfferWorkflowPresetRequest.md +24 -0
- data/docs/OfferedWorkflowPreset.md +40 -0
- data/docs/OfferedWorkflowPresetList.md +18 -0
- data/docs/OfferedWorkflowPresetWidget.md +22 -0
- data/docs/OperationsApi.md +11 -11
- data/docs/PartnerCustomization.md +2 -2
- data/docs/PartnerNotification.md +1 -1
- data/docs/PartnersApi.md +644 -352
- data/docs/PatchBrandKitAssetRequest.md +24 -0
- data/docs/PatchBrandKitRequest.md +30 -0
- data/docs/PatchBrandKitRequestFonts.md +24 -0
- data/docs/PatchBrandKitRequestSpacing.md +32 -0
- data/docs/PostBrandKitIconRequest.md +20 -0
- data/docs/PublicEmbedApi.md +324 -58
- data/docs/PublicWorkflow.md +36 -0
- data/docs/PublicWorkflowEventsAccepted.md +22 -0
- data/docs/PublicWorkflowEventsRequest.md +24 -0
- data/docs/PublicWorkflowEventsRequestEventsInner.md +24 -0
- data/docs/PublicWorkflowEventsRequestHeightsInner.md +20 -0
- data/docs/{CreateCompositionFromWidget201Response.md → PublicWorkflowResponse.md} +3 -3
- data/docs/PublicWorkflowTranslation.md +20 -0
- data/docs/PublishWorkspaceWorkflow200Response.md +22 -0
- data/docs/PublishWorkspaceWorkflowRequest.md +18 -0
- data/docs/PutBrandKitRequest.md +22 -0
- data/docs/RemovePartnerWorkflowPreset200Response.md +22 -0
- data/docs/ReportPublicWorkflowEvents200Response.md +22 -0
- data/docs/SaveWorkspaceWorkflowRequest.md +24 -0
- data/docs/SetAdapterConnectionRequest.md +1 -1
- data/docs/SetPartnerWorkflowPreset200Response.md +22 -0
- data/docs/TokensApi.md +11 -9
- data/docs/UpdateComposition.md +1 -1
- data/docs/Upload.md +1 -1
- data/docs/UploadLimits.md +3 -3
- data/docs/UploadsApi.md +85 -85
- data/docs/UsersApi.md +191 -115
- data/docs/Widget.md +2 -4
- data/docs/WidgetClarification.md +22 -0
- data/docs/WidgetClarificationOption.md +22 -0
- data/docs/WidgetClarificationQuestion.md +26 -0
- data/docs/WidgetNextStep.md +24 -0
- data/docs/WidgetPlan.md +26 -0
- data/docs/WidgetPlanDecisions.md +32 -0
- data/docs/WidgetPlanDecisionsAdaptersInner.md +20 -0
- data/docs/WidgetPlanDecisionsLibrariesInner.md +22 -0
- data/docs/WidgetPlanDecisionsResponsive.md +22 -0
- data/docs/WidgetPlanTask.md +24 -0
- data/docs/WidgetsApi.md +38 -38
- data/docs/Workflow.md +50 -0
- data/docs/WorkflowCompositionAction.md +24 -0
- data/docs/WorkflowCompositionField.md +24 -0
- data/docs/WorkflowCompositionOption.md +30 -0
- data/docs/WorkflowCompositionOptionActions.md +22 -0
- data/docs/WorkflowCompositionOptionInputs.md +24 -0
- data/docs/WorkflowCompositionOptions.md +24 -0
- data/docs/WorkflowConditionCase.md +24 -0
- data/docs/WorkflowConditionTest.md +22 -0
- data/docs/WorkflowCounter.md +20 -0
- data/docs/WorkflowDetail.md +60 -0
- data/docs/WorkflowDetailAllOfLastEditedBy.md +20 -0
- data/docs/WorkflowDetailResponse.md +22 -0
- data/docs/WorkflowEdge.md +24 -0
- data/docs/WorkflowFailureReason.md +15 -0
- data/docs/WorkflowFailureReasonCounter.md +22 -0
- data/docs/WorkflowFieldReference.md +22 -0
- data/docs/WorkflowGraph.md +22 -0
- data/docs/WorkflowIssue.md +28 -0
- data/docs/WorkflowList.md +24 -0
- data/docs/WorkflowNode.md +30 -0
- data/docs/WorkflowNodePosition.md +20 -0
- data/docs/WorkflowPresetChoice.md +26 -0
- data/docs/WorkflowPresetChoices.md +18 -0
- data/docs/WorkflowPresetRemoval.md +18 -0
- data/docs/WorkflowPresetWidget.md +20 -0
- data/docs/WorkflowPublishResult.md +22 -0
- data/docs/WorkflowRemoved.md +18 -0
- data/docs/WorkflowResponse.md +22 -0
- data/docs/WorkflowSchedule.md +24 -0
- data/docs/WorkflowStats.md +34 -0
- data/docs/WorkflowStatus.md +15 -0
- data/docs/WorkflowTrigger.md +28 -0
- data/docs/WorkflowTriggerValuesInner.md +20 -0
- data/docs/WorkflowVersion.md +28 -0
- data/docs/WorkflowVersionDetail.md +32 -0
- data/docs/WorkflowVersionList.md +18 -0
- data/docs/WorkflowVersionPublishedBy.md +20 -0
- data/docs/WorkflowsApi.md +1527 -0
- data/lib/api-sdk-rb/api/brand_kit_api.rb +581 -0
- data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
- data/lib/api-sdk-rb/api/compositions_api.rb +993 -565
- data/lib/api-sdk-rb/api/credits_api.rb +20 -20
- data/lib/api-sdk-rb/api/entitlements_api.rb +14 -14
- data/lib/api-sdk-rb/api/invoices_api.rb +10 -10
- data/lib/api-sdk-rb/api/managed_users_api.rb +278 -172
- data/lib/api-sdk-rb/api/operations_api.rb +10 -10
- data/lib/api-sdk-rb/api/partners_api.rb +668 -352
- data/lib/api-sdk-rb/api/public_embed_api.rb +339 -62
- data/lib/api-sdk-rb/api/tokens_api.rb +8 -6
- data/lib/api-sdk-rb/api/uploads_api.rb +96 -96
- data/lib/api-sdk-rb/api/users_api.rb +213 -119
- data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
- data/lib/api-sdk-rb/api/workflows_api.rb +1775 -0
- data/lib/api-sdk-rb/configuration.rb +11 -23
- data/lib/api-sdk-rb/models/{get_user_adapter_connections200_response.rb → account_credit_transaction_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/adapter_connection.rb +48 -5
- data/lib/api-sdk-rb/models/{get_partner_credit_transactions200_response.rb → adapter_connection_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/adapter_connection_removal_response.rb +246 -0
- data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → adapter_connection_response.rb} +4 -4
- data/lib/api-sdk-rb/models/ai_answers_knowledge_document_response.rb +246 -0
- data/lib/api-sdk-rb/models/brand_color.rb +329 -0
- data/lib/api-sdk-rb/models/brand_font.rb +357 -0
- data/lib/api-sdk-rb/models/brand_kit_asset_view.rb +409 -0
- data/lib/api-sdk-rb/models/brand_kit_figma_source.rb +277 -0
- data/lib/api-sdk-rb/models/brand_kit_tokens.rb +335 -0
- data/lib/api-sdk-rb/models/brand_kit_tokens_fonts.rb +241 -0
- data/lib/api-sdk-rb/models/brand_kit_view.rb +344 -0
- data/lib/api-sdk-rb/models/brand_kit_view_owner.rb +267 -0
- data/lib/api-sdk-rb/models/brand_kit_view_response.rb +247 -0
- data/lib/api-sdk-rb/models/brand_spacing.rb +557 -0
- data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
- data/lib/api-sdk-rb/models/composition.rb +26 -5
- data/lib/api-sdk-rb/models/{create_composition_database_record201_response.rb → composition_database_record_response.rb} +3 -3
- data/lib/api-sdk-rb/models/composition_last_edited_by.rb +242 -0
- data/lib/api-sdk-rb/models/confirm_adapter_connection_request.rb +241 -0
- data/lib/api-sdk-rb/models/content_item_write_result_response.rb +246 -0
- data/lib/api-sdk-rb/models/create_widget201_response_data.rb +9 -20
- data/lib/api-sdk-rb/models/create_workspace_workflow_from_preset_request.rb +278 -0
- data/lib/api-sdk-rb/models/create_workspace_workflow_request.rb +271 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response.rb → delete_upload200_response.rb} +4 -5
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response_data.rb → delete_upload200_response_data.rb} +3 -3
- data/lib/api-sdk-rb/models/delete_workspace_workflow200_response.rb +246 -0
- data/lib/api-sdk-rb/models/design_defaults_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_operation_response.rb +247 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response_data.rb → get_operation_response_data.rb} +5 -8
- data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb +283 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response.rb +29 -2
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_adapters.rb +225 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_adapters_captcha.rb +216 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_entries.rb +224 -0
- data/lib/api-sdk-rb/models/get_public_composition_embed200_response_media.rb +216 -0
- data/lib/api-sdk-rb/models/get_workspace_workflow_stats200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → get_workspace_workflow_version200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/list_partner_workflow_presets200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
- data/lib/api-sdk-rb/models/list_workspace_workflow_composition_options200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → list_workspace_workflow_presets200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → list_workspace_workflow_versions200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/list_workspace_workflows200_response.rb +246 -0
- data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/new_composition.rb +1 -1
- data/lib/api-sdk-rb/models/new_editor_session.rb +1 -1
- data/lib/api-sdk-rb/models/offer_workflow_preset_request.rb +322 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset.rb +423 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset_list.rb +223 -0
- data/lib/api-sdk-rb/models/offered_workflow_preset_widget.rb +251 -0
- data/lib/api-sdk-rb/models/partner_notification.rb +1 -1
- data/lib/api-sdk-rb/models/partner_notification_event_type.rb +5 -1
- data/lib/api-sdk-rb/models/patch_brand_kit_asset_request.rb +289 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +363 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request_fonts.rb +242 -0
- data/lib/api-sdk-rb/models/patch_brand_kit_request_spacing.rb +502 -0
- data/lib/api-sdk-rb/models/post_brand_kit_icon_request.rb +237 -0
- data/lib/api-sdk-rb/models/public_workflow.rb +351 -0
- data/lib/api-sdk-rb/models/public_workflow_events_accepted.rb +242 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request.rb +301 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +354 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_heights_inner.rb +267 -0
- data/lib/api-sdk-rb/models/public_workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/public_workflow_translation.rb +242 -0
- data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → publish_workspace_workflow200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/publish_workspace_workflow_request.rb +240 -0
- data/lib/api-sdk-rb/models/put_brand_kit_request.rb +239 -0
- data/lib/api-sdk-rb/models/{remove_user_adapter_connection200_response.rb → remove_partner_workflow_preset200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/report_public_workflow_events200_response.rb +246 -0
- data/lib/api-sdk-rb/models/save_workspace_workflow_request.rb +296 -0
- data/lib/api-sdk-rb/models/set_adapter_connection_request.rb +1 -1
- data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → set_partner_workflow_preset200_response.rb} +4 -4
- data/lib/api-sdk-rb/models/update_composition.rb +1 -1
- data/lib/api-sdk-rb/models/upload.rb +1 -1
- data/lib/api-sdk-rb/models/upload_limits.rb +3 -3
- data/lib/api-sdk-rb/models/widget.rb +9 -20
- data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
- data/lib/api-sdk-rb/models/widget_clarification_option.rb +256 -0
- data/lib/api-sdk-rb/models/widget_clarification_question.rb +329 -0
- data/lib/api-sdk-rb/models/widget_next_step.rb +307 -0
- data/lib/api-sdk-rb/models/widget_plan.rb +306 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions.rb +346 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_adapters_inner.rb +237 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_libraries_inner.rb +255 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_responsive.rb +311 -0
- data/lib/api-sdk-rb/models/widget_plan_task.rb +320 -0
- data/lib/api-sdk-rb/models/workflow.rb +509 -0
- data/lib/api-sdk-rb/models/workflow_composition_action.rb +266 -0
- data/lib/api-sdk-rb/models/workflow_composition_field.rb +303 -0
- data/lib/api-sdk-rb/models/workflow_composition_option.rb +316 -0
- data/lib/api-sdk-rb/models/workflow_composition_option_actions.rb +284 -0
- data/lib/api-sdk-rb/models/workflow_composition_option_inputs.rb +304 -0
- data/lib/api-sdk-rb/models/workflow_composition_options.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_condition_case.rb +322 -0
- data/lib/api-sdk-rb/models/workflow_condition_test.rb +284 -0
- data/lib/api-sdk-rb/models/workflow_counter.rb +238 -0
- data/lib/api-sdk-rb/models/workflow_detail.rb +580 -0
- data/lib/api-sdk-rb/models/workflow_detail_all_of_last_edited_by.rb +242 -0
- data/lib/api-sdk-rb/models/workflow_detail_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_edge.rb +292 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason_counter.rb +277 -0
- data/lib/api-sdk-rb/models/workflow_field_reference.rb +300 -0
- data/lib/api-sdk-rb/models/workflow_graph.rb +330 -0
- data/lib/api-sdk-rb/models/workflow_issue.rb +309 -0
- data/lib/api-sdk-rb/models/workflow_list.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_node.rb +343 -0
- data/lib/api-sdk-rb/models/workflow_node_position.rb +238 -0
- data/lib/api-sdk-rb/models/workflow_preset_choice.rb +288 -0
- data/lib/api-sdk-rb/models/workflow_preset_choices.rb +224 -0
- data/lib/api-sdk-rb/models/workflow_preset_removal.rb +222 -0
- data/lib/api-sdk-rb/models/workflow_preset_widget.rb +234 -0
- data/lib/api-sdk-rb/models/workflow_publish_result.rb +256 -0
- data/lib/api-sdk-rb/models/workflow_removed.rb +221 -0
- data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_schedule.rb +298 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +347 -0
- data/lib/api-sdk-rb/models/workflow_status.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_trigger.rb +303 -0
- data/lib/api-sdk-rb/models/workflow_trigger_values_inner.rb +271 -0
- data/lib/api-sdk-rb/models/workflow_version.rb +316 -0
- data/lib/api-sdk-rb/models/workflow_version_detail.rb +354 -0
- data/lib/api-sdk-rb/models/workflow_version_list.rb +224 -0
- data/lib/api-sdk-rb/models/workflow_version_published_by.rb +225 -0
- data/lib/api-sdk-rb/version.rb +1 -1
- data/lib/api-sdk-rb.rb +116 -17
- data/spec/api/brand_kit_api_spec.rb +136 -0
- data/spec/api/canvases_api_spec.rb +10 -10
- data/spec/api/compositions_api_spec.rb +227 -149
- data/spec/api/credits_api_spec.rb +5 -5
- data/spec/api/entitlements_api_spec.rb +4 -4
- data/spec/api/invoices_api_spec.rb +2 -2
- data/spec/api/managed_users_api_spec.rb +63 -42
- data/spec/api/operations_api_spec.rb +3 -3
- data/spec/api/partners_api_spec.rb +138 -84
- data/spec/api/public_embed_api_spec.rb +66 -15
- data/spec/api/tokens_api_spec.rb +3 -2
- data/spec/api/uploads_api_spec.rb +24 -24
- data/spec/api/users_api_spec.rb +43 -28
- data/spec/api/widgets_api_spec.rb +9 -9
- data/spec/api/workflows_api_spec.rb +339 -0
- data/spec/models/account_credit_transaction_list_response_spec.rb +48 -0
- data/spec/models/adapter_connection_list_response_spec.rb +48 -0
- data/spec/models/{get_managed_user_limits200_response_spec.rb → adapter_connection_removal_response_spec.rb} +6 -6
- data/spec/models/{delete_managed_user200_response_spec.rb → adapter_connection_response_spec.rb} +6 -6
- data/spec/models/adapter_connection_spec.rb +18 -0
- data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
- data/spec/models/brand_color_spec.rb +52 -0
- data/spec/models/brand_font_spec.rb +62 -0
- data/spec/models/brand_kit_asset_view_spec.rb +120 -0
- data/spec/models/brand_kit_figma_source_spec.rb +60 -0
- data/spec/models/brand_kit_tokens_fonts_spec.rb +54 -0
- data/spec/models/brand_kit_tokens_spec.rb +60 -0
- data/spec/models/brand_kit_view_owner_spec.rb +46 -0
- data/spec/models/{uploads_get200_response_spec.rb → brand_kit_view_response_spec.rb} +6 -6
- data/spec/models/brand_kit_view_spec.rb +90 -0
- data/spec/models/brand_spacing_spec.rb +78 -0
- data/spec/models/brand_text_style_spec.rb +52 -0
- data/spec/models/composition_database_record_response_spec.rb +48 -0
- data/spec/models/composition_last_edited_by_spec.rb +42 -0
- data/spec/models/composition_spec.rb +12 -0
- data/spec/models/confirm_adapter_connection_request_spec.rb +36 -0
- data/spec/models/content_item_write_result_response_spec.rb +48 -0
- data/spec/models/create_widget201_response_data_spec.rb +1 -7
- data/spec/models/create_workspace_workflow_from_preset_request_spec.rb +42 -0
- data/spec/models/create_workspace_workflow_request_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_data_spec.rb → delete_upload200_response_data_spec.rb} +6 -6
- data/spec/models/{operations_id_get_response_spec.rb → delete_upload200_response_spec.rb} +6 -6
- data/spec/models/delete_workspace_workflow200_response_spec.rb +48 -0
- data/spec/models/design_defaults_response_spec.rb +48 -0
- data/spec/models/editor_session_spec.rb +1 -1
- data/spec/models/get_operation_response_data_metadata_spec.rb +58 -0
- data/spec/models/{operations_id_get_response_data_spec.rb → get_operation_response_data_spec.rb} +6 -6
- data/spec/models/get_operation_response_spec.rb +48 -0
- data/spec/models/get_public_composition_embed200_response_adapters_captcha_spec.rb +36 -0
- data/spec/models/get_public_composition_embed200_response_adapters_spec.rb +42 -0
- data/spec/models/get_public_composition_embed200_response_entries_spec.rb +42 -0
- data/spec/models/get_public_composition_embed200_response_media_spec.rb +36 -0
- data/spec/models/get_public_composition_embed200_response_spec.rb +18 -0
- data/spec/models/{get_user_adapter_connections200_response_spec.rb → get_workspace_workflow_stats200_response_spec.rb} +6 -6
- data/spec/models/{remove_user_adapter_connection200_response_spec.rb → get_workspace_workflow_version200_response_spec.rb} +6 -6
- data/spec/models/list_partner_workflow_presets200_response_spec.rb +48 -0
- data/spec/models/list_uploads200_response_spec.rb +48 -0
- data/spec/models/{create_composition_database_record201_response_spec.rb → list_workspace_workflow_composition_options200_response_spec.rb} +6 -6
- data/spec/models/{get_partner_credit_transactions200_response_spec.rb → list_workspace_workflow_presets200_response_spec.rb} +6 -6
- data/spec/models/{add_ai_answers_knowledge_document201_response_spec.rb → list_workspace_workflow_versions200_response_spec.rb} +6 -6
- data/spec/models/list_workspace_workflows200_response_spec.rb +48 -0
- data/spec/models/managed_user_limits_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_spec.rb → managed_user_removal_response_spec.rb} +6 -6
- data/spec/models/new_editor_session_spec.rb +1 -1
- data/spec/models/offer_workflow_preset_request_spec.rb +54 -0
- data/spec/models/offered_workflow_preset_list_spec.rb +36 -0
- data/spec/models/offered_workflow_preset_spec.rb +106 -0
- data/spec/models/offered_workflow_preset_widget_spec.rb +48 -0
- data/spec/models/patch_brand_kit_asset_request_spec.rb +62 -0
- data/spec/models/patch_brand_kit_request_fonts_spec.rb +54 -0
- data/spec/models/patch_brand_kit_request_spacing_spec.rb +78 -0
- data/spec/models/patch_brand_kit_request_spec.rb +72 -0
- data/spec/models/post_brand_kit_icon_request_spec.rb +42 -0
- data/spec/models/public_workflow_events_accepted_spec.rb +48 -0
- data/spec/models/public_workflow_events_request_events_inner_spec.rb +62 -0
- data/spec/models/public_workflow_events_request_heights_inner_spec.rb +42 -0
- data/spec/models/public_workflow_events_request_spec.rb +54 -0
- data/spec/models/public_workflow_response_spec.rb +48 -0
- data/spec/models/public_workflow_spec.rb +94 -0
- data/spec/models/public_workflow_translation_spec.rb +42 -0
- data/spec/models/{get_partner_design_defaults200_response_spec.rb → publish_workspace_workflow200_response_spec.rb} +6 -6
- data/spec/models/publish_workspace_workflow_request_spec.rb +36 -0
- data/spec/models/put_brand_kit_request_spec.rb +48 -0
- data/spec/models/{create_composition_from_widget201_response_spec.rb → remove_partner_workflow_preset200_response_spec.rb} +6 -6
- data/spec/models/report_public_workflow_events200_response_spec.rb +48 -0
- data/spec/models/save_workspace_workflow_request_spec.rb +54 -0
- data/spec/models/{set_user_adapter_connection200_response_spec.rb → set_partner_workflow_preset200_response_spec.rb} +6 -6
- data/spec/models/widget_clarification_option_spec.rb +48 -0
- data/spec/models/widget_clarification_question_spec.rb +60 -0
- data/spec/models/widget_clarification_spec.rb +48 -0
- data/spec/models/widget_next_step_spec.rb +58 -0
- data/spec/models/widget_plan_decisions_adapters_inner_spec.rb +42 -0
- data/spec/models/widget_plan_decisions_libraries_inner_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_responsive_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_spec.rb +78 -0
- data/spec/models/widget_plan_spec.rb +60 -0
- data/spec/models/widget_plan_task_spec.rb +62 -0
- data/spec/models/widget_spec.rb +1 -7
- data/spec/models/workflow_composition_action_spec.rb +54 -0
- data/spec/models/workflow_composition_field_spec.rb +58 -0
- data/spec/models/workflow_composition_option_actions_spec.rb +52 -0
- data/spec/models/workflow_composition_option_inputs_spec.rb +58 -0
- data/spec/models/workflow_composition_option_spec.rb +72 -0
- data/spec/models/workflow_composition_options_spec.rb +54 -0
- data/spec/models/workflow_condition_case_spec.rb +58 -0
- data/spec/models/workflow_condition_test_spec.rb +52 -0
- data/spec/models/workflow_counter_spec.rb +42 -0
- data/spec/models/workflow_detail_all_of_last_edited_by_spec.rb +42 -0
- data/spec/models/workflow_detail_response_spec.rb +48 -0
- data/spec/models/workflow_detail_spec.rb +162 -0
- data/spec/models/workflow_edge_spec.rb +54 -0
- data/spec/models/workflow_failure_reason_counter_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_spec.rb +30 -0
- data/spec/models/workflow_field_reference_spec.rb +56 -0
- data/spec/models/workflow_graph_spec.rb +52 -0
- data/spec/models/workflow_issue_spec.rb +70 -0
- data/spec/models/{create_composition_content_item201_response_spec.rb → workflow_list_spec.rb} +15 -9
- data/spec/models/workflow_node_position_spec.rb +42 -0
- data/spec/models/workflow_node_spec.rb +76 -0
- data/spec/models/workflow_preset_choice_spec.rb +60 -0
- data/spec/models/workflow_preset_choices_spec.rb +36 -0
- data/spec/models/workflow_preset_removal_spec.rb +36 -0
- data/spec/models/workflow_preset_widget_spec.rb +42 -0
- data/spec/models/workflow_publish_result_spec.rb +48 -0
- data/spec/models/workflow_removed_spec.rb +36 -0
- data/spec/models/workflow_response_spec.rb +48 -0
- data/spec/models/workflow_schedule_spec.rb +62 -0
- data/spec/models/workflow_spec.rb +132 -0
- data/spec/models/workflow_stats_spec.rb +84 -0
- data/spec/models/workflow_status_spec.rb +30 -0
- data/spec/models/workflow_trigger_spec.rb +70 -0
- data/spec/models/workflow_trigger_values_inner_spec.rb +46 -0
- data/spec/models/workflow_version_detail_spec.rb +78 -0
- data/spec/models/workflow_version_list_spec.rb +36 -0
- data/spec/models/workflow_version_published_by_spec.rb +42 -0
- data/spec/models/workflow_version_spec.rb +66 -0
- metadata +476 -80
- data/docs/PartnerApi.md +0 -9892
- data/docs/UploadsIdDelete200Response.md +0 -22
- data/lib/api-sdk-rb/api/partner_api.rb +0 -10693
- data/spec/api/partner_api_spec.rb +0 -1895
data/docs/Widget.md
CHANGED
|
@@ -20,8 +20,7 @@
|
|
|
20
20
|
| **repo_id** | **String** | Repository identifier for source code. | [optional] |
|
|
21
21
|
| **database_id** | **String** | Legacy. The name of a Neon database that an earlier version made for this widget. A widget has no database now (what the visitors of a composition leave is kept in the tables of that composition), so widgets made now have none. | [optional] |
|
|
22
22
|
| **version** | **Float** | Version number of the widget. | [optional] |
|
|
23
|
-
| **
|
|
24
|
-
| **last_cpg_commit_sha** | **String** | Last Git commit SHA analyzed for code graph. | [optional] |
|
|
23
|
+
| **last_commit_sha** | **String** | Latest Git commit SHA of the widget's code repository. | [optional] |
|
|
25
24
|
| **organization_id** | **String** | Organization ID if created in an organization workspace. | [optional] |
|
|
26
25
|
| **project_folder** | **String** | Project folder reference for organization widgets. | [optional] |
|
|
27
26
|
| **workspace_type** | **String** | Workspace type when created. | [optional] |
|
|
@@ -49,8 +48,7 @@ instance = ApiSdkRb::Widget.new(
|
|
|
49
48
|
repo_id: user/chart-widget,
|
|
50
49
|
database_id: widget_3fa85f64_5717_4562_b3fc_2c963f66afa6,
|
|
51
50
|
version: 1,
|
|
52
|
-
|
|
53
|
-
last_cpg_commit_sha: a1b2c3d4e5f6g7h8i9j0,
|
|
51
|
+
last_commit_sha: a1b2c3d4e5f6g7h8i9j0,
|
|
54
52
|
organization_id: 5e2d3f4a-1b6c-4a1f-8b9c-3c2d4e5f6a7b,
|
|
55
53
|
project_folder: marketing/q4-launch,
|
|
56
54
|
workspace_type: personal,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetClarification
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **message** | **String** | The sentence that introduces the card. | |
|
|
8
|
+
| **questions** | [**Array<WidgetClarificationQuestion>**](WidgetClarificationQuestion.md) | | |
|
|
9
|
+
| **files_read** | **Array<String>** | The paths of the widget's files the questions were judged against, for a \"Read N files\" row. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WidgetClarification.new(
|
|
17
|
+
message: null,
|
|
18
|
+
questions: null,
|
|
19
|
+
files_read: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetClarificationOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | `q1o1`, `q1o2`, ... Stable within the card. | |
|
|
8
|
+
| **label** | **String** | The option text, at most 60 characters, including the parenthesised recommendation word on the recommended option (for example `Three plans (Recommended)`). | |
|
|
9
|
+
| **recommended** | **Boolean** | True for the one option the assistant recommends. It is always the first option when set. The server composes the recommendation word into `label`; clients may still draw a badge. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WidgetClarificationOption.new(
|
|
17
|
+
id: null,
|
|
18
|
+
label: null,
|
|
19
|
+
recommended: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetClarificationQuestion
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | `q1`, `q2`, ... | |
|
|
8
|
+
| **question** | **String** | | |
|
|
9
|
+
| **recommended_word** | **String** | The localized word placed in parentheses on the recommended option's label (default `Recommended`). | |
|
|
10
|
+
| **options** | [**Array<WidgetClarificationOption>**](WidgetClarificationOption.md) | Two to five options with the recommended one first; empty for a question answered in words only. | |
|
|
11
|
+
| **allow_other** | **Boolean** | Whether the person may answer in their own words (the \"Other...\" row). Always true when there are no options. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'api-sdk-rb'
|
|
17
|
+
|
|
18
|
+
instance = ApiSdkRb::WidgetClarificationQuestion.new(
|
|
19
|
+
id: null,
|
|
20
|
+
question: null,
|
|
21
|
+
recommended_word: null,
|
|
22
|
+
options: null,
|
|
23
|
+
allow_other: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetNextStep
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | `n1`, `n2`, ... | |
|
|
8
|
+
| **label** | **String** | The request, at most 80 characters. | |
|
|
9
|
+
| **kind** | **String** | | |
|
|
10
|
+
| **recommended** | **Boolean** | True for the first suggestion and false for the others. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WidgetNextStep.new(
|
|
18
|
+
id: null,
|
|
19
|
+
label: null,
|
|
20
|
+
kind: null,
|
|
21
|
+
recommended: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/WidgetPlan.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetPlan
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **title** | **String** | One line for the whole plan (\"Building a countdown with confetti\"). | |
|
|
8
|
+
| **tasks** | [**Array<WidgetPlanTask>**](WidgetPlanTask.md) | | |
|
|
9
|
+
| **decisions** | [**WidgetPlanDecisions**](WidgetPlanDecisions.md) | | |
|
|
10
|
+
| **completed** | **Integer** | How many steps are `done`. | |
|
|
11
|
+
| **active_index** | **Integer** | The index in `tasks` of the step in progress, or null when none is. | |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'api-sdk-rb'
|
|
17
|
+
|
|
18
|
+
instance = ApiSdkRb::WidgetPlan.new(
|
|
19
|
+
title: null,
|
|
20
|
+
tasks: null,
|
|
21
|
+
decisions: null,
|
|
22
|
+
completed: null,
|
|
23
|
+
active_index: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetPlanDecisions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **libraries** | [**Array<WidgetPlanDecisionsLibrariesInner>**](WidgetPlanDecisionsLibrariesInner.md) | | |
|
|
8
|
+
| **adapters** | [**Array<WidgetPlanDecisionsAdaptersInner>**](WidgetPlanDecisionsAdaptersInner.md) | The adapters the adapter stage attached on this turn. Empty while that stage is not applied. | |
|
|
9
|
+
| **look** | **String** | What the widget should look like, from what the person provided (words, pictures, a copied page, a Figma frame). May be empty. | |
|
|
10
|
+
| **motion** | **Array<String>** | The animations to apply. At most 3. | |
|
|
11
|
+
| **improvements** | **Array<String>** | Improvements that do not change what was asked. At most 3. | |
|
|
12
|
+
| **notes** | **Array<String>** | Anything else particular to this widget. At most 3. | |
|
|
13
|
+
| **responsive** | [**WidgetPlanDecisionsResponsive**](WidgetPlanDecisionsResponsive.md) | | [optional] |
|
|
14
|
+
| **elements** | **Array<String>** | What a Convert-to-Widget sketch shows: one short phrase per drawn element, in layout order. Empty when the request has no sketch. At most 12. | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'api-sdk-rb'
|
|
20
|
+
|
|
21
|
+
instance = ApiSdkRb::WidgetPlanDecisions.new(
|
|
22
|
+
libraries: null,
|
|
23
|
+
adapters: null,
|
|
24
|
+
look: null,
|
|
25
|
+
motion: null,
|
|
26
|
+
improvements: null,
|
|
27
|
+
notes: null,
|
|
28
|
+
responsive: null,
|
|
29
|
+
elements: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetPlanDecisionsAdaptersInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **label** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'api-sdk-rb'
|
|
14
|
+
|
|
15
|
+
instance = ApiSdkRb::WidgetPlanDecisionsAdaptersInner.new(
|
|
16
|
+
id: null,
|
|
17
|
+
label: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetPlanDecisionsLibrariesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | A stable id of the library (`gsap`, `three`, `chart`, ...). | |
|
|
8
|
+
| **label** | **String** | | |
|
|
9
|
+
| **reason** | **String** | Why the widget needs it, or an empty string. | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WidgetPlanDecisionsLibrariesInner.new(
|
|
17
|
+
id: null,
|
|
18
|
+
label: null,
|
|
19
|
+
reason: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetPlanDecisionsResponsive
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mobile** | **String** | | |
|
|
8
|
+
| **tablet** | **String** | | |
|
|
9
|
+
| **desktop** | **String** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WidgetPlanDecisionsResponsive.new(
|
|
17
|
+
mobile: null,
|
|
18
|
+
tablet: null,
|
|
19
|
+
desktop: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WidgetPlanTask
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | `t1`, `t2`, ... Stable for the life of the plan. | |
|
|
8
|
+
| **label** | **String** | The step, in the language the person wrote in. At most 90 characters. | |
|
|
9
|
+
| **kind** | **String** | What the step is about, so a client can pick an icon. | |
|
|
10
|
+
| **status** | **String** | Where the step stands. At most one step is `in_progress`. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WidgetPlanTask.new(
|
|
18
|
+
id: null,
|
|
19
|
+
label: null,
|
|
20
|
+
kind: null,
|
|
21
|
+
status: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/docs/WidgetsApi.md
CHANGED
|
@@ -4,15 +4,15 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
7
|
+
| [**create_composition_from_widget**](WidgetsApi.md#create_composition_from_widget) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call |
|
|
8
|
+
| [**create_widget**](WidgetsApi.md#create_widget) | **POST** /widgets | Create Widget |
|
|
9
|
+
| [**get_widgets**](WidgetsApi.md#get_widgets) | **GET** /widgets | List Widgets |
|
|
10
|
+
| [**get_widgets_batch**](WidgetsApi.md#get_widgets_batch) | **POST** /widgets/batch | Get Widgets Batch |
|
|
11
11
|
|
|
12
12
|
|
|
13
|
-
##
|
|
13
|
+
## create_composition_from_widget
|
|
14
14
|
|
|
15
|
-
> <
|
|
15
|
+
> <CompositionResponse> create_composition_from_widget(id, idempotency_key, create_composition_from_widget_request)
|
|
16
16
|
|
|
17
17
|
Create a composition for a widget in one call
|
|
18
18
|
|
|
@@ -36,28 +36,28 @@ create_composition_from_widget_request = ApiSdkRb::CreateCompositionFromWidgetRe
|
|
|
36
36
|
|
|
37
37
|
begin
|
|
38
38
|
# Create a composition for a widget in one call
|
|
39
|
-
result = api_instance.
|
|
39
|
+
result = api_instance.create_composition_from_widget(id, idempotency_key, create_composition_from_widget_request)
|
|
40
40
|
p result
|
|
41
41
|
rescue ApiSdkRb::ApiError => e
|
|
42
|
-
puts "Error when calling WidgetsApi->
|
|
42
|
+
puts "Error when calling WidgetsApi->create_composition_from_widget: #{e}"
|
|
43
43
|
end
|
|
44
44
|
```
|
|
45
45
|
|
|
46
|
-
#### Using the
|
|
46
|
+
#### Using the create_composition_from_widget_with_http_info variant
|
|
47
47
|
|
|
48
48
|
This returns an Array which contains the response data, status code and headers.
|
|
49
49
|
|
|
50
|
-
> <Array(<
|
|
50
|
+
> <Array(<CompositionResponse>, Integer, Hash)> create_composition_from_widget_with_http_info(id, idempotency_key, create_composition_from_widget_request)
|
|
51
51
|
|
|
52
52
|
```ruby
|
|
53
53
|
begin
|
|
54
54
|
# Create a composition for a widget in one call
|
|
55
|
-
data, status_code, headers = api_instance.
|
|
55
|
+
data, status_code, headers = api_instance.create_composition_from_widget_with_http_info(id, idempotency_key, create_composition_from_widget_request)
|
|
56
56
|
p status_code # => 2xx
|
|
57
57
|
p headers # => { ... }
|
|
58
|
-
p data # => <
|
|
58
|
+
p data # => <CompositionResponse>
|
|
59
59
|
rescue ApiSdkRb::ApiError => e
|
|
60
|
-
puts "Error when calling WidgetsApi->
|
|
60
|
+
puts "Error when calling WidgetsApi->create_composition_from_widget_with_http_info: #{e}"
|
|
61
61
|
end
|
|
62
62
|
```
|
|
63
63
|
|
|
@@ -71,7 +71,7 @@ end
|
|
|
71
71
|
|
|
72
72
|
### Return type
|
|
73
73
|
|
|
74
|
-
[**
|
|
74
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
75
75
|
|
|
76
76
|
### Authorization
|
|
77
77
|
|
|
@@ -83,9 +83,9 @@ end
|
|
|
83
83
|
- **Accept**: application/json
|
|
84
84
|
|
|
85
85
|
|
|
86
|
-
##
|
|
86
|
+
## create_widget
|
|
87
87
|
|
|
88
|
-
> <CreateWidget201Response>
|
|
88
|
+
> <CreateWidget201Response> create_widget(idempotency_key, new_widget)
|
|
89
89
|
|
|
90
90
|
Create Widget
|
|
91
91
|
|
|
@@ -108,28 +108,28 @@ new_widget = ApiSdkRb::NewWidget.new({name: 'New Chart Widget', type: 'chart', c
|
|
|
108
108
|
|
|
109
109
|
begin
|
|
110
110
|
# Create Widget
|
|
111
|
-
result = api_instance.
|
|
111
|
+
result = api_instance.create_widget(idempotency_key, new_widget)
|
|
112
112
|
p result
|
|
113
113
|
rescue ApiSdkRb::ApiError => e
|
|
114
|
-
puts "Error when calling WidgetsApi->
|
|
114
|
+
puts "Error when calling WidgetsApi->create_widget: #{e}"
|
|
115
115
|
end
|
|
116
116
|
```
|
|
117
117
|
|
|
118
|
-
#### Using the
|
|
118
|
+
#### Using the create_widget_with_http_info variant
|
|
119
119
|
|
|
120
120
|
This returns an Array which contains the response data, status code and headers.
|
|
121
121
|
|
|
122
|
-
> <Array(<CreateWidget201Response>, Integer, Hash)>
|
|
122
|
+
> <Array(<CreateWidget201Response>, Integer, Hash)> create_widget_with_http_info(idempotency_key, new_widget)
|
|
123
123
|
|
|
124
124
|
```ruby
|
|
125
125
|
begin
|
|
126
126
|
# Create Widget
|
|
127
|
-
data, status_code, headers = api_instance.
|
|
127
|
+
data, status_code, headers = api_instance.create_widget_with_http_info(idempotency_key, new_widget)
|
|
128
128
|
p status_code # => 2xx
|
|
129
129
|
p headers # => { ... }
|
|
130
130
|
p data # => <CreateWidget201Response>
|
|
131
131
|
rescue ApiSdkRb::ApiError => e
|
|
132
|
-
puts "Error when calling WidgetsApi->
|
|
132
|
+
puts "Error when calling WidgetsApi->create_widget_with_http_info: #{e}"
|
|
133
133
|
end
|
|
134
134
|
```
|
|
135
135
|
|
|
@@ -154,9 +154,9 @@ end
|
|
|
154
154
|
- **Accept**: application/json
|
|
155
155
|
|
|
156
156
|
|
|
157
|
-
##
|
|
157
|
+
## get_widgets
|
|
158
158
|
|
|
159
|
-
> <GetWidgets200Response>
|
|
159
|
+
> <GetWidgets200Response> get_widgets(opts)
|
|
160
160
|
|
|
161
161
|
List Widgets
|
|
162
162
|
|
|
@@ -184,28 +184,28 @@ opts = {
|
|
|
184
184
|
|
|
185
185
|
begin
|
|
186
186
|
# List Widgets
|
|
187
|
-
result = api_instance.
|
|
187
|
+
result = api_instance.get_widgets(opts)
|
|
188
188
|
p result
|
|
189
189
|
rescue ApiSdkRb::ApiError => e
|
|
190
|
-
puts "Error when calling WidgetsApi->
|
|
190
|
+
puts "Error when calling WidgetsApi->get_widgets: #{e}"
|
|
191
191
|
end
|
|
192
192
|
```
|
|
193
193
|
|
|
194
|
-
#### Using the
|
|
194
|
+
#### Using the get_widgets_with_http_info variant
|
|
195
195
|
|
|
196
196
|
This returns an Array which contains the response data, status code and headers.
|
|
197
197
|
|
|
198
|
-
> <Array(<GetWidgets200Response>, Integer, Hash)>
|
|
198
|
+
> <Array(<GetWidgets200Response>, Integer, Hash)> get_widgets_with_http_info(opts)
|
|
199
199
|
|
|
200
200
|
```ruby
|
|
201
201
|
begin
|
|
202
202
|
# List Widgets
|
|
203
|
-
data, status_code, headers = api_instance.
|
|
203
|
+
data, status_code, headers = api_instance.get_widgets_with_http_info(opts)
|
|
204
204
|
p status_code # => 2xx
|
|
205
205
|
p headers # => { ... }
|
|
206
206
|
p data # => <GetWidgets200Response>
|
|
207
207
|
rescue ApiSdkRb::ApiError => e
|
|
208
|
-
puts "Error when calling WidgetsApi->
|
|
208
|
+
puts "Error when calling WidgetsApi->get_widgets_with_http_info: #{e}"
|
|
209
209
|
end
|
|
210
210
|
```
|
|
211
211
|
|
|
@@ -233,9 +233,9 @@ end
|
|
|
233
233
|
- **Accept**: application/json
|
|
234
234
|
|
|
235
235
|
|
|
236
|
-
##
|
|
236
|
+
## get_widgets_batch
|
|
237
237
|
|
|
238
|
-
> <GetWidgetsBatchResponse>
|
|
238
|
+
> <GetWidgetsBatchResponse> get_widgets_batch(get_widgets_batch_request)
|
|
239
239
|
|
|
240
240
|
Get Widgets Batch
|
|
241
241
|
|
|
@@ -257,28 +257,28 @@ get_widgets_batch_request = ApiSdkRb::GetWidgetsBatchRequest.new({widget_ids: ['
|
|
|
257
257
|
|
|
258
258
|
begin
|
|
259
259
|
# Get Widgets Batch
|
|
260
|
-
result = api_instance.
|
|
260
|
+
result = api_instance.get_widgets_batch(get_widgets_batch_request)
|
|
261
261
|
p result
|
|
262
262
|
rescue ApiSdkRb::ApiError => e
|
|
263
|
-
puts "Error when calling WidgetsApi->
|
|
263
|
+
puts "Error when calling WidgetsApi->get_widgets_batch: #{e}"
|
|
264
264
|
end
|
|
265
265
|
```
|
|
266
266
|
|
|
267
|
-
#### Using the
|
|
267
|
+
#### Using the get_widgets_batch_with_http_info variant
|
|
268
268
|
|
|
269
269
|
This returns an Array which contains the response data, status code and headers.
|
|
270
270
|
|
|
271
|
-
> <Array(<GetWidgetsBatchResponse>, Integer, Hash)>
|
|
271
|
+
> <Array(<GetWidgetsBatchResponse>, Integer, Hash)> get_widgets_batch_with_http_info(get_widgets_batch_request)
|
|
272
272
|
|
|
273
273
|
```ruby
|
|
274
274
|
begin
|
|
275
275
|
# Get Widgets Batch
|
|
276
|
-
data, status_code, headers = api_instance.
|
|
276
|
+
data, status_code, headers = api_instance.get_widgets_batch_with_http_info(get_widgets_batch_request)
|
|
277
277
|
p status_code # => 2xx
|
|
278
278
|
p headers # => { ... }
|
|
279
279
|
p data # => <GetWidgetsBatchResponse>
|
|
280
280
|
rescue ApiSdkRb::ApiError => e
|
|
281
|
-
puts "Error when calling WidgetsApi->
|
|
281
|
+
puts "Error when calling WidgetsApi->get_widgets_batch_with_http_info: #{e}"
|
|
282
282
|
end
|
|
283
283
|
```
|
|
284
284
|
|
data/docs/Workflow.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# ApiSdkRb::Workflow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **managed_user_id** | **String** | The customer of a partner (a managed user) this workflow was made for, or null when it is its workspace's own. A customer's editor session lists and opens only the workflows filed under that customer; the partner's own account sees every customer's and tells them apart by this. It is set when the workflow is made and never changes. | [optional] |
|
|
10
|
+
| **status** | [**WorkflowStatus**](WorkflowStatus.md) | | |
|
|
11
|
+
| **revision** | **Integer** | Rises by one with every save. A save, a publish, a discard and a restore each name the revision they started from. | |
|
|
12
|
+
| **unpublished_changes** | **Boolean** | Whether the draft differs from the live version. | |
|
|
13
|
+
| **composition_ids** | **Array<String>** | | |
|
|
14
|
+
| **block_count** | **Integer** | | |
|
|
15
|
+
| **timezone** | **String** | The zone date and time triggers are read in (stored as UTC). | |
|
|
16
|
+
| **runs_count** | **Integer** | Visitors who started the workflow, over its whole life. | |
|
|
17
|
+
| **live_version_id** | **String** | | [optional] |
|
|
18
|
+
| **created_at** | **Time** | | |
|
|
19
|
+
| **updated_at** | **Time** | | |
|
|
20
|
+
| **first_published_at** | **Time** | | [optional] |
|
|
21
|
+
| **last_published_at** | **Time** | | [optional] |
|
|
22
|
+
| **paused_at** | **Time** | | [optional] |
|
|
23
|
+
| **archived_at** | **Time** | | [optional] |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'api-sdk-rb'
|
|
29
|
+
|
|
30
|
+
instance = ApiSdkRb::Workflow.new(
|
|
31
|
+
id: null,
|
|
32
|
+
name: null,
|
|
33
|
+
managed_user_id: null,
|
|
34
|
+
status: null,
|
|
35
|
+
revision: null,
|
|
36
|
+
unpublished_changes: null,
|
|
37
|
+
composition_ids: null,
|
|
38
|
+
block_count: null,
|
|
39
|
+
timezone: null,
|
|
40
|
+
runs_count: null,
|
|
41
|
+
live_version_id: null,
|
|
42
|
+
created_at: null,
|
|
43
|
+
updated_at: null,
|
|
44
|
+
first_published_at: null,
|
|
45
|
+
last_published_at: null,
|
|
46
|
+
paused_at: null,
|
|
47
|
+
archived_at: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | What the trigger stores to say which action it waits for. It is the goal, and the element when the goal names one (clicks, or clicks@.buy-now). | |
|
|
8
|
+
| **metric** | **String** | The goal's metric (clicks, submissions or plays). | |
|
|
9
|
+
| **label** | **String** | | |
|
|
10
|
+
| **selector** | **String** | The element the goal is about, when it names one. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowCompositionAction.new(
|
|
18
|
+
id: null,
|
|
19
|
+
metric: null,
|
|
20
|
+
label: null,
|
|
21
|
+
selector: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **table** | **String** | | |
|
|
8
|
+
| **column** | **String** | | |
|
|
9
|
+
| **label** | **String** | | |
|
|
10
|
+
| **type** | **String** | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowCompositionField.new(
|
|
18
|
+
table: null,
|
|
19
|
+
column: null,
|
|
20
|
+
label: null,
|
|
21
|
+
type: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **thumbnail_url** | **String** | | [optional] |
|
|
10
|
+
| **published** | **Boolean** | Whether the composition can be shown at all (its widget has a published version). | |
|
|
11
|
+
| **allowed_websites** | **Array<String>** | The websites the composition may be embedded on; empty means anywhere. | |
|
|
12
|
+
| **inputs** | [**WorkflowCompositionOptionInputs**](WorkflowCompositionOptionInputs.md) | | |
|
|
13
|
+
| **actions** | [**WorkflowCompositionOptionActions**](WorkflowCompositionOptionActions.md) | | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'api-sdk-rb'
|
|
19
|
+
|
|
20
|
+
instance = ApiSdkRb::WorkflowCompositionOption.new(
|
|
21
|
+
id: null,
|
|
22
|
+
name: null,
|
|
23
|
+
thumbnail_url: null,
|
|
24
|
+
published: null,
|
|
25
|
+
allowed_websites: null,
|
|
26
|
+
inputs: null,
|
|
27
|
+
actions: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionOptionActions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | | |
|
|
8
|
+
| **reason** | **String** | Why Action in the widget is not available. widget_reports_no_actions means the published widget declares no goals; widget_not_published means the widget has no published version. | [optional] |
|
|
9
|
+
| **items** | [**Array<WorkflowCompositionAction>**](WorkflowCompositionAction.md) | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WorkflowCompositionOptionActions.new(
|
|
17
|
+
enabled: null,
|
|
18
|
+
reason: null,
|
|
19
|
+
items: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionOptionInputs
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | | |
|
|
8
|
+
| **reason** | **String** | Why Input added is not available. widget_keeps_no_data means the composition declares no table a visitor's entries are written to; widget_not_published means the widget has no published version. | [optional] |
|
|
9
|
+
| **tables** | **Array<String>** | Every table a visitor's entries are written to, including one with no field a rule may read. | |
|
|
10
|
+
| **fields** | [**Array<WorkflowCompositionField>**](WorkflowCompositionField.md) | The columns of those tables a rule may read. Not offered are id and created_at, columns that are not text, a number or yes/no, and columns whose name says they hold a person's private details (an email, a phone number), because a value a rule reads is handed to the visitor's page. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowCompositionOptionInputs.new(
|
|
18
|
+
enabled: null,
|
|
19
|
+
reason: null,
|
|
20
|
+
tables: null,
|
|
21
|
+
fields: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|