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
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ApiSdkRb::ConfirmAdapterConnectionRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | The digits of the code Widgetic emailed to the address, with nothing else. It works for 30 minutes and for five wrong tries; after that, save the address again and a new code is emailed | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'api-sdk-rb'
|
|
13
|
+
|
|
14
|
+
instance = ApiSdkRb::ConfirmAdapterConnectionRequest.new(
|
|
15
|
+
code: 123456
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::ContentItemWriteResultResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'api-sdk-rb'
|
|
15
15
|
|
|
16
|
-
instance = ApiSdkRb::
|
|
16
|
+
instance = ApiSdkRb::ContentItemWriteResultResponse.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
|
@@ -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] |
|
|
@@ -50,8 +49,7 @@ instance = ApiSdkRb::CreateWidget201ResponseData.new(
|
|
|
50
49
|
repo_id: user/chart-widget,
|
|
51
50
|
database_id: widget_3fa85f64_5717_4562_b3fc_2c963f66afa6,
|
|
52
51
|
version: 1,
|
|
53
|
-
|
|
54
|
-
last_cpg_commit_sha: a1b2c3d4e5f6g7h8i9j0,
|
|
52
|
+
last_commit_sha: a1b2c3d4e5f6g7h8i9j0,
|
|
55
53
|
organization_id: 5e2d3f4a-1b6c-4a1f-8b9c-3c2d4e5f6a7b,
|
|
56
54
|
project_folder: marketing/q4-launch,
|
|
57
55
|
workspace_type: personal,
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApiSdkRb::CreateWorkspaceWorkflowFromPresetRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | The starting point, as `listWorkspaceWorkflowPresets` gives it. | |
|
|
8
|
+
| **name** | **String** | The new workflow's name. The starting point's title when left out. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'api-sdk-rb'
|
|
14
|
+
|
|
15
|
+
instance = ApiSdkRb::CreateWorkspaceWorkflowFromPresetRequest.new(
|
|
16
|
+
key: welcome-then-offer,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::CreateWorkspaceWorkflowRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **composition_id** | **String** | A composition of this workspace to start with. | [optional] |
|
|
9
|
+
| **timezone** | **String** | An IANA time zone name; UTC when not given. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::CreateWorkspaceWorkflowRequest.new(
|
|
17
|
+
name: Welcome journey,
|
|
18
|
+
composition_id: null,
|
|
19
|
+
timezone: Europe/Bucharest
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/CreditsApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
7
|
+
| [**get_user_credit_balance**](CreditsApi.md#get_user_credit_balance) | **GET** /credits/user/{userId}/balance | Get an account's credit balance |
|
|
8
|
+
| [**get_user_credit_transactions**](CreditsApi.md#get_user_credit_transactions) | **GET** /credits/user/{userId}/transactions | List an account's credit ledger |
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## get_user_credit_balance
|
|
12
12
|
|
|
13
|
-
> <AccountCreditBalanceResponse>
|
|
13
|
+
> <AccountCreditBalanceResponse> get_user_credit_balance(user_id)
|
|
14
14
|
|
|
15
15
|
Get an account's credit balance
|
|
16
16
|
|
|
@@ -32,28 +32,28 @@ user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account whose ba
|
|
|
32
32
|
|
|
33
33
|
begin
|
|
34
34
|
# Get an account's credit balance
|
|
35
|
-
result = api_instance.
|
|
35
|
+
result = api_instance.get_user_credit_balance(user_id)
|
|
36
36
|
p result
|
|
37
37
|
rescue ApiSdkRb::ApiError => e
|
|
38
|
-
puts "Error when calling CreditsApi->
|
|
38
|
+
puts "Error when calling CreditsApi->get_user_credit_balance: #{e}"
|
|
39
39
|
end
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
-
#### Using the
|
|
42
|
+
#### Using the get_user_credit_balance_with_http_info variant
|
|
43
43
|
|
|
44
44
|
This returns an Array which contains the response data, status code and headers.
|
|
45
45
|
|
|
46
|
-
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)>
|
|
46
|
+
> <Array(<AccountCreditBalanceResponse>, Integer, Hash)> get_user_credit_balance_with_http_info(user_id)
|
|
47
47
|
|
|
48
48
|
```ruby
|
|
49
49
|
begin
|
|
50
50
|
# Get an account's credit balance
|
|
51
|
-
data, status_code, headers = api_instance.
|
|
51
|
+
data, status_code, headers = api_instance.get_user_credit_balance_with_http_info(user_id)
|
|
52
52
|
p status_code # => 2xx
|
|
53
53
|
p headers # => { ... }
|
|
54
54
|
p data # => <AccountCreditBalanceResponse>
|
|
55
55
|
rescue ApiSdkRb::ApiError => e
|
|
56
|
-
puts "Error when calling CreditsApi->
|
|
56
|
+
puts "Error when calling CreditsApi->get_user_credit_balance_with_http_info: #{e}"
|
|
57
57
|
end
|
|
58
58
|
```
|
|
59
59
|
|
|
@@ -77,9 +77,9 @@ end
|
|
|
77
77
|
- **Accept**: application/json
|
|
78
78
|
|
|
79
79
|
|
|
80
|
-
##
|
|
80
|
+
## get_user_credit_transactions
|
|
81
81
|
|
|
82
|
-
> <
|
|
82
|
+
> <AccountCreditTransactionListResponse> get_user_credit_transactions(user_id, opts)
|
|
83
83
|
|
|
84
84
|
List an account's credit ledger
|
|
85
85
|
|
|
@@ -106,28 +106,28 @@ opts = {
|
|
|
106
106
|
|
|
107
107
|
begin
|
|
108
108
|
# List an account's credit ledger
|
|
109
|
-
result = api_instance.
|
|
109
|
+
result = api_instance.get_user_credit_transactions(user_id, opts)
|
|
110
110
|
p result
|
|
111
111
|
rescue ApiSdkRb::ApiError => e
|
|
112
|
-
puts "Error when calling CreditsApi->
|
|
112
|
+
puts "Error when calling CreditsApi->get_user_credit_transactions: #{e}"
|
|
113
113
|
end
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
#### Using the
|
|
116
|
+
#### Using the get_user_credit_transactions_with_http_info variant
|
|
117
117
|
|
|
118
118
|
This returns an Array which contains the response data, status code and headers.
|
|
119
119
|
|
|
120
|
-
> <Array(<
|
|
120
|
+
> <Array(<AccountCreditTransactionListResponse>, Integer, Hash)> get_user_credit_transactions_with_http_info(user_id, opts)
|
|
121
121
|
|
|
122
122
|
```ruby
|
|
123
123
|
begin
|
|
124
124
|
# List an account's credit ledger
|
|
125
|
-
data, status_code, headers = api_instance.
|
|
125
|
+
data, status_code, headers = api_instance.get_user_credit_transactions_with_http_info(user_id, opts)
|
|
126
126
|
p status_code # => 2xx
|
|
127
127
|
p headers # => { ... }
|
|
128
|
-
p data # => <
|
|
128
|
+
p data # => <AccountCreditTransactionListResponse>
|
|
129
129
|
rescue ApiSdkRb::ApiError => e
|
|
130
|
-
puts "Error when calling CreditsApi->
|
|
130
|
+
puts "Error when calling CreditsApi->get_user_credit_transactions_with_http_info: #{e}"
|
|
131
131
|
end
|
|
132
132
|
```
|
|
133
133
|
|
|
@@ -142,7 +142,7 @@ end
|
|
|
142
142
|
|
|
143
143
|
### Return type
|
|
144
144
|
|
|
145
|
-
[**
|
|
145
|
+
[**AccountCreditTransactionListResponse**](AccountCreditTransactionListResponse.md)
|
|
146
146
|
|
|
147
147
|
### Authorization
|
|
148
148
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::DeleteUpload200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | |
|
|
8
|
+
| **data** | [**DeleteUpload200ResponseData**](DeleteUpload200ResponseData.md) | | |
|
|
9
|
+
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::DeleteUpload200Response.new(
|
|
17
|
+
success: null,
|
|
18
|
+
data: null,
|
|
19
|
+
meta: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::DeleteUpload200ResponseData
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
```ruby
|
|
12
12
|
require 'api-sdk-rb'
|
|
13
13
|
|
|
14
|
-
instance = ApiSdkRb::
|
|
14
|
+
instance = ApiSdkRb::DeleteUpload200ResponseData.new(
|
|
15
15
|
deleted: null
|
|
16
16
|
)
|
|
17
17
|
```
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::DeleteWorkspaceWorkflow200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | |
|
|
8
|
+
| **data** | [**WorkflowRemoved**](WorkflowRemoved.md) | | |
|
|
9
|
+
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::DeleteWorkspaceWorkflow200Response.new(
|
|
17
|
+
success: true,
|
|
18
|
+
data: null,
|
|
19
|
+
meta: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::DesignDefaultsResponse
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
```ruby
|
|
14
14
|
require 'api-sdk-rb'
|
|
15
15
|
|
|
16
|
-
instance = ApiSdkRb::
|
|
16
|
+
instance = ApiSdkRb::DesignDefaultsResponse.new(
|
|
17
17
|
success: null,
|
|
18
18
|
data: null,
|
|
19
19
|
meta: null
|
data/docs/EntitlementsApi.md
CHANGED
|
@@ -4,13 +4,13 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
7
|
+
| [**get_managed_user_entitlements**](EntitlementsApi.md#get_managed_user_entitlements) | **GET** /entitlements/managed-users/{managedUserId} | Get managed user entitlements |
|
|
8
|
+
| [**get_partner_entitlements**](EntitlementsApi.md#get_partner_entitlements) | **GET** /entitlements/partners/{partnerId} | Get partner entitlements |
|
|
9
9
|
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## get_managed_user_entitlements
|
|
12
12
|
|
|
13
|
-
> <GetManagedUserEntitlementsResponse>
|
|
13
|
+
> <GetManagedUserEntitlementsResponse> get_managed_user_entitlements(managed_user_id, opts)
|
|
14
14
|
|
|
15
15
|
Get managed user entitlements
|
|
16
16
|
|
|
@@ -37,28 +37,28 @@ opts = {
|
|
|
37
37
|
|
|
38
38
|
begin
|
|
39
39
|
# Get managed user entitlements
|
|
40
|
-
result = api_instance.
|
|
40
|
+
result = api_instance.get_managed_user_entitlements(managed_user_id, opts)
|
|
41
41
|
p result
|
|
42
42
|
rescue ApiSdkRb::ApiError => e
|
|
43
|
-
puts "Error when calling EntitlementsApi->
|
|
43
|
+
puts "Error when calling EntitlementsApi->get_managed_user_entitlements: #{e}"
|
|
44
44
|
end
|
|
45
45
|
```
|
|
46
46
|
|
|
47
|
-
#### Using the
|
|
47
|
+
#### Using the get_managed_user_entitlements_with_http_info variant
|
|
48
48
|
|
|
49
49
|
This returns an Array which contains the response data, status code and headers.
|
|
50
50
|
|
|
51
|
-
> <Array(<GetManagedUserEntitlementsResponse>, Integer, Hash)>
|
|
51
|
+
> <Array(<GetManagedUserEntitlementsResponse>, Integer, Hash)> get_managed_user_entitlements_with_http_info(managed_user_id, opts)
|
|
52
52
|
|
|
53
53
|
```ruby
|
|
54
54
|
begin
|
|
55
55
|
# Get managed user entitlements
|
|
56
|
-
data, status_code, headers = api_instance.
|
|
56
|
+
data, status_code, headers = api_instance.get_managed_user_entitlements_with_http_info(managed_user_id, opts)
|
|
57
57
|
p status_code # => 2xx
|
|
58
58
|
p headers # => { ... }
|
|
59
59
|
p data # => <GetManagedUserEntitlementsResponse>
|
|
60
60
|
rescue ApiSdkRb::ApiError => e
|
|
61
|
-
puts "Error when calling EntitlementsApi->
|
|
61
|
+
puts "Error when calling EntitlementsApi->get_managed_user_entitlements_with_http_info: #{e}"
|
|
62
62
|
end
|
|
63
63
|
```
|
|
64
64
|
|
|
@@ -85,9 +85,9 @@ end
|
|
|
85
85
|
- **Accept**: application/json
|
|
86
86
|
|
|
87
87
|
|
|
88
|
-
##
|
|
88
|
+
## get_partner_entitlements
|
|
89
89
|
|
|
90
|
-
> <GetPartnerEntitlementsResponse>
|
|
90
|
+
> <GetPartnerEntitlementsResponse> get_partner_entitlements(partner_id, opts)
|
|
91
91
|
|
|
92
92
|
Get partner entitlements
|
|
93
93
|
|
|
@@ -114,28 +114,28 @@ opts = {
|
|
|
114
114
|
|
|
115
115
|
begin
|
|
116
116
|
# Get partner entitlements
|
|
117
|
-
result = api_instance.
|
|
117
|
+
result = api_instance.get_partner_entitlements(partner_id, opts)
|
|
118
118
|
p result
|
|
119
119
|
rescue ApiSdkRb::ApiError => e
|
|
120
|
-
puts "Error when calling EntitlementsApi->
|
|
120
|
+
puts "Error when calling EntitlementsApi->get_partner_entitlements: #{e}"
|
|
121
121
|
end
|
|
122
122
|
```
|
|
123
123
|
|
|
124
|
-
#### Using the
|
|
124
|
+
#### Using the get_partner_entitlements_with_http_info variant
|
|
125
125
|
|
|
126
126
|
This returns an Array which contains the response data, status code and headers.
|
|
127
127
|
|
|
128
|
-
> <Array(<GetPartnerEntitlementsResponse>, Integer, Hash)>
|
|
128
|
+
> <Array(<GetPartnerEntitlementsResponse>, Integer, Hash)> get_partner_entitlements_with_http_info(partner_id, opts)
|
|
129
129
|
|
|
130
130
|
```ruby
|
|
131
131
|
begin
|
|
132
132
|
# Get partner entitlements
|
|
133
|
-
data, status_code, headers = api_instance.
|
|
133
|
+
data, status_code, headers = api_instance.get_partner_entitlements_with_http_info(partner_id, opts)
|
|
134
134
|
p status_code # => 2xx
|
|
135
135
|
p headers # => { ... }
|
|
136
136
|
p data # => <GetPartnerEntitlementsResponse>
|
|
137
137
|
rescue ApiSdkRb::ApiError => e
|
|
138
|
-
puts "Error when calling EntitlementsApi->
|
|
138
|
+
puts "Error when calling EntitlementsApi->get_partner_entitlements_with_http_info: #{e}"
|
|
139
139
|
end
|
|
140
140
|
```
|
|
141
141
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::GetOperationResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | Always `true` on a success. | |
|
|
8
|
+
| **data** | [**GetOperationResponseData**](GetOperationResponseData.md) | | |
|
|
9
|
+
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::GetOperationResponse.new(
|
|
17
|
+
success: true,
|
|
18
|
+
data: null,
|
|
19
|
+
meta: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# ApiSdkRb::
|
|
1
|
+
# ApiSdkRb::GetOperationResponseData
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
| **type** | **String** | What the operation does | [optional] |
|
|
9
9
|
| **status** | **String** | Where the operation stands. `completed`, `failed` and `cancelled` are final | [optional] |
|
|
10
10
|
| **progress** | **Integer** | How far the operation has got, in percent | [optional] |
|
|
11
|
-
| **metadata** | **
|
|
11
|
+
| **metadata** | [**GetOperationResponseDataMetadata**](GetOperationResponseDataMetadata.md) | | [optional] |
|
|
12
12
|
| **error** | **String** | Why a `failed` operation failed (absent otherwise) | [optional] |
|
|
13
13
|
| **created_at** | **Time** | | [optional] |
|
|
14
14
|
| **updated_at** | **Time** | | [optional] |
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
```ruby
|
|
19
19
|
require 'api-sdk-rb'
|
|
20
20
|
|
|
21
|
-
instance = ApiSdkRb::
|
|
21
|
+
instance = ApiSdkRb::GetOperationResponseData.new(
|
|
22
22
|
id: null,
|
|
23
23
|
type: null,
|
|
24
24
|
status: null,
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::GetOperationResponseDataMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **plan** | [**WidgetPlan**](WidgetPlan.md) | The plan of a code generation, published when it is made and again each time a step changes (`pending`, `in_progress`, `done`, `failed`). `null` when the build was called off, so the client hides the plan it showed. | [optional] |
|
|
8
|
+
| **outcome** | **String** | `needs_answers` on a code generation that completed by asking questions: nothing was built, the credit was returned, and the card is in `clarification`. Absent on every other outcome. | [optional] |
|
|
9
|
+
| **clarification** | [**WidgetClarification**](WidgetClarification.md) | The card of questions, present with `outcome` `needs_answers`. | [optional] |
|
|
10
|
+
| **next_steps** | [**Array<WidgetNextStep>**](WidgetNextStep.md) | Suggested next improvements of a completed code generation, the recommended one first. Absent when none were made in time or the build was not kept. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::GetOperationResponseDataMetadata.new(
|
|
18
|
+
plan: null,
|
|
19
|
+
outcome: null,
|
|
20
|
+
clarification: null,
|
|
21
|
+
next_steps: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -8,16 +8,19 @@
|
|
|
8
8
|
| **widget_id** | **String** | | [optional] |
|
|
9
9
|
| **version** | **Integer** | | [optional] |
|
|
10
10
|
| **widget_version** | **Integer** | Published widget version on the CDN artifact this composition uses. | [optional] |
|
|
11
|
-
| **player_version** | **Integer** | Version of the player: the gateway frame wrapper that shows the widget, and the host bridge it speaks with the embedding page and the widget (currently
|
|
11
|
+
| **player_version** | **Integer** | Version of the player: the gateway frame wrapper that shows the widget, and the host bridge it speaks with the embedding page and the widget (currently 6). Raised when the messages between page, frame, and widget change in a way a widget could notice, such as a new `widgetic:host` field or a new forwarded event (2 added `entries`, 3 added `adapters`, 4 added `entries.writeToken`, 5 added the A/B goal: `widgetic:ab-goal` to the widget and `widgetic:goal` back, 6 added the watch of a workflow: `widgetic:workflow-watch` to the widget, the watched values in `widgetic:submitted` and the watched action in `widgetic:goal`). It is not `widgetVersion` (the version of the published widget) and not the `version` inside a `widgetic:host` message. | [optional] |
|
|
12
12
|
| **data_source** | [**GetPublicCompositionEmbed200ResponseDataSource**](GetPublicCompositionEmbed200ResponseDataSource.md) | | [optional] |
|
|
13
13
|
| **embed_url** | **String** | | [optional] |
|
|
14
14
|
| **entry_write_token** | **String** | Signed per-composition write token for `POST /embed/compositions/{compositionId}/entries/{table}`, also handed to the widget inside `widgetic:host` as `entries.writeToken`. | [optional] |
|
|
15
|
+
| **entries** | [**GetPublicCompositionEmbed200ResponseEntries**](GetPublicCompositionEmbed200ResponseEntries.md) | | [optional] |
|
|
16
|
+
| **adapters** | [**GetPublicCompositionEmbed200ResponseAdapters**](GetPublicCompositionEmbed200ResponseAdapters.md) | | [optional] |
|
|
15
17
|
| **width** | **Integer** | | [optional] |
|
|
16
18
|
| **height** | **Integer** | | [optional] |
|
|
17
19
|
| **design** | **Object** | | [optional] |
|
|
18
20
|
| **content** | **Object** | | [optional] |
|
|
19
21
|
| **content_items** | **Array<Hash<String, Object>>** | | [optional] |
|
|
20
22
|
| **iframe_allow** | **String** | The browser features the widget needs the iframe that shows it to be allowed to use, as the value of that iframe's `allow` attribute (for example `camera; microphone`; the words are `camera`, `display-capture` and `microphone`). Present only for a widget that uses a module that needs one, and absent for every other widget. A page that embeds the frame itself copies it onto its own iframe (`allow=\"...\"`); a page that does not leaves the widget to say, in its own words, that the feature is blocked there. The frame wrapper already passes it on to the iframe it holds. | [optional] |
|
|
23
|
+
| **media** | [**GetPublicCompositionEmbed200ResponseMedia**](GetPublicCompositionEmbed200ResponseMedia.md) | | [optional] |
|
|
21
24
|
| **direct** | [**GetPublicCompositionEmbed200ResponseDirect**](GetPublicCompositionEmbed200ResponseDirect.md) | | [optional] |
|
|
22
25
|
|
|
23
26
|
## Example
|
|
@@ -34,12 +37,15 @@ instance = ApiSdkRb::GetPublicCompositionEmbed200Response.new(
|
|
|
34
37
|
data_source: null,
|
|
35
38
|
embed_url: null,
|
|
36
39
|
entry_write_token: null,
|
|
40
|
+
entries: null,
|
|
41
|
+
adapters: null,
|
|
37
42
|
width: null,
|
|
38
43
|
height: null,
|
|
39
44
|
design: null,
|
|
40
45
|
content: null,
|
|
41
46
|
content_items: null,
|
|
42
47
|
iframe_allow: camera; microphone,
|
|
48
|
+
media: null,
|
|
43
49
|
direct: null
|
|
44
50
|
)
|
|
45
51
|
```
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApiSdkRb::GetPublicCompositionEmbed200ResponseAdapters
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | The operations' address; an operation is `{url}/{adapterId}/{operation}`. | [optional] |
|
|
8
|
+
| **captcha** | [**GetPublicCompositionEmbed200ResponseAdaptersCaptcha**](GetPublicCompositionEmbed200ResponseAdaptersCaptcha.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'api-sdk-rb'
|
|
14
|
+
|
|
15
|
+
instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseAdapters.new(
|
|
16
|
+
url: https://api.widgetic.com/embed/compositions/0f6f7f0e-3c2a-4b86-9e51-2d8d5f4a7c11/adapters,
|
|
17
|
+
captcha: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ApiSdkRb::GetPublicCompositionEmbed200ResponseAdaptersCaptcha
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **site_key** | **String** | The public site key of the CAPTCHA widget. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'api-sdk-rb'
|
|
13
|
+
|
|
14
|
+
instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseAdaptersCaptcha.new(
|
|
15
|
+
site_key: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApiSdkRb::GetPublicCompositionEmbed200ResponseEntries
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | | [optional] |
|
|
8
|
+
| **write_token** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'api-sdk-rb'
|
|
14
|
+
|
|
15
|
+
instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseEntries.new(
|
|
16
|
+
url: null,
|
|
17
|
+
write_token: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ApiSdkRb::GetPublicCompositionEmbed200ResponseMedia
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **optimize** | **Boolean** | The owner's \"Optimize images for the web\" account setting (ON until they turn it off). When true the Embed SDK may ask Cloudflare for a right-sized, modern-format copy of each content image; when false it uses the originals. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'api-sdk-rb'
|
|
13
|
+
|
|
14
|
+
instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseMedia.new(
|
|
15
|
+
optimize: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::GetWorkspaceWorkflowStats200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | |
|
|
8
|
+
| **data** | [**WorkflowStats**](WorkflowStats.md) | | |
|
|
9
|
+
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::GetWorkspaceWorkflowStats200Response.new(
|
|
17
|
+
success: true,
|
|
18
|
+
data: null,
|
|
19
|
+
meta: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::GetWorkspaceWorkflowVersion200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | |
|
|
8
|
+
| **data** | [**WorkflowVersionDetail**](WorkflowVersionDetail.md) | | |
|
|
9
|
+
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::GetWorkspaceWorkflowVersion200Response.new(
|
|
17
|
+
success: true,
|
|
18
|
+
data: null,
|
|
19
|
+
meta: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|