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
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::SaveWorkspaceWorkflowRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **revision** | **Integer** | The revision the editor read. | |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **timezone** | **String** | | [optional] |
|
|
10
|
+
| **graph** | [**WorkflowGraph**](WorkflowGraph.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::SaveWorkspaceWorkflowRequest.new(
|
|
18
|
+
revision: null,
|
|
19
|
+
name: null,
|
|
20
|
+
timezone: Europe/Bucharest,
|
|
21
|
+
graph: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **credential** | **String** | The key exactly as its provider gave it: one line of text, at most 2048 characters. It is stored encrypted and is never returned or logged. | |
|
|
7
|
+
| **credential** | **String** | The key exactly as its provider gave it: one line of text, at most 2048 characters. It is stored encrypted and is never returned or logged. For a credential that is an email address (`confirmation: email_code`), write that one address, with nothing else | |
|
|
8
8
|
|
|
9
9
|
## Example
|
|
10
10
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::SetPartnerWorkflowPreset200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **success** | **Boolean** | | |
|
|
8
|
+
| **data** | [**OfferedWorkflowPreset**](OfferedWorkflowPreset.md) | | |
|
|
9
|
+
| **meta** | [**ResponseMeta**](ResponseMeta.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::SetPartnerWorkflowPreset200Response.new(
|
|
17
|
+
success: true,
|
|
18
|
+
data: null,
|
|
19
|
+
meta: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/UpdateComposition.md
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
| **status** | **String** | Updated status | [optional] |
|
|
11
11
|
| **embed_settings** | **Object** | Updated embed settings | [optional] |
|
|
12
12
|
| **design** | **Object** | Updated design settings | [optional] |
|
|
13
|
-
| **database_schema** | **Object** | Tables to make for the composition, in the shape `createComposition` takes (`{ \"tables\": [ ... ] }`, with the same names, types, defaults and limits). Only the tables that are missing are made. A table that already exists is never changed or dropped: it keeps its columns, so a column added to the declaration is not added to it. A declaration that cannot be used is refused with `400` and `INVALID_DATABASE_SCHEMA`. When the composition is saved but its tables cannot be made just now, `meta.warnings` says so: send the same `databaseSchema` again to retry. | [optional] |
|
|
13
|
+
| **database_schema** | **Object** | Tables to make for the composition, in the shape `createComposition` takes (`{ \"tables\": [ ... ] }`, with the same names, types, defaults and limits). Only the tables that are missing are made. A table that already exists is never changed or dropped: it keeps its columns, so a column added to the declaration is not added to it. (Tables made from the widget's own file are the one exception, brought up to date when the widget is published; see `source` on `createComposition`.) A declaration that cannot be used is refused with `400` and `INVALID_DATABASE_SCHEMA`. When the composition is saved but its tables cannot be made just now, `meta.warnings` says so: send the same `databaseSchema` again to retry. | [optional] |
|
|
14
14
|
| **project_id** | **String** | Updated project ID | [optional] |
|
|
15
15
|
|
|
16
16
|
## Example
|
data/docs/UsersApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
7
|
| [**add_personal_workspace_domain_0**](UsersApi.md#add_personal_workspace_domain_0) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets |
|
|
8
|
+
| [**confirm_user_adapter_connection_0**](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 |
|
|
8
9
|
| [**create_user_api_key_0**](UsersApi.md#create_user_api_key_0) | **POST** /users/{id}/keys | Create an API key |
|
|
9
10
|
| [**delete_personal_workspace_domain_0**](UsersApi.md#delete_personal_workspace_domain_0) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets |
|
|
10
11
|
| [**delete_user_api_key_0**](UsersApi.md#delete_user_api_key_0) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key |
|
|
@@ -89,6 +90,81 @@ end
|
|
|
89
90
|
- **Accept**: application/json
|
|
90
91
|
|
|
91
92
|
|
|
93
|
+
## confirm_user_adapter_connection_0
|
|
94
|
+
|
|
95
|
+
> <SetUserAdapterConnection200Response> confirm_user_adapter_connection_0(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
96
|
+
|
|
97
|
+
Confirm an adapter address with the code that was emailed to it
|
|
98
|
+
|
|
99
|
+
Some credentials are an email address Widgetic sends a widget's messages to (`confirmation: email_code` in `getUserAdapterConnections`). Saving one with `setUserAdapterConnection` emails a six-digit code to it; this gives the code back. Only then is the address used: until it is confirmed, the widgets that need it are not charged and their visitors are told the feature is unavailable. The code works for 30 minutes and for five wrong tries. After that, save the address again and a new code is emailed (not sooner than a minute after the last one). A code that is not made of digits is refused without counting as a try. Confirming an address that is already confirmed answers 200 with the same state, so a retry of a request that went through is harmless. Saving a different address, or the same one before it was confirmed, starts again. This needs an API key with full access. The caller must be the account itself or a Widgetic administrator.
|
|
100
|
+
|
|
101
|
+
### Examples
|
|
102
|
+
|
|
103
|
+
```ruby
|
|
104
|
+
require 'time'
|
|
105
|
+
require 'api-sdk-rb'
|
|
106
|
+
# setup authorization
|
|
107
|
+
ApiSdkRb.configure do |config|
|
|
108
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
109
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
api_instance = ApiSdkRb::UsersApi.new
|
|
113
|
+
user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account that keeps the address. For your own, your own user id
|
|
114
|
+
adapter_id = 'adapter_id_example' # String | The adapter the address is for
|
|
115
|
+
credential_key = 'credential_key_example' # String | The credential's name within the adapter
|
|
116
|
+
confirm_adapter_connection_request = ApiSdkRb::ConfirmAdapterConnectionRequest.new({code: '123456'}) # ConfirmAdapterConnectionRequest |
|
|
117
|
+
|
|
118
|
+
begin
|
|
119
|
+
# Confirm an adapter address with the code that was emailed to it
|
|
120
|
+
result = api_instance.confirm_user_adapter_connection_0(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
121
|
+
p result
|
|
122
|
+
rescue ApiSdkRb::ApiError => e
|
|
123
|
+
puts "Error when calling UsersApi->confirm_user_adapter_connection_0: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
#### Using the confirm_user_adapter_connection_0_with_http_info variant
|
|
128
|
+
|
|
129
|
+
This returns an Array which contains the response data, status code and headers.
|
|
130
|
+
|
|
131
|
+
> <Array(<SetUserAdapterConnection200Response>, Integer, Hash)> confirm_user_adapter_connection_0_with_http_info(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
132
|
+
|
|
133
|
+
```ruby
|
|
134
|
+
begin
|
|
135
|
+
# Confirm an adapter address with the code that was emailed to it
|
|
136
|
+
data, status_code, headers = api_instance.confirm_user_adapter_connection_0_with_http_info(user_id, adapter_id, credential_key, confirm_adapter_connection_request)
|
|
137
|
+
p status_code # => 2xx
|
|
138
|
+
p headers # => { ... }
|
|
139
|
+
p data # => <SetUserAdapterConnection200Response>
|
|
140
|
+
rescue ApiSdkRb::ApiError => e
|
|
141
|
+
puts "Error when calling UsersApi->confirm_user_adapter_connection_0_with_http_info: #{e}"
|
|
142
|
+
end
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Parameters
|
|
146
|
+
|
|
147
|
+
| Name | Type | Description | Notes |
|
|
148
|
+
| ---- | ---- | ----------- | ----- |
|
|
149
|
+
| **user_id** | **String** | The account that keeps the address. For your own, your own user id | |
|
|
150
|
+
| **adapter_id** | **String** | The adapter the address is for | |
|
|
151
|
+
| **credential_key** | **String** | The credential's name within the adapter | |
|
|
152
|
+
| **confirm_adapter_connection_request** | [**ConfirmAdapterConnectionRequest**](ConfirmAdapterConnectionRequest.md) | | |
|
|
153
|
+
|
|
154
|
+
### Return type
|
|
155
|
+
|
|
156
|
+
[**SetUserAdapterConnection200Response**](SetUserAdapterConnection200Response.md)
|
|
157
|
+
|
|
158
|
+
### Authorization
|
|
159
|
+
|
|
160
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
161
|
+
|
|
162
|
+
### HTTP request headers
|
|
163
|
+
|
|
164
|
+
- **Content-Type**: application/json
|
|
165
|
+
- **Accept**: application/json
|
|
166
|
+
|
|
167
|
+
|
|
92
168
|
## create_user_api_key_0
|
|
93
169
|
|
|
94
170
|
> <CreatedUserApiKeyResponse> create_user_api_key_0(id, idempotency_key, create_user_api_key_request)
|
|
@@ -665,7 +741,7 @@ end
|
|
|
665
741
|
|
|
666
742
|
Connect an adapter key to an account
|
|
667
743
|
|
|
668
|
-
Gives an adapter the key it needs to act through a service you have an account with, for the widgets you made. Take the `adapterId` and `credentialKey` from `getUserAdapterConnections`. Saving a key that is already connected replaces it. **What Widgetic does with it.** The key is stored encrypted, bound to this account, this adapter and this credential, so that a stored value cannot be moved to another. It is never returned, never logged and never shown to a visitor of a widget. A server of Widgetic opens it for the one call a widget makes through the adapter, uses it to call the provider on your behalf, and discards it. To cut that off, remove the key here, or revoke it with the provider. **What is checked.** That the adapter exists and takes this credential, that an owner may keep it (some are for a partner only) and that the text is one line of at most 2048 characters. Whether the provider accepts the key is not checked here: it shows the first time a widget uses it, and the widget tells its owner. A widget whose adapter has no key connected is not charged and does not run that adapter: its visitors are told the feature is unavailable, and the owner is told once a day what to
|
|
744
|
+
Gives an adapter the key it needs to act through a service you have an account with, for the widgets you made. Take the `adapterId` and `credentialKey` from `getUserAdapterConnections`. Saving a key that is already connected replaces it. **What Widgetic does with it.** The key is stored encrypted, bound to this account, this adapter and this credential, so that a stored value cannot be moved to another. It is never returned, never logged and never shown to a visitor of a widget. A server of Widgetic opens it for the one call a widget makes through the adapter, uses it to call the provider on your behalf, and discards it. To cut that off, remove the key here, or revoke it with the provider. **What is checked.** That the adapter exists and takes this credential, that an owner may keep it (some are for a partner only) and that the text is one line of at most 2048 characters. Whether the provider accepts the key is not checked here: it shows the first time a widget uses it, and the widget tells its owner. **An address that has to be confirmed.** Some credentials are not a key but the email address Widgetic sends a widget's messages to (`confirmation: email_code` in `getUserAdapterConnections`). Saving one checks that it is one email address and emails a six-digit code to it; the answer says `awaitingConfirmation: true`, and nothing is sent to the address until the code is given back with `confirmUserAdapterConnection`. Saving the same address again before it is confirmed emails a new code (not sooner than a minute after the last); saving the address that is already confirmed changes nothing. If the code cannot be emailed, nothing is saved. A widget whose adapter has no key connected, or whose address is not confirmed yet, is not charged and does not run that adapter: its visitors are told the feature is unavailable, and the owner is told once a day what to do. This needs an API key with full access. The caller must be the account itself or a Widgetic administrator. A retry is harmless: saving the same key twice only refreshes when it was set.
|
|
669
745
|
|
|
670
746
|
### Examples
|
|
671
747
|
|
data/docs/Widget.md
CHANGED
|
@@ -20,8 +20,7 @@
|
|
|
20
20
|
| **repo_id** | **String** | Repository identifier for source code. | [optional] |
|
|
21
21
|
| **database_id** | **String** | Legacy. The name of a Neon database that an earlier version made for this widget. A widget has no database now (what the visitors of a composition leave is kept in the tables of that composition), so widgets made now have none. | [optional] |
|
|
22
22
|
| **version** | **Float** | Version number of the widget. | [optional] |
|
|
23
|
-
| **
|
|
24
|
-
| **last_cpg_commit_sha** | **String** | Last Git commit SHA analyzed for code graph. | [optional] |
|
|
23
|
+
| **last_commit_sha** | **String** | Latest Git commit SHA of the widget's code repository. | [optional] |
|
|
25
24
|
| **organization_id** | **String** | Organization ID if created in an organization workspace. | [optional] |
|
|
26
25
|
| **project_folder** | **String** | Project folder reference for organization widgets. | [optional] |
|
|
27
26
|
| **workspace_type** | **String** | Workspace type when created. | [optional] |
|
|
@@ -49,8 +48,7 @@ instance = ApiSdkRb::Widget.new(
|
|
|
49
48
|
repo_id: user/chart-widget,
|
|
50
49
|
database_id: widget_3fa85f64_5717_4562_b3fc_2c963f66afa6,
|
|
51
50
|
version: 1,
|
|
52
|
-
|
|
53
|
-
last_cpg_commit_sha: a1b2c3d4e5f6g7h8i9j0,
|
|
51
|
+
last_commit_sha: a1b2c3d4e5f6g7h8i9j0,
|
|
54
52
|
organization_id: 5e2d3f4a-1b6c-4a1f-8b9c-3c2d4e5f6a7b,
|
|
55
53
|
project_folder: marketing/q4-launch,
|
|
56
54
|
workspace_type: personal,
|
data/docs/Workflow.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# ApiSdkRb::Workflow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **managed_user_id** | **String** | The customer of a partner (a managed user) this workflow was made for, or null when it is its workspace's own. A customer's editor session lists and opens only the workflows filed under that customer; the partner's own account sees every customer's and tells them apart by this. It is set when the workflow is made and never changes. | [optional] |
|
|
10
|
+
| **status** | [**WorkflowStatus**](WorkflowStatus.md) | | |
|
|
11
|
+
| **revision** | **Integer** | Rises by one with every save. A save, a publish, a discard and a restore each name the revision they started from. | |
|
|
12
|
+
| **unpublished_changes** | **Boolean** | Whether the draft differs from the live version. | |
|
|
13
|
+
| **composition_ids** | **Array<String>** | | |
|
|
14
|
+
| **block_count** | **Integer** | | |
|
|
15
|
+
| **timezone** | **String** | The zone date and time triggers are read in (stored as UTC). | |
|
|
16
|
+
| **runs_count** | **Integer** | Visitors who started the workflow, over its whole life. | |
|
|
17
|
+
| **live_version_id** | **String** | | [optional] |
|
|
18
|
+
| **created_at** | **Time** | | |
|
|
19
|
+
| **updated_at** | **Time** | | |
|
|
20
|
+
| **first_published_at** | **Time** | | [optional] |
|
|
21
|
+
| **last_published_at** | **Time** | | [optional] |
|
|
22
|
+
| **paused_at** | **Time** | | [optional] |
|
|
23
|
+
| **archived_at** | **Time** | | [optional] |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
```ruby
|
|
28
|
+
require 'api-sdk-rb'
|
|
29
|
+
|
|
30
|
+
instance = ApiSdkRb::Workflow.new(
|
|
31
|
+
id: null,
|
|
32
|
+
name: null,
|
|
33
|
+
managed_user_id: null,
|
|
34
|
+
status: null,
|
|
35
|
+
revision: null,
|
|
36
|
+
unpublished_changes: null,
|
|
37
|
+
composition_ids: null,
|
|
38
|
+
block_count: null,
|
|
39
|
+
timezone: null,
|
|
40
|
+
runs_count: null,
|
|
41
|
+
live_version_id: null,
|
|
42
|
+
created_at: null,
|
|
43
|
+
updated_at: null,
|
|
44
|
+
first_published_at: null,
|
|
45
|
+
last_published_at: null,
|
|
46
|
+
paused_at: null,
|
|
47
|
+
archived_at: null
|
|
48
|
+
)
|
|
49
|
+
```
|
|
50
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | What the trigger stores to say which action it waits for. It is the goal, and the element when the goal names one (clicks, or clicks@.buy-now). | |
|
|
8
|
+
| **metric** | **String** | The goal's metric (clicks, submissions or plays). | |
|
|
9
|
+
| **label** | **String** | | |
|
|
10
|
+
| **selector** | **String** | The element the goal is about, when it names one. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowCompositionAction.new(
|
|
18
|
+
id: null,
|
|
19
|
+
metric: null,
|
|
20
|
+
label: null,
|
|
21
|
+
selector: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionField
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **table** | **String** | | |
|
|
8
|
+
| **column** | **String** | | |
|
|
9
|
+
| **label** | **String** | | |
|
|
10
|
+
| **type** | **String** | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowCompositionField.new(
|
|
18
|
+
table: null,
|
|
19
|
+
column: null,
|
|
20
|
+
label: null,
|
|
21
|
+
type: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **thumbnail_url** | **String** | | [optional] |
|
|
10
|
+
| **published** | **Boolean** | Whether the composition can be shown at all (its widget has a published version). | |
|
|
11
|
+
| **allowed_websites** | **Array<String>** | The websites the composition may be embedded on; empty means anywhere. | |
|
|
12
|
+
| **inputs** | [**WorkflowCompositionOptionInputs**](WorkflowCompositionOptionInputs.md) | | |
|
|
13
|
+
| **actions** | [**WorkflowCompositionOptionActions**](WorkflowCompositionOptionActions.md) | | |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'api-sdk-rb'
|
|
19
|
+
|
|
20
|
+
instance = ApiSdkRb::WorkflowCompositionOption.new(
|
|
21
|
+
id: null,
|
|
22
|
+
name: null,
|
|
23
|
+
thumbnail_url: null,
|
|
24
|
+
published: null,
|
|
25
|
+
allowed_websites: null,
|
|
26
|
+
inputs: null,
|
|
27
|
+
actions: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionOptionActions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | | |
|
|
8
|
+
| **reason** | **String** | Why Action in the widget is not available. widget_reports_no_actions means the published widget declares no goals; widget_not_published means the widget has no published version. | [optional] |
|
|
9
|
+
| **items** | [**Array<WorkflowCompositionAction>**](WorkflowCompositionAction.md) | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WorkflowCompositionOptionActions.new(
|
|
17
|
+
enabled: null,
|
|
18
|
+
reason: null,
|
|
19
|
+
items: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionOptionInputs
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **enabled** | **Boolean** | | |
|
|
8
|
+
| **reason** | **String** | Why Input added is not available. widget_keeps_no_data means the composition declares no table a visitor's entries are written to; widget_not_published means the widget has no published version. | [optional] |
|
|
9
|
+
| **tables** | **Array<String>** | Every table a visitor's entries are written to, including one with no field a rule may read. | |
|
|
10
|
+
| **fields** | [**Array<WorkflowCompositionField>**](WorkflowCompositionField.md) | The columns of those tables a rule may read. Not offered are id and created_at, columns that are not text, a number or yes/no, and columns whose name says they hold a person's private details (an email, a phone number), because a value a rule reads is handed to the visitor's page. | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowCompositionOptionInputs.new(
|
|
18
|
+
enabled: null,
|
|
19
|
+
reason: null,
|
|
20
|
+
tables: null,
|
|
21
|
+
fields: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCompositionOptions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **items** | [**Array<WorkflowCompositionOption>**](WorkflowCompositionOption.md) | | |
|
|
8
|
+
| **total** | **Integer** | | |
|
|
9
|
+
| **limit** | **Integer** | | |
|
|
10
|
+
| **offset** | **Integer** | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowCompositionOptions.new(
|
|
18
|
+
items: null,
|
|
19
|
+
total: null,
|
|
20
|
+
limit: null,
|
|
21
|
+
offset: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowConditionCase
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The output port of the rule. `default` is reserved for the Default output. | |
|
|
8
|
+
| **label** | **String** | | [optional] |
|
|
9
|
+
| **match** | **String** | `all` - every comparison must hold; `any` - one is enough. | |
|
|
10
|
+
| **tests** | [**Array<WorkflowConditionTest>**](WorkflowConditionTest.md) | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowConditionCase.new(
|
|
18
|
+
id: null,
|
|
19
|
+
label: null,
|
|
20
|
+
match: null,
|
|
21
|
+
tests: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowConditionTest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | [**WorkflowFieldReference**](WorkflowFieldReference.md) | | |
|
|
8
|
+
| **operator** | **String** | Text fields take is, isNot, contains, doesNotContain, startsWith, endsWith, isEmpty and isNotEmpty. Number fields take is, isNot, greaterThan, atLeast, lessThan, atMost, isEmpty and isNotEmpty. Yes/no fields take is and isNot. | |
|
|
9
|
+
| **value** | **Object** | What the field is compared with; not used by isEmpty and isNotEmpty. A text for a text field, a number for a number field, true or false for a yes/no field. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WorkflowConditionTest.new(
|
|
17
|
+
field: null,
|
|
18
|
+
operator: null,
|
|
19
|
+
value: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowCounter
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The block or connection counted. | |
|
|
8
|
+
| **total** | **Integer** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'api-sdk-rb'
|
|
14
|
+
|
|
15
|
+
instance = ApiSdkRb::WorkflowCounter.new(
|
|
16
|
+
id: null,
|
|
17
|
+
total: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **managed_user_id** | **String** | The customer of a partner (a managed user) this workflow was made for, or null when it is its workspace's own. A customer's editor session lists and opens only the workflows filed under that customer; the partner's own account sees every customer's and tells them apart by this. It is set when the workflow is made and never changes. | [optional] |
|
|
10
|
+
| **status** | [**WorkflowStatus**](WorkflowStatus.md) | | |
|
|
11
|
+
| **revision** | **Integer** | Rises by one with every save. A save, a publish, a discard and a restore each name the revision they started from. | |
|
|
12
|
+
| **unpublished_changes** | **Boolean** | Whether the draft differs from the live version. | |
|
|
13
|
+
| **composition_ids** | **Array<String>** | | |
|
|
14
|
+
| **block_count** | **Integer** | | |
|
|
15
|
+
| **timezone** | **String** | The zone date and time triggers are read in (stored as UTC). | |
|
|
16
|
+
| **runs_count** | **Integer** | Visitors who started the workflow, over its whole life. | |
|
|
17
|
+
| **live_version_id** | **String** | | [optional] |
|
|
18
|
+
| **created_at** | **Time** | | |
|
|
19
|
+
| **updated_at** | **Time** | | |
|
|
20
|
+
| **first_published_at** | **Time** | | [optional] |
|
|
21
|
+
| **last_published_at** | **Time** | | [optional] |
|
|
22
|
+
| **paused_at** | **Time** | | [optional] |
|
|
23
|
+
| **archived_at** | **Time** | | [optional] |
|
|
24
|
+
| **graph** | [**WorkflowGraph**](WorkflowGraph.md) | | |
|
|
25
|
+
| **live_version** | [**WorkflowVersion**](WorkflowVersion.md) | The version visitors get, without its graph; null before the first publish. | [optional] |
|
|
26
|
+
| **ever_published** | **Boolean** | Whether it was ever published (it then has versions and counts, and visitors may have run it). | |
|
|
27
|
+
| **last_edited_by** | [**WorkflowDetailAllOfLastEditedBy**](WorkflowDetailAllOfLastEditedBy.md) | | [optional] |
|
|
28
|
+
| **last_edited_at** | **Time** | When that latest change was made. Present whenever `lastEditedBy` is. | [optional] |
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```ruby
|
|
33
|
+
require 'api-sdk-rb'
|
|
34
|
+
|
|
35
|
+
instance = ApiSdkRb::WorkflowDetail.new(
|
|
36
|
+
id: null,
|
|
37
|
+
name: null,
|
|
38
|
+
managed_user_id: null,
|
|
39
|
+
status: null,
|
|
40
|
+
revision: null,
|
|
41
|
+
unpublished_changes: null,
|
|
42
|
+
composition_ids: null,
|
|
43
|
+
block_count: null,
|
|
44
|
+
timezone: null,
|
|
45
|
+
runs_count: null,
|
|
46
|
+
live_version_id: null,
|
|
47
|
+
created_at: null,
|
|
48
|
+
updated_at: null,
|
|
49
|
+
first_published_at: null,
|
|
50
|
+
last_published_at: null,
|
|
51
|
+
paused_at: null,
|
|
52
|
+
archived_at: null,
|
|
53
|
+
graph: null,
|
|
54
|
+
live_version: null,
|
|
55
|
+
ever_published: null,
|
|
56
|
+
last_edited_by: null,
|
|
57
|
+
last_edited_at: null
|
|
58
|
+
)
|
|
59
|
+
```
|
|
60
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowDetailAllOfLastEditedBy
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The account that made the latest change | [optional] |
|
|
8
|
+
| **name** | **String** | The name on that account, or `null` when it has none or it could not be read just then. Never an email address. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'api-sdk-rb'
|
|
14
|
+
|
|
15
|
+
instance = ApiSdkRb::WorkflowDetailAllOfLastEditedBy.new(
|
|
16
|
+
id: null,
|
|
17
|
+
name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowEdge
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **source** | **String** | | |
|
|
9
|
+
| **source_port** | **String** | `out` for compositions and triggers; a rule's id, or `default`, for conditions. | |
|
|
10
|
+
| **target** | **String** | | |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'api-sdk-rb'
|
|
16
|
+
|
|
17
|
+
instance = ApiSdkRb::WorkflowEdge.new(
|
|
18
|
+
id: null,
|
|
19
|
+
source: null,
|
|
20
|
+
source_port: null,
|
|
21
|
+
target: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowFieldReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **kind** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **type** | **String** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WorkflowFieldReference.new(
|
|
17
|
+
kind: null,
|
|
18
|
+
name: null,
|
|
19
|
+
type: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowGraph
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **schema_version** | **Integer** | | |
|
|
8
|
+
| **nodes** | [**Array<WorkflowNode>**](WorkflowNode.md) | | |
|
|
9
|
+
| **edges** | [**Array<WorkflowEdge>**](WorkflowEdge.md) | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'api-sdk-rb'
|
|
15
|
+
|
|
16
|
+
instance = ApiSdkRb::WorkflowGraph.new(
|
|
17
|
+
schema_version: null,
|
|
18
|
+
nodes: null,
|
|
19
|
+
edges: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ApiSdkRb::WorkflowIssue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | | |
|
|
8
|
+
| **severity** | **String** | | |
|
|
9
|
+
| **node_id** | **String** | | [optional] |
|
|
10
|
+
| **edge_id** | **String** | | [optional] |
|
|
11
|
+
| **case_id** | **String** | | [optional] |
|
|
12
|
+
| **detail** | **String** | A short machine-readable detail such as a column or a table name. Never a sentence. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'api-sdk-rb'
|
|
18
|
+
|
|
19
|
+
instance = ApiSdkRb::WorkflowIssue.new(
|
|
20
|
+
code: trigger_no_target,
|
|
21
|
+
severity: null,
|
|
22
|
+
node_id: null,
|
|
23
|
+
edge_id: null,
|
|
24
|
+
case_id: null,
|
|
25
|
+
detail: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|