api-sdk-rb 1.11.66 → 1.11.111
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 +192 -9
- data/docs/AdapterConnection.md +7 -1
- 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 +24 -0
- data/docs/BrandKitTokensFonts.md +24 -0
- data/docs/BrandKitView.md +36 -0
- data/docs/BrandKitViewOwner.md +20 -0
- data/docs/BrandKitViewResponse.md +22 -0
- data/docs/BrandSpacing.md +32 -0
- data/docs/Composition.md +5 -1
- data/docs/CompositionLastEditedBy.md +20 -0
- data/docs/CompositionsApi.md +217 -135
- data/docs/ConfirmAdapterConnectionRequest.md +18 -0
- data/docs/CreateWidget201ResponseData.md +2 -4
- data/docs/CreateWorkspaceWorkflowFromPreset201Response.md +22 -0
- data/docs/CreateWorkspaceWorkflowFromPresetRequest.md +20 -0
- data/docs/CreateWorkspaceWorkflowRequest.md +22 -0
- data/docs/DeleteWorkspaceWorkflow200Response.md +22 -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/GetPublicWorkflow200Response.md +22 -0
- data/docs/GetWorkspaceWorkflowStats200Response.md +22 -0
- data/docs/GetWorkspaceWorkflowVersion200Response.md +22 -0
- data/docs/ListPartnerWorkflowPresets200Response.md +22 -0
- 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/ManagedUsersApi.md +1 -1
- 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/PartnerApi.md +3360 -538
- data/docs/PartnerCustomization.md +2 -2
- data/docs/PartnerNotification.md +1 -1
- data/docs/PartnersApi.md +294 -2
- data/docs/PatchBrandKitAssetRequest.md +24 -0
- data/docs/PatchBrandKitRequest.md +28 -0
- data/docs/PatchBrandKitRequestFonts.md +24 -0
- data/docs/PatchBrandKitRequestSpacing.md +32 -0
- data/docs/PostBrandKitIconRequest.md +20 -0
- data/docs/PublicEmbedApi.md +270 -4
- data/docs/PublicWorkflow.md +36 -0
- data/docs/PublicWorkflowEventsAccepted.md +22 -0
- data/docs/PublicWorkflowEventsRequest.md +24 -0
- data/docs/PublicWorkflowEventsRequestEventsInner.md +22 -0
- data/docs/PublicWorkflowEventsRequestHeightsInner.md +20 -0
- 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/SaveWorkspaceWorkflow200Response.md +22 -0
- data/docs/SaveWorkspaceWorkflowRequest.md +24 -0
- data/docs/SetAdapterConnectionRequest.md +1 -1
- data/docs/SetPartnerWorkflowPreset200Response.md +22 -0
- data/docs/UpdateComposition.md +1 -1
- data/docs/UsersApi.md +77 -1
- data/docs/Widget.md +2 -4
- 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/WorkflowEdge.md +24 -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/WorkflowSchedule.md +24 -0
- data/docs/WorkflowStats.md +32 -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 +1743 -0
- data/docs/WorkspacesApi.md +1527 -0
- data/lib/api-sdk-rb/api/brand_kit_api.rb +581 -0
- data/lib/api-sdk-rb/api/compositions_api.rb +237 -138
- data/lib/api-sdk-rb/api/managed_users_api.rb +2 -2
- data/lib/api-sdk-rb/api/partner_api.rb +3907 -809
- data/lib/api-sdk-rb/api/partners_api.rb +320 -4
- data/lib/api-sdk-rb/api/public_embed_api.rb +283 -6
- data/lib/api-sdk-rb/api/users_api.rb +96 -2
- data/lib/api-sdk-rb/api/workflows_api.rb +1997 -0
- data/lib/api-sdk-rb/api/workspaces_api.rb +1775 -0
- data/lib/api-sdk-rb/configuration.rb +50 -2
- data/lib/api-sdk-rb/models/adapter_connection.rb +48 -5
- 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 +304 -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/composition.rb +26 -5
- 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/create_widget201_response_data.rb +9 -20
- data/lib/api-sdk-rb/models/create_workspace_workflow_from_preset201_response.rb +246 -0
- 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/delete_workspace_workflow200_response.rb +246 -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_public_workflow200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_workspace_workflow_stats200_response.rb +246 -0
- data/lib/api-sdk-rb/models/get_workspace_workflow_version200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_partner_workflow_presets200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflow_composition_options200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflow_presets200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflow_versions200_response.rb +246 -0
- data/lib/api-sdk-rb/models/list_workspace_workflows200_response.rb +246 -0
- 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 +332 -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 +332 -0
- data/lib/api-sdk-rb/models/public_workflow_events_request_heights_inner.rb +267 -0
- data/lib/api-sdk-rb/models/public_workflow_translation.rb +242 -0
- data/lib/api-sdk-rb/models/publish_workspace_workflow200_response.rb +246 -0
- 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_partner_workflow_preset200_response.rb +246 -0
- data/lib/api-sdk-rb/models/report_public_workflow_events200_response.rb +246 -0
- data/lib/api-sdk-rb/models/save_workspace_workflow200_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/set_partner_workflow_preset200_response.rb +246 -0
- data/lib/api-sdk-rb/models/update_composition.rb +1 -1
- data/lib/api-sdk-rb/models/widget.rb +9 -20
- 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_edge.rb +292 -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_schedule.rb +298 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +335 -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 +88 -0
- data/spec/api/brand_kit_api_spec.rb +136 -0
- data/spec/api/compositions_api_spec.rb +86 -69
- data/spec/api/managed_users_api_spec.rb +1 -1
- data/spec/api/partner_api_spec.rb +624 -82
- data/spec/api/partners_api_spec.rb +56 -2
- data/spec/api/public_embed_api_spec.rb +54 -3
- data/spec/api/users_api_spec.rb +16 -1
- data/spec/api/workflows_api_spec.rb +378 -0
- data/spec/api/workspaces_api_spec.rb +339 -0
- data/spec/models/adapter_connection_spec.rb +18 -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 +54 -0
- data/spec/models/brand_kit_view_owner_spec.rb +46 -0
- data/spec/models/brand_kit_view_response_spec.rb +48 -0
- data/spec/models/brand_kit_view_spec.rb +90 -0
- data/spec/models/brand_spacing_spec.rb +78 -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/create_widget201_response_data_spec.rb +1 -7
- data/spec/models/create_workspace_workflow_from_preset201_response_spec.rb +48 -0
- 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/delete_workspace_workflow200_response_spec.rb +48 -0
- data/spec/models/editor_session_spec.rb +1 -1
- 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_public_workflow200_response_spec.rb +48 -0
- data/spec/models/get_workspace_workflow_stats200_response_spec.rb +48 -0
- data/spec/models/get_workspace_workflow_version200_response_spec.rb +48 -0
- data/spec/models/list_partner_workflow_presets200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflow_composition_options200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflow_presets200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflow_versions200_response_spec.rb +48 -0
- data/spec/models/list_workspace_workflows200_response_spec.rb +48 -0
- 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 +66 -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 +52 -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_spec.rb +94 -0
- data/spec/models/public_workflow_translation_spec.rb +42 -0
- data/spec/models/publish_workspace_workflow200_response_spec.rb +48 -0
- 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/remove_partner_workflow_preset200_response_spec.rb +48 -0
- data/spec/models/report_public_workflow_events200_response_spec.rb +48 -0
- data/spec/models/save_workspace_workflow200_response_spec.rb +48 -0
- data/spec/models/save_workspace_workflow_request_spec.rb +54 -0
- data/spec/models/set_partner_workflow_preset200_response_spec.rb +48 -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_spec.rb +162 -0
- data/spec/models/workflow_edge_spec.rb +54 -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/workflow_list_spec.rb +54 -0
- 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_schedule_spec.rb +62 -0
- data/spec/models/workflow_spec.rb +132 -0
- data/spec/models/workflow_stats_spec.rb +78 -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 +364 -12
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0c08f383122ab09ada19212acc62f0d4cfe6296684f3bbef65216daac9436512
|
|
4
|
+
data.tar.gz: df321a357e66b6e2f7e0bd7b8e52790f58204c56c27befa4482bbcefd4d5b234
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9b00b9ac44c10eb1895961f58ea898444b7bb8d9001beab31313afe46f698a8edf43c39ce0da8ccf0ed2c9ac503d81b41135f1a98193d4f08b4a65378e2d5ac3
|
|
7
|
+
data.tar.gz: 733488d4666313d097895bb373775254502487d2fdcf4a9f27a1a5c844d5db1c1dd46219051eec61e28ad03fbe28f5c91e190f6a4dd3563f9d1e87b92794bb0d
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ API documentation for the Widgetic API Gateway
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 1.0.0
|
|
10
|
-
- Package version: 1.11.
|
|
10
|
+
- Package version: 1.11.111
|
|
11
11
|
- Generator version: 7.9.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
|
|
@@ -24,16 +24,16 @@ gem build api-sdk-rb.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./api-sdk-rb-1.11.
|
|
27
|
+
gem install ./api-sdk-rb-1.11.111.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./api-sdk-rb-1.11.
|
|
30
|
+
(for development, run `gem install --dev ./api-sdk-rb-1.11.111.gem` to install the development dependencies)
|
|
31
31
|
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
33
|
|
|
34
34
|
Finally add this to the Gemfile:
|
|
35
35
|
|
|
36
|
-
gem 'api-sdk-rb', '~> 1.11.
|
|
36
|
+
gem 'api-sdk-rb', '~> 1.11.111'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -65,15 +65,17 @@ ApiSdkRb.configure do |config|
|
|
|
65
65
|
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
|
|
66
66
|
end
|
|
67
67
|
|
|
68
|
-
api_instance = ApiSdkRb::
|
|
69
|
-
|
|
68
|
+
api_instance = ApiSdkRb::BrandKitApi.new
|
|
69
|
+
opts = {
|
|
70
|
+
organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
71
|
+
}
|
|
70
72
|
|
|
71
73
|
begin
|
|
72
|
-
#
|
|
73
|
-
result = api_instance.
|
|
74
|
+
#Reset the Brand Kit to the default
|
|
75
|
+
result = api_instance.delete_brand_kit_0(opts)
|
|
74
76
|
p result
|
|
75
77
|
rescue ApiSdkRb::ApiError => e
|
|
76
|
-
puts "Exception when calling
|
|
78
|
+
puts "Exception when calling BrandKitApi->delete_brand_kit_0: #{e}"
|
|
77
79
|
end
|
|
78
80
|
|
|
79
81
|
```
|
|
@@ -84,12 +86,21 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
84
86
|
|
|
85
87
|
Class | Method | HTTP request | Description
|
|
86
88
|
------------ | ------------- | ------------- | -------------
|
|
89
|
+
*ApiSdkRb::BrandKitApi* | [**delete_brand_kit_0**](docs/BrandKitApi.md#delete_brand_kit_0) | **DELETE** /brand-kit | Reset the Brand Kit to the default
|
|
90
|
+
*ApiSdkRb::BrandKitApi* | [**delete_brand_kit_asset_0**](docs/BrandKitApi.md#delete_brand_kit_asset_0) | **DELETE** /brand-kit/assets/{assetId} | Remove a font or icon from the Brand Kit
|
|
91
|
+
*ApiSdkRb::BrandKitApi* | [**get_brand_kit_0**](docs/BrandKitApi.md#get_brand_kit_0) | **GET** /brand-kit | The Brand Kit of the current workspace
|
|
92
|
+
*ApiSdkRb::BrandKitApi* | [**patch_brand_kit_0**](docs/BrandKitApi.md#patch_brand_kit_0) | **PATCH** /brand-kit | Change part of the Brand Kit
|
|
93
|
+
*ApiSdkRb::BrandKitApi* | [**patch_brand_kit_asset_0**](docs/BrandKitApi.md#patch_brand_kit_asset_0) | **PATCH** /brand-kit/assets/{assetId} | Rename an icon or relabel a font variant
|
|
94
|
+
*ApiSdkRb::BrandKitApi* | [**post_brand_kit_font_0**](docs/BrandKitApi.md#post_brand_kit_font_0) | **POST** /brand-kit/fonts | Upload a font file to the Brand Kit
|
|
95
|
+
*ApiSdkRb::BrandKitApi* | [**post_brand_kit_icon_0**](docs/BrandKitApi.md#post_brand_kit_icon_0) | **POST** /brand-kit/icons | Add a named SVG icon to the Brand Kit
|
|
96
|
+
*ApiSdkRb::BrandKitApi* | [**put_brand_kit_0**](docs/BrandKitApi.md#put_brand_kit_0) | **PUT** /brand-kit | Save Brand Kit tokens
|
|
87
97
|
*ApiSdkRb::CanvasesApi* | [**create_canvas_0**](docs/CanvasesApi.md#create_canvas_0) | **POST** /canvases | Create Canvas
|
|
88
98
|
*ApiSdkRb::CanvasesApi* | [**delete_canvas_0**](docs/CanvasesApi.md#delete_canvas_0) | **DELETE** /canvases/{id} | Delete Canvas
|
|
89
99
|
*ApiSdkRb::CanvasesApi* | [**get_all_canvases_0**](docs/CanvasesApi.md#get_all_canvases_0) | **GET** /canvases | Get All Canvases
|
|
90
100
|
*ApiSdkRb::CanvasesApi* | [**get_canvas_0**](docs/CanvasesApi.md#get_canvas_0) | **GET** /canvases/{id} | Get Canvas
|
|
91
101
|
*ApiSdkRb::CanvasesApi* | [**update_canvas_0**](docs/CanvasesApi.md#update_canvas_0) | **PUT** /canvases/{id} | Update Canvas
|
|
92
102
|
*ApiSdkRb::CompositionsApi* | [**add_ai_answers_knowledge_document_0**](docs/CompositionsApi.md#add_ai_answers_knowledge_document_0) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents | Add a document for a widget's AI to answer from
|
|
103
|
+
*ApiSdkRb::CompositionsApi* | [**add_ai_answers_knowledge_file_0**](docs/CompositionsApi.md#add_ai_answers_knowledge_file_0) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents/file | Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
93
104
|
*ApiSdkRb::CompositionsApi* | [**check_composition_access_0**](docs/CompositionsApi.md#check_composition_access_0) | **GET** /compositions/{id}/access | Check Composition Access
|
|
94
105
|
*ApiSdkRb::CompositionsApi* | [**create_composition_0**](docs/CompositionsApi.md#create_composition_0) | **POST** /compositions | Create Composition
|
|
95
106
|
*ApiSdkRb::CompositionsApi* | [**create_composition_content_item_0**](docs/CompositionsApi.md#create_composition_content_item_0) | **POST** /compositions/{id}/content/{list}/items | Add a content list item
|
|
@@ -148,9 +159,13 @@ Class | Method | HTTP request | Description
|
|
|
148
159
|
*ApiSdkRb::ManagedUsersApi* | [**update_managed_user_0**](docs/ManagedUsersApi.md#update_managed_user_0) | **PUT** /managed-users/{id} | Update Managed User
|
|
149
160
|
*ApiSdkRb::OperationsApi* | [**operations_id_get_0**](docs/OperationsApi.md#operations_id_get_0) | **GET** /operations/{id} | Get operation status
|
|
150
161
|
*ApiSdkRb::PartnerApi* | [**add_ai_answers_knowledge_document**](docs/PartnerApi.md#add_ai_answers_knowledge_document) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents | Add a document for a widget's AI to answer from
|
|
162
|
+
*ApiSdkRb::PartnerApi* | [**add_ai_answers_knowledge_file**](docs/PartnerApi.md#add_ai_answers_knowledge_file) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents/file | Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
151
163
|
*ApiSdkRb::PartnerApi* | [**add_personal_workspace_domain**](docs/PartnerApi.md#add_personal_workspace_domain) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets
|
|
164
|
+
*ApiSdkRb::PartnerApi* | [**archive_workspace_workflow**](docs/PartnerApi.md#archive_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/archive | Archive a Workflow
|
|
152
165
|
*ApiSdkRb::PartnerApi* | [**call_public_composition_adapter**](docs/PartnerApi.md#call_public_composition_adapter) | **POST** /embed/compositions/{compositionId}/adapters/{adapterId}/{operation} | Call a gateway operation of an adapter a published widget uses
|
|
153
166
|
*ApiSdkRb::PartnerApi* | [**check_composition_access**](docs/PartnerApi.md#check_composition_access) | **GET** /compositions/{id}/access | Check Composition Access
|
|
167
|
+
*ApiSdkRb::PartnerApi* | [**confirm_partner_adapter_connection**](docs/PartnerApi.md#confirm_partner_adapter_connection) | **POST** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm a partner's adapter address with the code that was emailed to it
|
|
168
|
+
*ApiSdkRb::PartnerApi* | [**confirm_user_adapter_connection**](docs/PartnerApi.md#confirm_user_adapter_connection) | **POST** /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm an adapter address with the code that was emailed to it
|
|
154
169
|
*ApiSdkRb::PartnerApi* | [**copy_preset_for_managed_user**](docs/PartnerApi.md#copy_preset_for_managed_user) | **POST** /managed-users/{id}/presets/{key}/copy | Give a managed user a copy of one of your presets
|
|
155
170
|
*ApiSdkRb::PartnerApi* | [**create_canvas**](docs/PartnerApi.md#create_canvas) | **POST** /canvases | Create Canvas
|
|
156
171
|
*ApiSdkRb::PartnerApi* | [**create_composition**](docs/PartnerApi.md#create_composition) | **POST** /compositions | Create Composition
|
|
@@ -164,6 +179,10 @@ Class | Method | HTTP request | Description
|
|
|
164
179
|
*ApiSdkRb::PartnerApi* | [**create_public_composition_entry**](docs/PartnerApi.md#create_public_composition_entry) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway
|
|
165
180
|
*ApiSdkRb::PartnerApi* | [**create_user_api_key**](docs/PartnerApi.md#create_user_api_key) | **POST** /users/{id}/keys | Create an API key
|
|
166
181
|
*ApiSdkRb::PartnerApi* | [**create_widget**](docs/PartnerApi.md#create_widget) | **POST** /widgets | Create Widget
|
|
182
|
+
*ApiSdkRb::PartnerApi* | [**create_workspace_workflow**](docs/PartnerApi.md#create_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows | Create a Workflow
|
|
183
|
+
*ApiSdkRb::PartnerApi* | [**create_workspace_workflow_from_preset**](docs/PartnerApi.md#create_workspace_workflow_from_preset) | **POST** /workspaces/{workspaceId}/workflows/from-preset | Start a Workflow from a starting point
|
|
184
|
+
*ApiSdkRb::PartnerApi* | [**delete_brand_kit**](docs/PartnerApi.md#delete_brand_kit) | **DELETE** /brand-kit | Reset the Brand Kit to the default
|
|
185
|
+
*ApiSdkRb::PartnerApi* | [**delete_brand_kit_asset**](docs/PartnerApi.md#delete_brand_kit_asset) | **DELETE** /brand-kit/assets/{assetId} | Remove a font or icon from the Brand Kit
|
|
167
186
|
*ApiSdkRb::PartnerApi* | [**delete_canvas**](docs/PartnerApi.md#delete_canvas) | **DELETE** /canvases/{id} | Delete Canvas
|
|
168
187
|
*ApiSdkRb::PartnerApi* | [**delete_composition**](docs/PartnerApi.md#delete_composition) | **DELETE** /compositions/{id} | Delete Composition
|
|
169
188
|
*ApiSdkRb::PartnerApi* | [**delete_composition_content_item**](docs/PartnerApi.md#delete_composition_content_item) | **DELETE** /compositions/{id}/content/{list}/items/{itemId} | Delete a content list item
|
|
@@ -173,13 +192,17 @@ Class | Method | HTTP request | Description
|
|
|
173
192
|
*ApiSdkRb::PartnerApi* | [**delete_managed_user**](docs/PartnerApi.md#delete_managed_user) | **DELETE** /managed-users/{id} | Delete Managed User
|
|
174
193
|
*ApiSdkRb::PartnerApi* | [**delete_personal_workspace_domain**](docs/PartnerApi.md#delete_personal_workspace_domain) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets
|
|
175
194
|
*ApiSdkRb::PartnerApi* | [**delete_user_api_key**](docs/PartnerApi.md#delete_user_api_key) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key
|
|
195
|
+
*ApiSdkRb::PartnerApi* | [**delete_workspace_workflow**](docs/PartnerApi.md#delete_workspace_workflow) | **DELETE** /workspaces/{workspaceId}/workflows/{workflowId} | Delete a Workflow
|
|
176
196
|
*ApiSdkRb::PartnerApi* | [**describe_composition_entries**](docs/PartnerApi.md#describe_composition_entries) | **GET** /compositions/{id}/entries | Describe What a Composition Keeps
|
|
197
|
+
*ApiSdkRb::PartnerApi* | [**discard_workspace_workflow_changes**](docs/PartnerApi.md#discard_workspace_workflow_changes) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/discard | Discard the Unpublished Changes of a Workflow
|
|
177
198
|
*ApiSdkRb::PartnerApi* | [**duplicate_composition**](docs/PartnerApi.md#duplicate_composition) | **POST** /compositions/{id}/duplicate | Duplicate Composition
|
|
199
|
+
*ApiSdkRb::PartnerApi* | [**duplicate_workspace_workflow**](docs/PartnerApi.md#duplicate_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/duplicate | Duplicate a Workflow
|
|
178
200
|
*ApiSdkRb::PartnerApi* | [**export_composition_entry_items**](docs/PartnerApi.md#export_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/export | Export composition entry items
|
|
179
201
|
*ApiSdkRb::PartnerApi* | [**get_ai_answers_knowledge**](docs/PartnerApi.md#get_ai_answers_knowledge) | **GET** /compositions/{id}/adapters/ai-answers/knowledge | See the documents a widget's AI answers from
|
|
180
202
|
*ApiSdkRb::PartnerApi* | [**get_all_canvases**](docs/PartnerApi.md#get_all_canvases) | **GET** /canvases | Get All Canvases
|
|
181
203
|
*ApiSdkRb::PartnerApi* | [**get_all_compositions**](docs/PartnerApi.md#get_all_compositions) | **GET** /compositions | Get All Compositions
|
|
182
204
|
*ApiSdkRb::PartnerApi* | [**get_all_managed_users**](docs/PartnerApi.md#get_all_managed_users) | **GET** /managed-users | Get Managed Users
|
|
205
|
+
*ApiSdkRb::PartnerApi* | [**get_brand_kit**](docs/PartnerApi.md#get_brand_kit) | **GET** /brand-kit | The Brand Kit of the current workspace
|
|
183
206
|
*ApiSdkRb::PartnerApi* | [**get_canvas**](docs/PartnerApi.md#get_canvas) | **GET** /canvases/{id} | Get Canvas
|
|
184
207
|
*ApiSdkRb::PartnerApi* | [**get_composition_by_id**](docs/PartnerApi.md#get_composition_by_id) | **GET** /compositions/{id} | Get Composition
|
|
185
208
|
*ApiSdkRb::PartnerApi* | [**get_composition_content**](docs/PartnerApi.md#get_composition_content) | **GET** /compositions/{id}/content | Get Current Content
|
|
@@ -222,6 +245,9 @@ Class | Method | HTTP request | Description
|
|
|
222
245
|
*ApiSdkRb::PartnerApi* | [**get_personal_workspace_domains**](docs/PartnerApi.md#get_personal_workspace_domains) | **GET** /users/{id}/workspace/domains | List the websites allowed to show your widgets
|
|
223
246
|
*ApiSdkRb::PartnerApi* | [**get_public_composition_embed**](docs/PartnerApi.md#get_public_composition_embed) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL
|
|
224
247
|
*ApiSdkRb::PartnerApi* | [**get_public_composition_iframe**](docs/PartnerApi.md#get_public_composition_iframe) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values
|
|
248
|
+
*ApiSdkRb::PartnerApi* | [**get_public_workflow**](docs/PartnerApi.md#get_public_workflow) | **GET** /embed/workflows/{workflowId} | Read the published Workflow of an embed
|
|
249
|
+
*ApiSdkRb::PartnerApi* | [**get_public_workflow_frame**](docs/PartnerApi.md#get_public_workflow_frame) | **GET** /embed/workflows/{workflowId}/frame | Show a published Workflow in a page of its own
|
|
250
|
+
*ApiSdkRb::PartnerApi* | [**get_public_workflow_version**](docs/PartnerApi.md#get_public_workflow_version) | **GET** /embed/workflows/{workflowId}/versions/{versionId} | Read one published version of a Workflow
|
|
225
251
|
*ApiSdkRb::PartnerApi* | [**get_user_adapter_connections**](docs/PartnerApi.md#get_user_adapter_connections) | **GET** /users/{userId}/adapter-connections | See which adapter keys an account has connected
|
|
226
252
|
*ApiSdkRb::PartnerApi* | [**get_user_api_key_usage_logs**](docs/PartnerApi.md#get_user_api_key_usage_logs) | **GET** /users/{id}/api-keys/{keyId}/logs | Read what an API key was used for
|
|
227
253
|
*ApiSdkRb::PartnerApi* | [**get_user_api_keys**](docs/PartnerApi.md#get_user_api_keys) | **GET** /users/{id}/keys | List the API keys of an account
|
|
@@ -229,26 +255,46 @@ Class | Method | HTTP request | Description
|
|
|
229
255
|
*ApiSdkRb::PartnerApi* | [**get_user_credit_transactions**](docs/PartnerApi.md#get_user_credit_transactions) | **GET** /credits/user/{userId}/transactions | List an account's credit ledger
|
|
230
256
|
*ApiSdkRb::PartnerApi* | [**get_widgets**](docs/PartnerApi.md#get_widgets) | **GET** /widgets | List Widgets
|
|
231
257
|
*ApiSdkRb::PartnerApi* | [**get_widgets_batch**](docs/PartnerApi.md#get_widgets_batch) | **POST** /widgets/batch | Get Widgets Batch
|
|
258
|
+
*ApiSdkRb::PartnerApi* | [**get_workspace_workflow**](docs/PartnerApi.md#get_workspace_workflow) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow
|
|
259
|
+
*ApiSdkRb::PartnerApi* | [**get_workspace_workflow_stats**](docs/PartnerApi.md#get_workspace_workflow_stats) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow
|
|
260
|
+
*ApiSdkRb::PartnerApi* | [**get_workspace_workflow_version**](docs/PartnerApi.md#get_workspace_workflow_version) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow
|
|
232
261
|
*ApiSdkRb::PartnerApi* | [**list_composition_entry_items**](docs/PartnerApi.md#list_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/items | List composition entry items with paging and filters
|
|
233
262
|
*ApiSdkRb::PartnerApi* | [**list_managed_user_entries**](docs/PartnerApi.md#list_managed_user_entries) | **GET** /managed-users/{id}/entries | List entries across a managed user's compositions
|
|
234
263
|
*ApiSdkRb::PartnerApi* | [**list_partner_notification_deliveries**](docs/PartnerApi.md#list_partner_notification_deliveries) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you
|
|
235
264
|
*ApiSdkRb::PartnerApi* | [**list_partner_notifications**](docs/PartnerApi.md#list_partner_notifications) | **GET** /partners/{partnerId}/notifications | What your partner account was told
|
|
236
265
|
*ApiSdkRb::PartnerApi* | [**list_partner_presets**](docs/PartnerApi.md#list_partner_presets) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets
|
|
266
|
+
*ApiSdkRb::PartnerApi* | [**list_partner_workflow_presets**](docs/PartnerApi.md#list_partner_workflow_presets) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start
|
|
267
|
+
*ApiSdkRb::PartnerApi* | [**list_workspace_workflow_composition_options**](docs/PartnerApi.md#list_workspace_workflow_composition_options) | **GET** /workspaces/{workspaceId}/workflows/composition-options | List the compositions a workflow can show, and what each can do
|
|
268
|
+
*ApiSdkRb::PartnerApi* | [**list_workspace_workflow_presets**](docs/PartnerApi.md#list_workspace_workflow_presets) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow
|
|
269
|
+
*ApiSdkRb::PartnerApi* | [**list_workspace_workflow_versions**](docs/PartnerApi.md#list_workspace_workflow_versions) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow
|
|
270
|
+
*ApiSdkRb::PartnerApi* | [**list_workspace_workflows**](docs/PartnerApi.md#list_workspace_workflows) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace
|
|
237
271
|
*ApiSdkRb::PartnerApi* | [**operations_id_get**](docs/PartnerApi.md#operations_id_get) | **GET** /operations/{id} | Get operation status
|
|
272
|
+
*ApiSdkRb::PartnerApi* | [**patch_brand_kit**](docs/PartnerApi.md#patch_brand_kit) | **PATCH** /brand-kit | Change part of the Brand Kit
|
|
273
|
+
*ApiSdkRb::PartnerApi* | [**patch_brand_kit_asset**](docs/PartnerApi.md#patch_brand_kit_asset) | **PATCH** /brand-kit/assets/{assetId} | Rename an icon or relabel a font variant
|
|
238
274
|
*ApiSdkRb::PartnerApi* | [**patch_composition_content_item**](docs/PartnerApi.md#patch_composition_content_item) | **PATCH** /compositions/{id}/content/{list}/items/{itemId} | Update a content list item
|
|
275
|
+
*ApiSdkRb::PartnerApi* | [**pause_workspace_workflow**](docs/PartnerApi.md#pause_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow
|
|
276
|
+
*ApiSdkRb::PartnerApi* | [**post_brand_kit_font**](docs/PartnerApi.md#post_brand_kit_font) | **POST** /brand-kit/fonts | Upload a font file to the Brand Kit
|
|
277
|
+
*ApiSdkRb::PartnerApi* | [**post_brand_kit_icon**](docs/PartnerApi.md#post_brand_kit_icon) | **POST** /brand-kit/icons | Add a named SVG icon to the Brand Kit
|
|
239
278
|
*ApiSdkRb::PartnerApi* | [**post_public_composition_embed_status**](docs/PartnerApi.md#post_public_composition_embed_status) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed
|
|
279
|
+
*ApiSdkRb::PartnerApi* | [**publish_workspace_workflow**](docs/PartnerApi.md#publish_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow
|
|
280
|
+
*ApiSdkRb::PartnerApi* | [**put_brand_kit**](docs/PartnerApi.md#put_brand_kit) | **PUT** /brand-kit | Save Brand Kit tokens
|
|
240
281
|
*ApiSdkRb::PartnerApi* | [**read_composition_entries**](docs/PartnerApi.md#read_composition_entries) | **GET** /compositions/{id}/entries/{table} | Read the Entries of a Composition's Table
|
|
241
282
|
*ApiSdkRb::PartnerApi* | [**remove_ai_answers_knowledge_document**](docs/PartnerApi.md#remove_ai_answers_knowledge_document) | **DELETE** /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId} | Remove a document from a widget's knowledge base
|
|
242
283
|
*ApiSdkRb::PartnerApi* | [**remove_partner_adapter_connection**](docs/PartnerApi.md#remove_partner_adapter_connection) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner
|
|
243
284
|
*ApiSdkRb::PartnerApi* | [**remove_partner_data_database**](docs/PartnerApi.md#remove_partner_data_database) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database
|
|
244
285
|
*ApiSdkRb::PartnerApi* | [**remove_partner_preset**](docs/PartnerApi.md#remove_partner_preset) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets
|
|
245
286
|
*ApiSdkRb::PartnerApi* | [**remove_partner_storage_destination**](docs/PartnerApi.md#remove_partner_storage_destination) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket
|
|
287
|
+
*ApiSdkRb::PartnerApi* | [**remove_partner_workflow_preset**](docs/PartnerApi.md#remove_partner_workflow_preset) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start
|
|
246
288
|
*ApiSdkRb::PartnerApi* | [**remove_user_adapter_connection**](docs/PartnerApi.md#remove_user_adapter_connection) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account
|
|
247
289
|
*ApiSdkRb::PartnerApi* | [**replay_partner_notification_delivery**](docs/PartnerApi.md#replay_partner_notification_delivery) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again
|
|
290
|
+
*ApiSdkRb::PartnerApi* | [**report_public_workflow_events**](docs/PartnerApi.md#report_public_workflow_events) | **POST** /embed/workflows/{workflowId}/events | Report what visitors did in a Workflow, as counts
|
|
291
|
+
*ApiSdkRb::PartnerApi* | [**restore_workspace_workflow_version**](docs/PartnerApi.md#restore_workspace_workflow_version) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft
|
|
292
|
+
*ApiSdkRb::PartnerApi* | [**resume_workspace_workflow**](docs/PartnerApi.md#resume_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow
|
|
248
293
|
*ApiSdkRb::PartnerApi* | [**revoke_managed_user_editor_session**](docs/PartnerApi.md#revoke_managed_user_editor_session) | **DELETE** /managed-users/{id}/editor-sessions/{sessionId} | End one editor session of a managed user
|
|
249
294
|
*ApiSdkRb::PartnerApi* | [**revoke_managed_user_editor_sessions**](docs/PartnerApi.md#revoke_managed_user_editor_sessions) | **DELETE** /managed-users/{id}/editor-sessions | End every editor session of a managed user
|
|
250
295
|
*ApiSdkRb::PartnerApi* | [**rotate_partner_entry_context_secret**](docs/PartnerApi.md#rotate_partner_entry_context_secret) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds
|
|
251
296
|
*ApiSdkRb::PartnerApi* | [**rotate_partner_webhook_secret**](docs/PartnerApi.md#rotate_partner_webhook_secret) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook
|
|
297
|
+
*ApiSdkRb::PartnerApi* | [**save_workspace_workflow**](docs/PartnerApi.md#save_workspace_workflow) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow
|
|
252
298
|
*ApiSdkRb::PartnerApi* | [**send_partner_notification_test_event**](docs/PartnerApi.md#send_partner_notification_test_event) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook
|
|
253
299
|
*ApiSdkRb::PartnerApi* | [**set_composition_data_source**](docs/PartnerApi.md#set_composition_data_source) | **PUT** /compositions/{id}/data-source | Bind a public JSON data source for embed refresh
|
|
254
300
|
*ApiSdkRb::PartnerApi* | [**set_dynamic_content**](docs/PartnerApi.md#set_dynamic_content) | **PUT** /compositions/{id}/content | Set Dynamic Content
|
|
@@ -259,7 +305,9 @@ Class | Method | HTTP request | Description
|
|
|
259
305
|
*ApiSdkRb::PartnerApi* | [**set_partner_design_defaults**](docs/PartnerApi.md#set_partner_design_defaults) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults
|
|
260
306
|
*ApiSdkRb::PartnerApi* | [**set_partner_preset**](docs/PartnerApi.md#set_partner_preset) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset
|
|
261
307
|
*ApiSdkRb::PartnerApi* | [**set_partner_storage_destination**](docs/PartnerApi.md#set_partner_storage_destination) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored
|
|
308
|
+
*ApiSdkRb::PartnerApi* | [**set_partner_workflow_preset**](docs/PartnerApi.md#set_partner_workflow_preset) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers
|
|
262
309
|
*ApiSdkRb::PartnerApi* | [**set_user_adapter_connection**](docs/PartnerApi.md#set_user_adapter_connection) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account
|
|
310
|
+
*ApiSdkRb::PartnerApi* | [**unarchive_workspace_workflow**](docs/PartnerApi.md#unarchive_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow
|
|
263
311
|
*ApiSdkRb::PartnerApi* | [**update_canvas**](docs/PartnerApi.md#update_canvas) | **PUT** /canvases/{id} | Update Canvas
|
|
264
312
|
*ApiSdkRb::PartnerApi* | [**update_composition**](docs/PartnerApi.md#update_composition) | **PUT** /compositions/{id} | Update Composition
|
|
265
313
|
*ApiSdkRb::PartnerApi* | [**update_composition_database_record**](docs/PartnerApi.md#update_composition_database_record) | **PUT** /compositions/{id}/database/{table}/{recordId} | Update Record In Composition Database
|
|
@@ -279,6 +327,7 @@ Class | Method | HTTP request | Description
|
|
|
279
327
|
*ApiSdkRb::PartnerApi* | [**validate_token**](docs/PartnerApi.md#validate_token) | **GET** /tokens/validate | Validate current authentication token
|
|
280
328
|
*ApiSdkRb::PartnerApi* | [**verify_partner_data_database**](docs/PartnerApi.md#verify_partner_data_database) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works
|
|
281
329
|
*ApiSdkRb::PartnerApi* | [**verify_partner_storage_destination**](docs/PartnerApi.md#verify_partner_storage_destination) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works
|
|
330
|
+
*ApiSdkRb::PartnersApi* | [**confirm_partner_adapter_connection_0**](docs/PartnersApi.md#confirm_partner_adapter_connection_0) | **POST** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm a partner's adapter address with the code that was emailed to it
|
|
282
331
|
*ApiSdkRb::PartnersApi* | [**create_partner_extra_credits_invoice_0**](docs/PartnersApi.md#create_partner_extra_credits_invoice_0) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner
|
|
283
332
|
*ApiSdkRb::PartnersApi* | [**get_my_partners_0**](docs/PartnersApi.md#get_my_partners_0) | **GET** /partners/mine | Find the partner you administer
|
|
284
333
|
*ApiSdkRb::PartnersApi* | [**get_partner_adapter_connections_0**](docs/PartnersApi.md#get_partner_adapter_connections_0) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected
|
|
@@ -299,10 +348,12 @@ Class | Method | HTTP request | Description
|
|
|
299
348
|
*ApiSdkRb::PartnersApi* | [**list_partner_notification_deliveries_0**](docs/PartnersApi.md#list_partner_notification_deliveries_0) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you
|
|
300
349
|
*ApiSdkRb::PartnersApi* | [**list_partner_notifications_0**](docs/PartnersApi.md#list_partner_notifications_0) | **GET** /partners/{partnerId}/notifications | What your partner account was told
|
|
301
350
|
*ApiSdkRb::PartnersApi* | [**list_partner_presets_0**](docs/PartnersApi.md#list_partner_presets_0) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets
|
|
351
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_workflow_presets_0**](docs/PartnersApi.md#list_partner_workflow_presets_0) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start
|
|
302
352
|
*ApiSdkRb::PartnersApi* | [**remove_partner_adapter_connection_0**](docs/PartnersApi.md#remove_partner_adapter_connection_0) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner
|
|
303
353
|
*ApiSdkRb::PartnersApi* | [**remove_partner_data_database_0**](docs/PartnersApi.md#remove_partner_data_database_0) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database
|
|
304
354
|
*ApiSdkRb::PartnersApi* | [**remove_partner_preset_0**](docs/PartnersApi.md#remove_partner_preset_0) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets
|
|
305
355
|
*ApiSdkRb::PartnersApi* | [**remove_partner_storage_destination_0**](docs/PartnersApi.md#remove_partner_storage_destination_0) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket
|
|
356
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_workflow_preset_0**](docs/PartnersApi.md#remove_partner_workflow_preset_0) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start
|
|
306
357
|
*ApiSdkRb::PartnersApi* | [**replay_partner_notification_delivery_0**](docs/PartnersApi.md#replay_partner_notification_delivery_0) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again
|
|
307
358
|
*ApiSdkRb::PartnersApi* | [**rotate_partner_entry_context_secret_0**](docs/PartnersApi.md#rotate_partner_entry_context_secret_0) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds
|
|
308
359
|
*ApiSdkRb::PartnersApi* | [**rotate_partner_webhook_secret_0**](docs/PartnersApi.md#rotate_partner_webhook_secret_0) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook
|
|
@@ -312,6 +363,7 @@ Class | Method | HTTP request | Description
|
|
|
312
363
|
*ApiSdkRb::PartnersApi* | [**set_partner_design_defaults_0**](docs/PartnersApi.md#set_partner_design_defaults_0) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults
|
|
313
364
|
*ApiSdkRb::PartnersApi* | [**set_partner_preset_0**](docs/PartnersApi.md#set_partner_preset_0) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset
|
|
314
365
|
*ApiSdkRb::PartnersApi* | [**set_partner_storage_destination_0**](docs/PartnersApi.md#set_partner_storage_destination_0) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored
|
|
366
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_workflow_preset_0**](docs/PartnersApi.md#set_partner_workflow_preset_0) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers
|
|
315
367
|
*ApiSdkRb::PartnersApi* | [**update_partner_entry_context_signing_0**](docs/PartnersApi.md#update_partner_entry_context_signing_0) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it
|
|
316
368
|
*ApiSdkRb::PartnersApi* | [**update_partner_notification_settings_0**](docs/PartnersApi.md#update_partner_notification_settings_0) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go
|
|
317
369
|
*ApiSdkRb::PartnersApi* | [**verify_partner_data_database_0**](docs/PartnersApi.md#verify_partner_data_database_0) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works
|
|
@@ -320,7 +372,11 @@ Class | Method | HTTP request | Description
|
|
|
320
372
|
*ApiSdkRb::PublicEmbedApi* | [**create_public_composition_entry_0**](docs/PublicEmbedApi.md#create_public_composition_entry_0) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway
|
|
321
373
|
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_embed_0**](docs/PublicEmbedApi.md#get_public_composition_embed_0) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL
|
|
322
374
|
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_iframe_0**](docs/PublicEmbedApi.md#get_public_composition_iframe_0) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values
|
|
375
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_0**](docs/PublicEmbedApi.md#get_public_workflow_0) | **GET** /embed/workflows/{workflowId} | Read the published Workflow of an embed
|
|
376
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_frame_0**](docs/PublicEmbedApi.md#get_public_workflow_frame_0) | **GET** /embed/workflows/{workflowId}/frame | Show a published Workflow in a page of its own
|
|
377
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_version_0**](docs/PublicEmbedApi.md#get_public_workflow_version_0) | **GET** /embed/workflows/{workflowId}/versions/{versionId} | Read one published version of a Workflow
|
|
323
378
|
*ApiSdkRb::PublicEmbedApi* | [**post_public_composition_embed_status_0**](docs/PublicEmbedApi.md#post_public_composition_embed_status_0) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed
|
|
379
|
+
*ApiSdkRb::PublicEmbedApi* | [**report_public_workflow_events_0**](docs/PublicEmbedApi.md#report_public_workflow_events_0) | **POST** /embed/workflows/{workflowId}/events | Report what visitors did in a Workflow, as counts
|
|
324
380
|
*ApiSdkRb::PublicEmbedApi* | [**upload_public_composition_adapter_file_0**](docs/PublicEmbedApi.md#upload_public_composition_adapter_file_0) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget
|
|
325
381
|
*ApiSdkRb::TokensApi* | [**validate_token_0**](docs/TokensApi.md#validate_token_0) | **GET** /tokens/validate | Validate current authentication token
|
|
326
382
|
*ApiSdkRb::UploadsApi* | [**uploads_get_0**](docs/UploadsApi.md#uploads_get_0) | **GET** /uploads | List the account's uploads
|
|
@@ -329,6 +385,7 @@ Class | Method | HTTP request | Description
|
|
|
329
385
|
*ApiSdkRb::UploadsApi* | [**uploads_limits_get_0**](docs/UploadsApi.md#uploads_limits_get_0) | **GET** /uploads/limits | Upload size limits and accepted file types
|
|
330
386
|
*ApiSdkRb::UploadsApi* | [**uploads_post_0**](docs/UploadsApi.md#uploads_post_0) | **POST** /uploads | Upload a file
|
|
331
387
|
*ApiSdkRb::UsersApi* | [**add_personal_workspace_domain_0**](docs/UsersApi.md#add_personal_workspace_domain_0) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets
|
|
388
|
+
*ApiSdkRb::UsersApi* | [**confirm_user_adapter_connection_0**](docs/UsersApi.md#confirm_user_adapter_connection_0) | **POST** /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm an adapter address with the code that was emailed to it
|
|
332
389
|
*ApiSdkRb::UsersApi* | [**create_user_api_key_0**](docs/UsersApi.md#create_user_api_key_0) | **POST** /users/{id}/keys | Create an API key
|
|
333
390
|
*ApiSdkRb::UsersApi* | [**delete_personal_workspace_domain_0**](docs/UsersApi.md#delete_personal_workspace_domain_0) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets
|
|
334
391
|
*ApiSdkRb::UsersApi* | [**delete_user_api_key_0**](docs/UsersApi.md#delete_user_api_key_0) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key
|
|
@@ -344,6 +401,47 @@ Class | Method | HTTP request | Description
|
|
|
344
401
|
*ApiSdkRb::WidgetsApi* | [**create_widget_0**](docs/WidgetsApi.md#create_widget_0) | **POST** /widgets | Create Widget
|
|
345
402
|
*ApiSdkRb::WidgetsApi* | [**get_widgets_0**](docs/WidgetsApi.md#get_widgets_0) | **GET** /widgets | List Widgets
|
|
346
403
|
*ApiSdkRb::WidgetsApi* | [**get_widgets_batch_0**](docs/WidgetsApi.md#get_widgets_batch_0) | **POST** /widgets/batch | Get Widgets Batch
|
|
404
|
+
*ApiSdkRb::WorkflowsApi* | [**archive_workspace_workflow_0**](docs/WorkflowsApi.md#archive_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/archive | Archive a Workflow
|
|
405
|
+
*ApiSdkRb::WorkflowsApi* | [**create_workspace_workflow_0**](docs/WorkflowsApi.md#create_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows | Create a Workflow
|
|
406
|
+
*ApiSdkRb::WorkflowsApi* | [**create_workspace_workflow_from_preset_0**](docs/WorkflowsApi.md#create_workspace_workflow_from_preset_0) | **POST** /workspaces/{workspaceId}/workflows/from-preset | Start a Workflow from a starting point
|
|
407
|
+
*ApiSdkRb::WorkflowsApi* | [**delete_workspace_workflow_0**](docs/WorkflowsApi.md#delete_workspace_workflow_0) | **DELETE** /workspaces/{workspaceId}/workflows/{workflowId} | Delete a Workflow
|
|
408
|
+
*ApiSdkRb::WorkflowsApi* | [**discard_workspace_workflow_changes_0**](docs/WorkflowsApi.md#discard_workspace_workflow_changes_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/discard | Discard the Unpublished Changes of a Workflow
|
|
409
|
+
*ApiSdkRb::WorkflowsApi* | [**duplicate_workspace_workflow_0**](docs/WorkflowsApi.md#duplicate_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/duplicate | Duplicate a Workflow
|
|
410
|
+
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_0**](docs/WorkflowsApi.md#get_workspace_workflow_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow
|
|
411
|
+
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_stats_0**](docs/WorkflowsApi.md#get_workspace_workflow_stats_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow
|
|
412
|
+
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_version_0**](docs/WorkflowsApi.md#get_workspace_workflow_version_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow
|
|
413
|
+
*ApiSdkRb::WorkflowsApi* | [**list_partner_workflow_presets_1**](docs/WorkflowsApi.md#list_partner_workflow_presets_1) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start
|
|
414
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_composition_options_0**](docs/WorkflowsApi.md#list_workspace_workflow_composition_options_0) | **GET** /workspaces/{workspaceId}/workflows/composition-options | List the compositions a workflow can show, and what each can do
|
|
415
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_presets_0**](docs/WorkflowsApi.md#list_workspace_workflow_presets_0) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow
|
|
416
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_versions_0**](docs/WorkflowsApi.md#list_workspace_workflow_versions_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow
|
|
417
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflows_0**](docs/WorkflowsApi.md#list_workspace_workflows_0) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace
|
|
418
|
+
*ApiSdkRb::WorkflowsApi* | [**pause_workspace_workflow_0**](docs/WorkflowsApi.md#pause_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow
|
|
419
|
+
*ApiSdkRb::WorkflowsApi* | [**publish_workspace_workflow_0**](docs/WorkflowsApi.md#publish_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow
|
|
420
|
+
*ApiSdkRb::WorkflowsApi* | [**remove_partner_workflow_preset_1**](docs/WorkflowsApi.md#remove_partner_workflow_preset_1) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start
|
|
421
|
+
*ApiSdkRb::WorkflowsApi* | [**restore_workspace_workflow_version_0**](docs/WorkflowsApi.md#restore_workspace_workflow_version_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft
|
|
422
|
+
*ApiSdkRb::WorkflowsApi* | [**resume_workspace_workflow_0**](docs/WorkflowsApi.md#resume_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow
|
|
423
|
+
*ApiSdkRb::WorkflowsApi* | [**save_workspace_workflow_0**](docs/WorkflowsApi.md#save_workspace_workflow_0) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow
|
|
424
|
+
*ApiSdkRb::WorkflowsApi* | [**set_partner_workflow_preset_1**](docs/WorkflowsApi.md#set_partner_workflow_preset_1) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers
|
|
425
|
+
*ApiSdkRb::WorkflowsApi* | [**unarchive_workspace_workflow_0**](docs/WorkflowsApi.md#unarchive_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow
|
|
426
|
+
*ApiSdkRb::WorkspacesApi* | [**archive_workspace_workflow_1**](docs/WorkspacesApi.md#archive_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/archive | Archive a Workflow
|
|
427
|
+
*ApiSdkRb::WorkspacesApi* | [**create_workspace_workflow_1**](docs/WorkspacesApi.md#create_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows | Create a Workflow
|
|
428
|
+
*ApiSdkRb::WorkspacesApi* | [**create_workspace_workflow_from_preset_1**](docs/WorkspacesApi.md#create_workspace_workflow_from_preset_1) | **POST** /workspaces/{workspaceId}/workflows/from-preset | Start a Workflow from a starting point
|
|
429
|
+
*ApiSdkRb::WorkspacesApi* | [**delete_workspace_workflow_1**](docs/WorkspacesApi.md#delete_workspace_workflow_1) | **DELETE** /workspaces/{workspaceId}/workflows/{workflowId} | Delete a Workflow
|
|
430
|
+
*ApiSdkRb::WorkspacesApi* | [**discard_workspace_workflow_changes_1**](docs/WorkspacesApi.md#discard_workspace_workflow_changes_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/discard | Discard the Unpublished Changes of a Workflow
|
|
431
|
+
*ApiSdkRb::WorkspacesApi* | [**duplicate_workspace_workflow_1**](docs/WorkspacesApi.md#duplicate_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/duplicate | Duplicate a Workflow
|
|
432
|
+
*ApiSdkRb::WorkspacesApi* | [**get_workspace_workflow_1**](docs/WorkspacesApi.md#get_workspace_workflow_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow
|
|
433
|
+
*ApiSdkRb::WorkspacesApi* | [**get_workspace_workflow_stats_1**](docs/WorkspacesApi.md#get_workspace_workflow_stats_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow
|
|
434
|
+
*ApiSdkRb::WorkspacesApi* | [**get_workspace_workflow_version_1**](docs/WorkspacesApi.md#get_workspace_workflow_version_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow
|
|
435
|
+
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflow_composition_options_1**](docs/WorkspacesApi.md#list_workspace_workflow_composition_options_1) | **GET** /workspaces/{workspaceId}/workflows/composition-options | List the compositions a workflow can show, and what each can do
|
|
436
|
+
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflow_presets_1**](docs/WorkspacesApi.md#list_workspace_workflow_presets_1) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow
|
|
437
|
+
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflow_versions_1**](docs/WorkspacesApi.md#list_workspace_workflow_versions_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow
|
|
438
|
+
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflows_1**](docs/WorkspacesApi.md#list_workspace_workflows_1) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace
|
|
439
|
+
*ApiSdkRb::WorkspacesApi* | [**pause_workspace_workflow_1**](docs/WorkspacesApi.md#pause_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow
|
|
440
|
+
*ApiSdkRb::WorkspacesApi* | [**publish_workspace_workflow_1**](docs/WorkspacesApi.md#publish_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow
|
|
441
|
+
*ApiSdkRb::WorkspacesApi* | [**restore_workspace_workflow_version_1**](docs/WorkspacesApi.md#restore_workspace_workflow_version_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft
|
|
442
|
+
*ApiSdkRb::WorkspacesApi* | [**resume_workspace_workflow_1**](docs/WorkspacesApi.md#resume_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow
|
|
443
|
+
*ApiSdkRb::WorkspacesApi* | [**save_workspace_workflow_1**](docs/WorkspacesApi.md#save_workspace_workflow_1) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow
|
|
444
|
+
*ApiSdkRb::WorkspacesApi* | [**unarchive_workspace_workflow_1**](docs/WorkspacesApi.md#unarchive_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow
|
|
347
445
|
|
|
348
446
|
|
|
349
447
|
## Documentation for Models
|
|
@@ -361,6 +459,16 @@ Class | Method | HTTP request | Description
|
|
|
361
459
|
- [ApiSdkRb::AiAnswersKnowledgeRemoval](docs/AiAnswersKnowledgeRemoval.md)
|
|
362
460
|
- [ApiSdkRb::AiAnswersKnowledgeTotals](docs/AiAnswersKnowledgeTotals.md)
|
|
363
461
|
- [ApiSdkRb::ApiKeyScope](docs/ApiKeyScope.md)
|
|
462
|
+
- [ApiSdkRb::BrandColor](docs/BrandColor.md)
|
|
463
|
+
- [ApiSdkRb::BrandFont](docs/BrandFont.md)
|
|
464
|
+
- [ApiSdkRb::BrandKitAssetView](docs/BrandKitAssetView.md)
|
|
465
|
+
- [ApiSdkRb::BrandKitFigmaSource](docs/BrandKitFigmaSource.md)
|
|
466
|
+
- [ApiSdkRb::BrandKitTokens](docs/BrandKitTokens.md)
|
|
467
|
+
- [ApiSdkRb::BrandKitTokensFonts](docs/BrandKitTokensFonts.md)
|
|
468
|
+
- [ApiSdkRb::BrandKitView](docs/BrandKitView.md)
|
|
469
|
+
- [ApiSdkRb::BrandKitViewOwner](docs/BrandKitViewOwner.md)
|
|
470
|
+
- [ApiSdkRb::BrandKitViewResponse](docs/BrandKitViewResponse.md)
|
|
471
|
+
- [ApiSdkRb::BrandSpacing](docs/BrandSpacing.md)
|
|
364
472
|
- [ApiSdkRb::Canvas](docs/Canvas.md)
|
|
365
473
|
- [ApiSdkRb::CanvasResponse](docs/CanvasResponse.md)
|
|
366
474
|
- [ApiSdkRb::CheckCompositionAccessResponse](docs/CheckCompositionAccessResponse.md)
|
|
@@ -382,8 +490,10 @@ Class | Method | HTTP request | Description
|
|
|
382
490
|
- [ApiSdkRb::CompositionEntryItemsPageSuccess](docs/CompositionEntryItemsPageSuccess.md)
|
|
383
491
|
- [ApiSdkRb::CompositionEntryTable](docs/CompositionEntryTable.md)
|
|
384
492
|
- [ApiSdkRb::CompositionEntryTally](docs/CompositionEntryTally.md)
|
|
493
|
+
- [ApiSdkRb::CompositionLastEditedBy](docs/CompositionLastEditedBy.md)
|
|
385
494
|
- [ApiSdkRb::CompositionResponse](docs/CompositionResponse.md)
|
|
386
495
|
- [ApiSdkRb::CompositionVersion](docs/CompositionVersion.md)
|
|
496
|
+
- [ApiSdkRb::ConfirmAdapterConnectionRequest](docs/ConfirmAdapterConnectionRequest.md)
|
|
387
497
|
- [ApiSdkRb::ContentCheckFinding](docs/ContentCheckFinding.md)
|
|
388
498
|
- [ApiSdkRb::ContentItemWriteResult](docs/ContentItemWriteResult.md)
|
|
389
499
|
- [ApiSdkRb::ContentItemWriteResultValidationResult](docs/ContentItemWriteResultValidationResult.md)
|
|
@@ -398,6 +508,9 @@ Class | Method | HTTP request | Description
|
|
|
398
508
|
- [ApiSdkRb::CreateUserApiKeyRequest](docs/CreateUserApiKeyRequest.md)
|
|
399
509
|
- [ApiSdkRb::CreateWidget201Response](docs/CreateWidget201Response.md)
|
|
400
510
|
- [ApiSdkRb::CreateWidget201ResponseData](docs/CreateWidget201ResponseData.md)
|
|
511
|
+
- [ApiSdkRb::CreateWorkspaceWorkflowFromPreset201Response](docs/CreateWorkspaceWorkflowFromPreset201Response.md)
|
|
512
|
+
- [ApiSdkRb::CreateWorkspaceWorkflowFromPresetRequest](docs/CreateWorkspaceWorkflowFromPresetRequest.md)
|
|
513
|
+
- [ApiSdkRb::CreateWorkspaceWorkflowRequest](docs/CreateWorkspaceWorkflowRequest.md)
|
|
401
514
|
- [ApiSdkRb::CreatedUserApiKey](docs/CreatedUserApiKey.md)
|
|
402
515
|
- [ApiSdkRb::CreatedUserApiKeyResponse](docs/CreatedUserApiKeyResponse.md)
|
|
403
516
|
- [ApiSdkRb::DeleteCompositionContentItemResponse](docs/DeleteCompositionContentItemResponse.md)
|
|
@@ -409,6 +522,7 @@ Class | Method | HTTP request | Description
|
|
|
409
522
|
- [ApiSdkRb::DeletePersonalWorkspaceDomainResponseData](docs/DeletePersonalWorkspaceDomainResponseData.md)
|
|
410
523
|
- [ApiSdkRb::DeleteUserApiKeyResponse](docs/DeleteUserApiKeyResponse.md)
|
|
411
524
|
- [ApiSdkRb::DeleteUserApiKeyResponseData](docs/DeleteUserApiKeyResponseData.md)
|
|
525
|
+
- [ApiSdkRb::DeleteWorkspaceWorkflow200Response](docs/DeleteWorkspaceWorkflow200Response.md)
|
|
412
526
|
- [ApiSdkRb::DesignDefaults](docs/DesignDefaults.md)
|
|
413
527
|
- [ApiSdkRb::DuplicateComposition202Response](docs/DuplicateComposition202Response.md)
|
|
414
528
|
- [ApiSdkRb::DuplicateComposition202ResponseData](docs/DuplicateComposition202ResponseData.md)
|
|
@@ -458,8 +572,13 @@ Class | Method | HTTP request | Description
|
|
|
458
572
|
- [ApiSdkRb::GetPartnerEntitlementsResponseData](docs/GetPartnerEntitlementsResponseData.md)
|
|
459
573
|
- [ApiSdkRb::GetPersonalWorkspaceDomains200Response](docs/GetPersonalWorkspaceDomains200Response.md)
|
|
460
574
|
- [ApiSdkRb::GetPublicCompositionEmbed200Response](docs/GetPublicCompositionEmbed200Response.md)
|
|
575
|
+
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseAdapters](docs/GetPublicCompositionEmbed200ResponseAdapters.md)
|
|
576
|
+
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseAdaptersCaptcha](docs/GetPublicCompositionEmbed200ResponseAdaptersCaptcha.md)
|
|
461
577
|
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseDataSource](docs/GetPublicCompositionEmbed200ResponseDataSource.md)
|
|
462
578
|
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseDirect](docs/GetPublicCompositionEmbed200ResponseDirect.md)
|
|
579
|
+
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseEntries](docs/GetPublicCompositionEmbed200ResponseEntries.md)
|
|
580
|
+
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseMedia](docs/GetPublicCompositionEmbed200ResponseMedia.md)
|
|
581
|
+
- [ApiSdkRb::GetPublicWorkflow200Response](docs/GetPublicWorkflow200Response.md)
|
|
463
582
|
- [ApiSdkRb::GetUserAdapterConnections200Response](docs/GetUserAdapterConnections200Response.md)
|
|
464
583
|
- [ApiSdkRb::GetUserApiKeyUsageLogsResponse](docs/GetUserApiKeyUsageLogsResponse.md)
|
|
465
584
|
- [ApiSdkRb::GetUserApiKeyUsageLogsResponseData](docs/GetUserApiKeyUsageLogsResponseData.md)
|
|
@@ -469,7 +588,14 @@ Class | Method | HTTP request | Description
|
|
|
469
588
|
- [ApiSdkRb::GetWidgetsBatchResponse](docs/GetWidgetsBatchResponse.md)
|
|
470
589
|
- [ApiSdkRb::GetWidgetsBatchResponseData](docs/GetWidgetsBatchResponseData.md)
|
|
471
590
|
- [ApiSdkRb::GetWidgetsBatchResponseDataErrorsInner](docs/GetWidgetsBatchResponseDataErrorsInner.md)
|
|
591
|
+
- [ApiSdkRb::GetWorkspaceWorkflowStats200Response](docs/GetWorkspaceWorkflowStats200Response.md)
|
|
592
|
+
- [ApiSdkRb::GetWorkspaceWorkflowVersion200Response](docs/GetWorkspaceWorkflowVersion200Response.md)
|
|
472
593
|
- [ApiSdkRb::ListPartnerPresets200Response](docs/ListPartnerPresets200Response.md)
|
|
594
|
+
- [ApiSdkRb::ListPartnerWorkflowPresets200Response](docs/ListPartnerWorkflowPresets200Response.md)
|
|
595
|
+
- [ApiSdkRb::ListWorkspaceWorkflowCompositionOptions200Response](docs/ListWorkspaceWorkflowCompositionOptions200Response.md)
|
|
596
|
+
- [ApiSdkRb::ListWorkspaceWorkflowPresets200Response](docs/ListWorkspaceWorkflowPresets200Response.md)
|
|
597
|
+
- [ApiSdkRb::ListWorkspaceWorkflowVersions200Response](docs/ListWorkspaceWorkflowVersions200Response.md)
|
|
598
|
+
- [ApiSdkRb::ListWorkspaceWorkflows200Response](docs/ListWorkspaceWorkflows200Response.md)
|
|
473
599
|
- [ApiSdkRb::ManagedUser](docs/ManagedUser.md)
|
|
474
600
|
- [ApiSdkRb::ManagedUserEntriesMeta](docs/ManagedUserEntriesMeta.md)
|
|
475
601
|
- [ApiSdkRb::ManagedUserEntriesPageSuccess](docs/ManagedUserEntriesPageSuccess.md)
|
|
@@ -488,6 +614,10 @@ Class | Method | HTTP request | Description
|
|
|
488
614
|
- [ApiSdkRb::NewEditorSession](docs/NewEditorSession.md)
|
|
489
615
|
- [ApiSdkRb::NewManagedUser](docs/NewManagedUser.md)
|
|
490
616
|
- [ApiSdkRb::NewWidget](docs/NewWidget.md)
|
|
617
|
+
- [ApiSdkRb::OfferWorkflowPresetRequest](docs/OfferWorkflowPresetRequest.md)
|
|
618
|
+
- [ApiSdkRb::OfferedWorkflowPreset](docs/OfferedWorkflowPreset.md)
|
|
619
|
+
- [ApiSdkRb::OfferedWorkflowPresetList](docs/OfferedWorkflowPresetList.md)
|
|
620
|
+
- [ApiSdkRb::OfferedWorkflowPresetWidget](docs/OfferedWorkflowPresetWidget.md)
|
|
491
621
|
- [ApiSdkRb::OperationsIdGetResponse](docs/OperationsIdGetResponse.md)
|
|
492
622
|
- [ApiSdkRb::OperationsIdGetResponseData](docs/OperationsIdGetResponseData.md)
|
|
493
623
|
- [ApiSdkRb::PartnerAnalyticsByManagedUser](docs/PartnerAnalyticsByManagedUser.md)
|
|
@@ -552,9 +682,14 @@ Class | Method | HTTP request | Description
|
|
|
552
682
|
- [ApiSdkRb::PartnerStorageUsageOfManagedUser](docs/PartnerStorageUsageOfManagedUser.md)
|
|
553
683
|
- [ApiSdkRb::PartnerStorageUsageResponse](docs/PartnerStorageUsageResponse.md)
|
|
554
684
|
- [ApiSdkRb::PartnerStorageUsageTotals](docs/PartnerStorageUsageTotals.md)
|
|
685
|
+
- [ApiSdkRb::PatchBrandKitAssetRequest](docs/PatchBrandKitAssetRequest.md)
|
|
686
|
+
- [ApiSdkRb::PatchBrandKitRequest](docs/PatchBrandKitRequest.md)
|
|
687
|
+
- [ApiSdkRb::PatchBrandKitRequestFonts](docs/PatchBrandKitRequestFonts.md)
|
|
688
|
+
- [ApiSdkRb::PatchBrandKitRequestSpacing](docs/PatchBrandKitRequestSpacing.md)
|
|
555
689
|
- [ApiSdkRb::PersonalWorkspaceDomain](docs/PersonalWorkspaceDomain.md)
|
|
556
690
|
- [ApiSdkRb::PersonalWorkspaceDomainResult](docs/PersonalWorkspaceDomainResult.md)
|
|
557
691
|
- [ApiSdkRb::PersonalWorkspaceDomainResultResponse](docs/PersonalWorkspaceDomainResultResponse.md)
|
|
692
|
+
- [ApiSdkRb::PostBrandKitIconRequest](docs/PostBrandKitIconRequest.md)
|
|
558
693
|
- [ApiSdkRb::PostPublicCompositionEmbedStatus200Response](docs/PostPublicCompositionEmbedStatus200Response.md)
|
|
559
694
|
- [ApiSdkRb::PostPublicCompositionEmbedStatus200ResponseData](docs/PostPublicCompositionEmbedStatus200ResponseData.md)
|
|
560
695
|
- [ApiSdkRb::PostPublicCompositionEmbedStatusRequest](docs/PostPublicCompositionEmbedStatusRequest.md)
|
|
@@ -571,13 +706,26 @@ Class | Method | HTTP request | Description
|
|
|
571
706
|
- [ApiSdkRb::PublicEmbedFailure](docs/PublicEmbedFailure.md)
|
|
572
707
|
- [ApiSdkRb::PublicEmbedFailureDetails](docs/PublicEmbedFailureDetails.md)
|
|
573
708
|
- [ApiSdkRb::PublicEmbedFailureError](docs/PublicEmbedFailureError.md)
|
|
709
|
+
- [ApiSdkRb::PublicWorkflow](docs/PublicWorkflow.md)
|
|
710
|
+
- [ApiSdkRb::PublicWorkflowEventsAccepted](docs/PublicWorkflowEventsAccepted.md)
|
|
711
|
+
- [ApiSdkRb::PublicWorkflowEventsRequest](docs/PublicWorkflowEventsRequest.md)
|
|
712
|
+
- [ApiSdkRb::PublicWorkflowEventsRequestEventsInner](docs/PublicWorkflowEventsRequestEventsInner.md)
|
|
713
|
+
- [ApiSdkRb::PublicWorkflowEventsRequestHeightsInner](docs/PublicWorkflowEventsRequestHeightsInner.md)
|
|
714
|
+
- [ApiSdkRb::PublicWorkflowTranslation](docs/PublicWorkflowTranslation.md)
|
|
715
|
+
- [ApiSdkRb::PublishWorkspaceWorkflow200Response](docs/PublishWorkspaceWorkflow200Response.md)
|
|
716
|
+
- [ApiSdkRb::PublishWorkspaceWorkflowRequest](docs/PublishWorkspaceWorkflowRequest.md)
|
|
574
717
|
- [ApiSdkRb::PurposeStorageBucket](docs/PurposeStorageBucket.md)
|
|
718
|
+
- [ApiSdkRb::PutBrandKitRequest](docs/PutBrandKitRequest.md)
|
|
575
719
|
- [ApiSdkRb::RemoveAiAnswersKnowledgeDocument200Response](docs/RemoveAiAnswersKnowledgeDocument200Response.md)
|
|
720
|
+
- [ApiSdkRb::RemovePartnerWorkflowPreset200Response](docs/RemovePartnerWorkflowPreset200Response.md)
|
|
576
721
|
- [ApiSdkRb::RemoveUserAdapterConnection200Response](docs/RemoveUserAdapterConnection200Response.md)
|
|
722
|
+
- [ApiSdkRb::ReportPublicWorkflowEvents200Response](docs/ReportPublicWorkflowEvents200Response.md)
|
|
577
723
|
- [ApiSdkRb::RequestExtraCredits](docs/RequestExtraCredits.md)
|
|
578
724
|
- [ApiSdkRb::ResponseMeta](docs/ResponseMeta.md)
|
|
579
725
|
- [ApiSdkRb::RevokeManagedUserEditorSessionsResponse](docs/RevokeManagedUserEditorSessionsResponse.md)
|
|
580
726
|
- [ApiSdkRb::RevokeManagedUserEditorSessionsResponseData](docs/RevokeManagedUserEditorSessionsResponseData.md)
|
|
727
|
+
- [ApiSdkRb::SaveWorkspaceWorkflow200Response](docs/SaveWorkspaceWorkflow200Response.md)
|
|
728
|
+
- [ApiSdkRb::SaveWorkspaceWorkflowRequest](docs/SaveWorkspaceWorkflowRequest.md)
|
|
581
729
|
- [ApiSdkRb::SetAdapterConnectionRequest](docs/SetAdapterConnectionRequest.md)
|
|
582
730
|
- [ApiSdkRb::SetCompositionDataSourceRequest](docs/SetCompositionDataSourceRequest.md)
|
|
583
731
|
- [ApiSdkRb::SetDynamicContentRequest](docs/SetDynamicContentRequest.md)
|
|
@@ -589,6 +737,7 @@ Class | Method | HTTP request | Description
|
|
|
589
737
|
- [ApiSdkRb::SetPartnerDesignDefaultsRequest](docs/SetPartnerDesignDefaultsRequest.md)
|
|
590
738
|
- [ApiSdkRb::SetPartnerPresetRequest](docs/SetPartnerPresetRequest.md)
|
|
591
739
|
- [ApiSdkRb::SetPartnerStorageDestinationRequest](docs/SetPartnerStorageDestinationRequest.md)
|
|
740
|
+
- [ApiSdkRb::SetPartnerWorkflowPreset200Response](docs/SetPartnerWorkflowPreset200Response.md)
|
|
592
741
|
- [ApiSdkRb::SetUserAdapterConnection200Response](docs/SetUserAdapterConnection200Response.md)
|
|
593
742
|
- [ApiSdkRb::SuccessResponse](docs/SuccessResponse.md)
|
|
594
743
|
- [ApiSdkRb::UpdateCanvasRequest](docs/UpdateCanvasRequest.md)
|
|
@@ -614,6 +763,40 @@ Class | Method | HTTP request | Description
|
|
|
614
763
|
- [ApiSdkRb::ValidateToken200Response](docs/ValidateToken200Response.md)
|
|
615
764
|
- [ApiSdkRb::ValidateToken200ResponseData](docs/ValidateToken200ResponseData.md)
|
|
616
765
|
- [ApiSdkRb::Widget](docs/Widget.md)
|
|
766
|
+
- [ApiSdkRb::Workflow](docs/Workflow.md)
|
|
767
|
+
- [ApiSdkRb::WorkflowCompositionAction](docs/WorkflowCompositionAction.md)
|
|
768
|
+
- [ApiSdkRb::WorkflowCompositionField](docs/WorkflowCompositionField.md)
|
|
769
|
+
- [ApiSdkRb::WorkflowCompositionOption](docs/WorkflowCompositionOption.md)
|
|
770
|
+
- [ApiSdkRb::WorkflowCompositionOptionActions](docs/WorkflowCompositionOptionActions.md)
|
|
771
|
+
- [ApiSdkRb::WorkflowCompositionOptionInputs](docs/WorkflowCompositionOptionInputs.md)
|
|
772
|
+
- [ApiSdkRb::WorkflowCompositionOptions](docs/WorkflowCompositionOptions.md)
|
|
773
|
+
- [ApiSdkRb::WorkflowConditionCase](docs/WorkflowConditionCase.md)
|
|
774
|
+
- [ApiSdkRb::WorkflowConditionTest](docs/WorkflowConditionTest.md)
|
|
775
|
+
- [ApiSdkRb::WorkflowCounter](docs/WorkflowCounter.md)
|
|
776
|
+
- [ApiSdkRb::WorkflowDetail](docs/WorkflowDetail.md)
|
|
777
|
+
- [ApiSdkRb::WorkflowDetailAllOfLastEditedBy](docs/WorkflowDetailAllOfLastEditedBy.md)
|
|
778
|
+
- [ApiSdkRb::WorkflowEdge](docs/WorkflowEdge.md)
|
|
779
|
+
- [ApiSdkRb::WorkflowFieldReference](docs/WorkflowFieldReference.md)
|
|
780
|
+
- [ApiSdkRb::WorkflowGraph](docs/WorkflowGraph.md)
|
|
781
|
+
- [ApiSdkRb::WorkflowIssue](docs/WorkflowIssue.md)
|
|
782
|
+
- [ApiSdkRb::WorkflowList](docs/WorkflowList.md)
|
|
783
|
+
- [ApiSdkRb::WorkflowNode](docs/WorkflowNode.md)
|
|
784
|
+
- [ApiSdkRb::WorkflowNodePosition](docs/WorkflowNodePosition.md)
|
|
785
|
+
- [ApiSdkRb::WorkflowPresetChoice](docs/WorkflowPresetChoice.md)
|
|
786
|
+
- [ApiSdkRb::WorkflowPresetChoices](docs/WorkflowPresetChoices.md)
|
|
787
|
+
- [ApiSdkRb::WorkflowPresetRemoval](docs/WorkflowPresetRemoval.md)
|
|
788
|
+
- [ApiSdkRb::WorkflowPresetWidget](docs/WorkflowPresetWidget.md)
|
|
789
|
+
- [ApiSdkRb::WorkflowPublishResult](docs/WorkflowPublishResult.md)
|
|
790
|
+
- [ApiSdkRb::WorkflowRemoved](docs/WorkflowRemoved.md)
|
|
791
|
+
- [ApiSdkRb::WorkflowSchedule](docs/WorkflowSchedule.md)
|
|
792
|
+
- [ApiSdkRb::WorkflowStats](docs/WorkflowStats.md)
|
|
793
|
+
- [ApiSdkRb::WorkflowStatus](docs/WorkflowStatus.md)
|
|
794
|
+
- [ApiSdkRb::WorkflowTrigger](docs/WorkflowTrigger.md)
|
|
795
|
+
- [ApiSdkRb::WorkflowTriggerValuesInner](docs/WorkflowTriggerValuesInner.md)
|
|
796
|
+
- [ApiSdkRb::WorkflowVersion](docs/WorkflowVersion.md)
|
|
797
|
+
- [ApiSdkRb::WorkflowVersionDetail](docs/WorkflowVersionDetail.md)
|
|
798
|
+
- [ApiSdkRb::WorkflowVersionList](docs/WorkflowVersionList.md)
|
|
799
|
+
- [ApiSdkRb::WorkflowVersionPublishedBy](docs/WorkflowVersionPublishedBy.md)
|
|
617
800
|
|
|
618
801
|
|
|
619
802
|
## Documentation for Authorization
|
data/docs/AdapterConnection.md
CHANGED
|
@@ -11,6 +11,9 @@
|
|
|
11
11
|
| **scope** | **String** | Who may keep this key. `owner` is the person who made the widget, in their own account. `partner` is a partner, for the widgets of the customers it manages. `owner_or_partner` is either; for a widget of a managed customer the partner's key is used. | |
|
|
12
12
|
| **connected** | **Boolean** | Whether this account has connected the key | |
|
|
13
13
|
| **updated_at** | **Time** | When the key was last set. Null when it is not connected | |
|
|
14
|
+
| **confirmation** | **String** | How this credential is proved before it is used. `email_code` means it is an email address: saving it emails a code to it, and it is used only after the code is given back (`confirmUserAdapterConnection`, `confirmPartnerAdapterConnection`). Null for a credential that is used as soon as it is saved | |
|
|
15
|
+
| **awaiting_confirmation** | **Boolean** | True when the credential is connected but has not been confirmed yet, so no adapter uses it. Always false when `confirmation` is null or the credential is not connected | |
|
|
16
|
+
| **confirmed_at** | **Time** | When the credential was confirmed. Null when it is not connected, is awaiting its code, or needs no confirmation | |
|
|
14
17
|
|
|
15
18
|
## Example
|
|
16
19
|
|
|
@@ -24,7 +27,10 @@ instance = ApiSdkRb::AdapterConnection.new(
|
|
|
24
27
|
label: Resend API key,
|
|
25
28
|
scope: null,
|
|
26
29
|
connected: null,
|
|
27
|
-
updated_at: null
|
|
30
|
+
updated_at: null,
|
|
31
|
+
confirmation: email_code,
|
|
32
|
+
awaiting_confirmation: null,
|
|
33
|
+
confirmed_at: null
|
|
28
34
|
)
|
|
29
35
|
```
|
|
30
36
|
|
data/docs/BrandColor.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::BrandColor
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | |
|
|
8
|
+
| **hex** | **String** | | |
|
|
9
|
+
| **role** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::BrandColor.new(
|
|
17
|
+
name: null,
|
|
18
|
+
hex: null,
|
|
19
|
+
role: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/BrandFont.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::BrandFont
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **family** | **String** | | |
|
|
8
|
+
| **source** | **String** | | |
|
|
9
|
+
| **weight** | **Integer** | | [optional] |
|
|
10
|
+
| **size_max** | **Integer** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::BrandFont.new(
|
|
18
|
+
family: null,
|
|
19
|
+
source: null,
|
|
20
|
+
weight: null,
|
|
21
|
+
size_max: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|