api-sdk-rb 1.11.111 → 1.11.133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +207 -381
- data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
- data/docs/{GetUserAdapterConnections200Response.md → AdapterConnectionListResponse.md} +2 -2
- data/docs/{RemoveUserAdapterConnection200Response.md → AdapterConnectionRemovalResponse.md} +2 -2
- data/docs/{SetUserAdapterConnection200Response.md → AdapterConnectionResponse.md} +2 -2
- data/docs/{AddAiAnswersKnowledgeDocument201Response.md → AiAnswersKnowledgeDocumentResponse.md} +2 -2
- data/docs/BrandKitApi.md +74 -74
- data/docs/BrandKitTokens.md +2 -0
- data/docs/BrandKitView.md +1 -1
- data/docs/BrandTextStyle.md +22 -0
- data/docs/CanvasesApi.md +45 -45
- data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
- data/docs/CompositionsApi.md +615 -349
- data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
- data/docs/CreditsApi.md +20 -20
- data/docs/{CreateCompositionFromWidget201Response.md → DeleteUpload200Response.md} +3 -3
- data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
- data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
- data/docs/EntitlementsApi.md +18 -18
- data/docs/{OperationsIdGetResponse.md → GetOperationResponse.md} +3 -3
- data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
- data/docs/GetOperationResponseDataMetadata.md +24 -0
- data/docs/InvoicesApi.md +9 -9
- data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
- data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
- data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
- data/docs/ManagedUsersApi.md +261 -171
- data/docs/OperationsApi.md +11 -11
- data/docs/PartnersApi.md +388 -388
- data/docs/PatchBrandKitRequest.md +2 -0
- data/docs/PublicEmbedApi.md +95 -95
- data/docs/PublicWorkflowEventsRequestEventsInner.md +3 -1
- data/docs/{GetPublicWorkflow200Response.md → PublicWorkflowResponse.md} +2 -2
- data/docs/TokensApi.md +11 -9
- data/docs/Upload.md +1 -1
- data/docs/UploadLimits.md +3 -3
- data/docs/UploadsApi.md +85 -85
- data/docs/UsersApi.md +125 -125
- data/docs/WidgetClarification.md +22 -0
- data/docs/WidgetClarificationOption.md +22 -0
- data/docs/WidgetClarificationQuestion.md +26 -0
- data/docs/WidgetNextStep.md +24 -0
- data/docs/WidgetPlan.md +26 -0
- data/docs/WidgetPlanDecisions.md +32 -0
- data/docs/WidgetPlanDecisionsAdaptersInner.md +20 -0
- data/docs/WidgetPlanDecisionsLibrariesInner.md +22 -0
- data/docs/WidgetPlanDecisionsResponsive.md +22 -0
- data/docs/WidgetPlanTask.md +24 -0
- data/docs/WidgetsApi.md +38 -38
- data/docs/{CreateWorkspaceWorkflowFromPreset201Response.md → WorkflowDetailResponse.md} +2 -2
- data/docs/WorkflowFailureReason.md +15 -0
- data/docs/WorkflowFailureReasonCounter.md +22 -0
- data/docs/{SaveWorkspaceWorkflow200Response.md → WorkflowResponse.md} +2 -2
- data/docs/WorkflowStats.md +4 -2
- data/docs/WorkflowsApi.md +197 -413
- data/lib/api-sdk-rb/api/brand_kit_api.rb +61 -61
- data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
- data/lib/api-sdk-rb/api/compositions_api.rb +770 -441
- data/lib/api-sdk-rb/api/credits_api.rb +20 -20
- data/lib/api-sdk-rb/api/entitlements_api.rb +14 -14
- data/lib/api-sdk-rb/api/invoices_api.rb +10 -10
- data/lib/api-sdk-rb/api/managed_users_api.rb +278 -172
- data/lib/api-sdk-rb/api/operations_api.rb +10 -10
- data/lib/api-sdk-rb/api/partners_api.rb +389 -389
- data/lib/api-sdk-rb/api/public_embed_api.rb +95 -95
- data/lib/api-sdk-rb/api/tokens_api.rb +8 -6
- data/lib/api-sdk-rb/api/uploads_api.rb +96 -96
- data/lib/api-sdk-rb/api/users_api.rb +132 -132
- data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
- data/lib/api-sdk-rb/api/workflows_api.rb +246 -468
- data/lib/api-sdk-rb/configuration.rb +0 -60
- data/lib/api-sdk-rb/models/{get_user_adapter_connections200_response.rb → account_credit_transaction_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{get_partner_credit_transactions200_response.rb → adapter_connection_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{save_workspace_workflow200_response.rb → adapter_connection_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → adapter_connection_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → ai_answers_knowledge_document_response.rb} +3 -3
- data/lib/api-sdk-rb/models/brand_kit_tokens.rb +33 -2
- data/lib/api-sdk-rb/models/brand_kit_view.rb +1 -1
- data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
- data/lib/api-sdk-rb/models/{create_composition_database_record201_response.rb → composition_database_record_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → content_item_write_result_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{operations_id_get_response.rb → delete_upload200_response.rb} +4 -5
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response_data.rb → delete_upload200_response_data.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → design_defaults_response.rb} +3 -3
- data/lib/api-sdk-rb/models/get_operation_response.rb +247 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response_data.rb → get_operation_response_data.rb} +5 -8
- data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb +283 -0
- data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +32 -1
- data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +26 -4
- data/lib/api-sdk-rb/models/{get_public_workflow200_response.rb → public_workflow_response.rb} +3 -3
- data/lib/api-sdk-rb/models/upload.rb +1 -1
- data/lib/api-sdk-rb/models/upload_limits.rb +3 -3
- data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
- data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → widget_clarification_option.rb} +40 -30
- data/lib/api-sdk-rb/models/widget_clarification_question.rb +329 -0
- data/lib/api-sdk-rb/models/widget_next_step.rb +307 -0
- data/lib/api-sdk-rb/models/widget_plan.rb +306 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions.rb +346 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_adapters_inner.rb +237 -0
- data/lib/api-sdk-rb/models/{create_workspace_workflow_from_preset201_response.rb → widget_plan_decisions_libraries_inner.rb} +39 -30
- data/lib/api-sdk-rb/models/widget_plan_decisions_responsive.rb +311 -0
- data/lib/api-sdk-rb/models/widget_plan_task.rb +320 -0
- data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → workflow_detail_response.rb} +4 -4
- data/lib/api-sdk-rb/models/workflow_failure_reason.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason_counter.rb +277 -0
- data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +17 -5
- data/lib/api-sdk-rb/version.rb +1 -1
- data/lib/api-sdk-rb.rb +32 -21
- data/spec/api/brand_kit_api_spec.rb +18 -18
- data/spec/api/canvases_api_spec.rb +10 -10
- data/spec/api/compositions_api_spec.rb +144 -83
- data/spec/api/credits_api_spec.rb +5 -5
- data/spec/api/entitlements_api_spec.rb +4 -4
- data/spec/api/invoices_api_spec.rb +2 -2
- data/spec/api/managed_users_api_spec.rb +63 -42
- data/spec/api/operations_api_spec.rb +3 -3
- data/spec/api/partners_api_spec.rb +91 -91
- data/spec/api/public_embed_api_spec.rb +23 -23
- data/spec/api/tokens_api_spec.rb +3 -2
- data/spec/api/uploads_api_spec.rb +24 -24
- data/spec/api/users_api_spec.rb +30 -30
- data/spec/api/widgets_api_spec.rb +9 -9
- data/spec/api/workflows_api_spec.rb +50 -89
- data/spec/models/{get_user_adapter_connections200_response_spec.rb → account_credit_transaction_list_response_spec.rb} +6 -6
- data/spec/models/{get_public_workflow200_response_spec.rb → adapter_connection_list_response_spec.rb} +6 -6
- data/spec/models/{save_workspace_workflow200_response_spec.rb → adapter_connection_removal_response_spec.rb} +6 -6
- data/spec/models/{delete_managed_user200_response_spec.rb → adapter_connection_response_spec.rb} +6 -6
- data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
- data/spec/models/brand_kit_tokens_spec.rb +6 -0
- data/spec/models/{create_composition_from_widget201_response_spec.rb → brand_text_style_spec.rb} +13 -9
- data/spec/models/{get_managed_user_limits200_response_spec.rb → composition_database_record_response_spec.rb} +6 -6
- data/spec/models/content_item_write_result_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_data_spec.rb → delete_upload200_response_data_spec.rb} +6 -6
- data/spec/models/{operations_id_get_response_spec.rb → delete_upload200_response_spec.rb} +6 -6
- data/spec/models/design_defaults_response_spec.rb +48 -0
- data/spec/models/get_operation_response_data_metadata_spec.rb +58 -0
- data/spec/models/{operations_id_get_response_data_spec.rb → get_operation_response_data_spec.rb} +6 -6
- data/spec/models/{uploads_get200_response_spec.rb → get_operation_response_spec.rb} +6 -6
- data/spec/models/list_uploads200_response_spec.rb +48 -0
- data/spec/models/managed_user_limits_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_spec.rb → managed_user_removal_response_spec.rb} +6 -6
- data/spec/models/patch_brand_kit_request_spec.rb +6 -0
- data/spec/models/public_workflow_events_request_events_inner_spec.rb +10 -0
- data/spec/models/public_workflow_response_spec.rb +48 -0
- data/spec/models/widget_clarification_option_spec.rb +48 -0
- data/spec/models/widget_clarification_question_spec.rb +60 -0
- data/spec/models/widget_clarification_spec.rb +48 -0
- data/spec/models/widget_next_step_spec.rb +58 -0
- data/spec/models/widget_plan_decisions_adapters_inner_spec.rb +42 -0
- data/spec/models/widget_plan_decisions_libraries_inner_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_responsive_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_spec.rb +78 -0
- data/spec/models/{create_composition_database_record201_response_spec.rb → widget_plan_spec.rb} +21 -9
- data/spec/models/widget_plan_task_spec.rb +62 -0
- data/spec/models/workflow_detail_response_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_counter_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_spec.rb +30 -0
- data/spec/models/workflow_response_spec.rb +48 -0
- data/spec/models/workflow_stats_spec.rb +6 -0
- metadata +130 -86
- data/docs/PartnerApi.md +0 -12714
- data/docs/UploadsIdDelete200Response.md +0 -22
- data/docs/WorkspacesApi.md +0 -1527
- data/lib/api-sdk-rb/api/partner_api.rb +0 -13791
- data/lib/api-sdk-rb/api/workspaces_api.rb +0 -1775
- data/lib/api-sdk-rb/models/remove_user_adapter_connection200_response.rb +0 -246
- data/spec/api/partner_api_spec.rb +0 -2437
- data/spec/api/workspaces_api_spec.rb +0 -339
- data/spec/models/add_ai_answers_knowledge_document201_response_spec.rb +0 -48
- data/spec/models/create_composition_content_item201_response_spec.rb +0 -48
- data/spec/models/create_workspace_workflow_from_preset201_response_spec.rb +0 -48
- data/spec/models/get_partner_credit_transactions200_response_spec.rb +0 -48
- data/spec/models/get_partner_design_defaults200_response_spec.rb +0 -48
- data/spec/models/remove_user_adapter_connection200_response_spec.rb +0 -48
- data/spec/models/set_user_adapter_connection200_response_spec.rb +0 -48
data/docs/WorkflowsApi.md
CHANGED
|
@@ -4,33 +4,30 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
15
|
-
| [**
|
|
16
|
-
| [**
|
|
17
|
-
| [**
|
|
18
|
-
| [**
|
|
19
|
-
| [**
|
|
20
|
-
| [**
|
|
21
|
-
| [**
|
|
22
|
-
| [**
|
|
23
|
-
| [**
|
|
24
|
-
| [**
|
|
25
|
-
| [**
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
## archive_workspace_workflow_0
|
|
32
|
-
|
|
33
|
-
> <SaveWorkspaceWorkflow200Response> archive_workspace_workflow_0(workspace_id, workflow_id, opts)
|
|
7
|
+
| [**archive_workspace_workflow**](WorkflowsApi.md#archive_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/archive | Archive a Workflow |
|
|
8
|
+
| [**create_workspace_workflow**](WorkflowsApi.md#create_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows | Create a Workflow |
|
|
9
|
+
| [**create_workspace_workflow_from_preset**](WorkflowsApi.md#create_workspace_workflow_from_preset) | **POST** /workspaces/{workspaceId}/workflows/from-preset | Start a Workflow from a starting point |
|
|
10
|
+
| [**delete_workspace_workflow**](WorkflowsApi.md#delete_workspace_workflow) | **DELETE** /workspaces/{workspaceId}/workflows/{workflowId} | Delete a Workflow |
|
|
11
|
+
| [**discard_workspace_workflow_changes**](WorkflowsApi.md#discard_workspace_workflow_changes) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/discard | Discard the Unpublished Changes of a Workflow |
|
|
12
|
+
| [**duplicate_workspace_workflow**](WorkflowsApi.md#duplicate_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/duplicate | Duplicate a Workflow |
|
|
13
|
+
| [**get_workspace_workflow**](WorkflowsApi.md#get_workspace_workflow) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow |
|
|
14
|
+
| [**get_workspace_workflow_stats**](WorkflowsApi.md#get_workspace_workflow_stats) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow |
|
|
15
|
+
| [**get_workspace_workflow_version**](WorkflowsApi.md#get_workspace_workflow_version) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow |
|
|
16
|
+
| [**list_workspace_workflow_composition_options**](WorkflowsApi.md#list_workspace_workflow_composition_options) | **GET** /workspaces/{workspaceId}/workflows/composition-options | List the compositions a workflow can show, and what each can do |
|
|
17
|
+
| [**list_workspace_workflow_presets**](WorkflowsApi.md#list_workspace_workflow_presets) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow |
|
|
18
|
+
| [**list_workspace_workflow_versions**](WorkflowsApi.md#list_workspace_workflow_versions) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow |
|
|
19
|
+
| [**list_workspace_workflows**](WorkflowsApi.md#list_workspace_workflows) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace |
|
|
20
|
+
| [**pause_workspace_workflow**](WorkflowsApi.md#pause_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow |
|
|
21
|
+
| [**publish_workspace_workflow**](WorkflowsApi.md#publish_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow |
|
|
22
|
+
| [**restore_workspace_workflow_version**](WorkflowsApi.md#restore_workspace_workflow_version) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft |
|
|
23
|
+
| [**resume_workspace_workflow**](WorkflowsApi.md#resume_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow |
|
|
24
|
+
| [**save_workspace_workflow**](WorkflowsApi.md#save_workspace_workflow) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow |
|
|
25
|
+
| [**unarchive_workspace_workflow**](WorkflowsApi.md#unarchive_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow |
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
## archive_workspace_workflow
|
|
29
|
+
|
|
30
|
+
> <WorkflowResponse> archive_workspace_workflow(workspace_id, workflow_id, opts)
|
|
34
31
|
|
|
35
32
|
Archive a Workflow
|
|
36
33
|
|
|
@@ -57,28 +54,28 @@ opts = {
|
|
|
57
54
|
|
|
58
55
|
begin
|
|
59
56
|
# Archive a Workflow
|
|
60
|
-
result = api_instance.
|
|
57
|
+
result = api_instance.archive_workspace_workflow(workspace_id, workflow_id, opts)
|
|
61
58
|
p result
|
|
62
59
|
rescue ApiSdkRb::ApiError => e
|
|
63
|
-
puts "Error when calling WorkflowsApi->
|
|
60
|
+
puts "Error when calling WorkflowsApi->archive_workspace_workflow: #{e}"
|
|
64
61
|
end
|
|
65
62
|
```
|
|
66
63
|
|
|
67
|
-
#### Using the
|
|
64
|
+
#### Using the archive_workspace_workflow_with_http_info variant
|
|
68
65
|
|
|
69
66
|
This returns an Array which contains the response data, status code and headers.
|
|
70
67
|
|
|
71
|
-
> <Array(<
|
|
68
|
+
> <Array(<WorkflowResponse>, Integer, Hash)> archive_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
72
69
|
|
|
73
70
|
```ruby
|
|
74
71
|
begin
|
|
75
72
|
# Archive a Workflow
|
|
76
|
-
data, status_code, headers = api_instance.
|
|
73
|
+
data, status_code, headers = api_instance.archive_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
77
74
|
p status_code # => 2xx
|
|
78
75
|
p headers # => { ... }
|
|
79
|
-
p data # => <
|
|
76
|
+
p data # => <WorkflowResponse>
|
|
80
77
|
rescue ApiSdkRb::ApiError => e
|
|
81
|
-
puts "Error when calling WorkflowsApi->
|
|
78
|
+
puts "Error when calling WorkflowsApi->archive_workspace_workflow_with_http_info: #{e}"
|
|
82
79
|
end
|
|
83
80
|
```
|
|
84
81
|
|
|
@@ -93,7 +90,7 @@ end
|
|
|
93
90
|
|
|
94
91
|
### Return type
|
|
95
92
|
|
|
96
|
-
[**
|
|
93
|
+
[**WorkflowResponse**](WorkflowResponse.md)
|
|
97
94
|
|
|
98
95
|
### Authorization
|
|
99
96
|
|
|
@@ -105,9 +102,9 @@ end
|
|
|
105
102
|
- **Accept**: application/json
|
|
106
103
|
|
|
107
104
|
|
|
108
|
-
##
|
|
105
|
+
## create_workspace_workflow
|
|
109
106
|
|
|
110
|
-
> <
|
|
107
|
+
> <WorkflowDetailResponse> create_workspace_workflow(workspace_id, idempotency_key, create_workspace_workflow_request, opts)
|
|
111
108
|
|
|
112
109
|
Create a Workflow
|
|
113
110
|
|
|
@@ -135,28 +132,28 @@ opts = {
|
|
|
135
132
|
|
|
136
133
|
begin
|
|
137
134
|
# Create a Workflow
|
|
138
|
-
result = api_instance.
|
|
135
|
+
result = api_instance.create_workspace_workflow(workspace_id, idempotency_key, create_workspace_workflow_request, opts)
|
|
139
136
|
p result
|
|
140
137
|
rescue ApiSdkRb::ApiError => e
|
|
141
|
-
puts "Error when calling WorkflowsApi->
|
|
138
|
+
puts "Error when calling WorkflowsApi->create_workspace_workflow: #{e}"
|
|
142
139
|
end
|
|
143
140
|
```
|
|
144
141
|
|
|
145
|
-
#### Using the
|
|
142
|
+
#### Using the create_workspace_workflow_with_http_info variant
|
|
146
143
|
|
|
147
144
|
This returns an Array which contains the response data, status code and headers.
|
|
148
145
|
|
|
149
|
-
> <Array(<
|
|
146
|
+
> <Array(<WorkflowDetailResponse>, Integer, Hash)> create_workspace_workflow_with_http_info(workspace_id, idempotency_key, create_workspace_workflow_request, opts)
|
|
150
147
|
|
|
151
148
|
```ruby
|
|
152
149
|
begin
|
|
153
150
|
# Create a Workflow
|
|
154
|
-
data, status_code, headers = api_instance.
|
|
151
|
+
data, status_code, headers = api_instance.create_workspace_workflow_with_http_info(workspace_id, idempotency_key, create_workspace_workflow_request, opts)
|
|
155
152
|
p status_code # => 2xx
|
|
156
153
|
p headers # => { ... }
|
|
157
|
-
p data # => <
|
|
154
|
+
p data # => <WorkflowDetailResponse>
|
|
158
155
|
rescue ApiSdkRb::ApiError => e
|
|
159
|
-
puts "Error when calling WorkflowsApi->
|
|
156
|
+
puts "Error when calling WorkflowsApi->create_workspace_workflow_with_http_info: #{e}"
|
|
160
157
|
end
|
|
161
158
|
```
|
|
162
159
|
|
|
@@ -172,7 +169,7 @@ end
|
|
|
172
169
|
|
|
173
170
|
### Return type
|
|
174
171
|
|
|
175
|
-
[**
|
|
172
|
+
[**WorkflowDetailResponse**](WorkflowDetailResponse.md)
|
|
176
173
|
|
|
177
174
|
### Authorization
|
|
178
175
|
|
|
@@ -184,9 +181,9 @@ end
|
|
|
184
181
|
- **Accept**: application/json
|
|
185
182
|
|
|
186
183
|
|
|
187
|
-
##
|
|
184
|
+
## create_workspace_workflow_from_preset
|
|
188
185
|
|
|
189
|
-
> <
|
|
186
|
+
> <WorkflowDetailResponse> create_workspace_workflow_from_preset(workspace_id, idempotency_key, create_workspace_workflow_from_preset_request, opts)
|
|
190
187
|
|
|
191
188
|
Start a Workflow from a starting point
|
|
192
189
|
|
|
@@ -214,28 +211,28 @@ opts = {
|
|
|
214
211
|
|
|
215
212
|
begin
|
|
216
213
|
# Start a Workflow from a starting point
|
|
217
|
-
result = api_instance.
|
|
214
|
+
result = api_instance.create_workspace_workflow_from_preset(workspace_id, idempotency_key, create_workspace_workflow_from_preset_request, opts)
|
|
218
215
|
p result
|
|
219
216
|
rescue ApiSdkRb::ApiError => e
|
|
220
|
-
puts "Error when calling WorkflowsApi->
|
|
217
|
+
puts "Error when calling WorkflowsApi->create_workspace_workflow_from_preset: #{e}"
|
|
221
218
|
end
|
|
222
219
|
```
|
|
223
220
|
|
|
224
|
-
#### Using the
|
|
221
|
+
#### Using the create_workspace_workflow_from_preset_with_http_info variant
|
|
225
222
|
|
|
226
223
|
This returns an Array which contains the response data, status code and headers.
|
|
227
224
|
|
|
228
|
-
> <Array(<
|
|
225
|
+
> <Array(<WorkflowDetailResponse>, Integer, Hash)> create_workspace_workflow_from_preset_with_http_info(workspace_id, idempotency_key, create_workspace_workflow_from_preset_request, opts)
|
|
229
226
|
|
|
230
227
|
```ruby
|
|
231
228
|
begin
|
|
232
229
|
# Start a Workflow from a starting point
|
|
233
|
-
data, status_code, headers = api_instance.
|
|
230
|
+
data, status_code, headers = api_instance.create_workspace_workflow_from_preset_with_http_info(workspace_id, idempotency_key, create_workspace_workflow_from_preset_request, opts)
|
|
234
231
|
p status_code # => 2xx
|
|
235
232
|
p headers # => { ... }
|
|
236
|
-
p data # => <
|
|
233
|
+
p data # => <WorkflowDetailResponse>
|
|
237
234
|
rescue ApiSdkRb::ApiError => e
|
|
238
|
-
puts "Error when calling WorkflowsApi->
|
|
235
|
+
puts "Error when calling WorkflowsApi->create_workspace_workflow_from_preset_with_http_info: #{e}"
|
|
239
236
|
end
|
|
240
237
|
```
|
|
241
238
|
|
|
@@ -251,7 +248,7 @@ end
|
|
|
251
248
|
|
|
252
249
|
### Return type
|
|
253
250
|
|
|
254
|
-
[**
|
|
251
|
+
[**WorkflowDetailResponse**](WorkflowDetailResponse.md)
|
|
255
252
|
|
|
256
253
|
### Authorization
|
|
257
254
|
|
|
@@ -263,9 +260,9 @@ end
|
|
|
263
260
|
- **Accept**: application/json
|
|
264
261
|
|
|
265
262
|
|
|
266
|
-
##
|
|
263
|
+
## delete_workspace_workflow
|
|
267
264
|
|
|
268
|
-
> <DeleteWorkspaceWorkflow200Response>
|
|
265
|
+
> <DeleteWorkspaceWorkflow200Response> delete_workspace_workflow(workspace_id, workflow_id, opts)
|
|
269
266
|
|
|
270
267
|
Delete a Workflow
|
|
271
268
|
|
|
@@ -292,28 +289,28 @@ opts = {
|
|
|
292
289
|
|
|
293
290
|
begin
|
|
294
291
|
# Delete a Workflow
|
|
295
|
-
result = api_instance.
|
|
292
|
+
result = api_instance.delete_workspace_workflow(workspace_id, workflow_id, opts)
|
|
296
293
|
p result
|
|
297
294
|
rescue ApiSdkRb::ApiError => e
|
|
298
|
-
puts "Error when calling WorkflowsApi->
|
|
295
|
+
puts "Error when calling WorkflowsApi->delete_workspace_workflow: #{e}"
|
|
299
296
|
end
|
|
300
297
|
```
|
|
301
298
|
|
|
302
|
-
#### Using the
|
|
299
|
+
#### Using the delete_workspace_workflow_with_http_info variant
|
|
303
300
|
|
|
304
301
|
This returns an Array which contains the response data, status code and headers.
|
|
305
302
|
|
|
306
|
-
> <Array(<DeleteWorkspaceWorkflow200Response>, Integer, Hash)>
|
|
303
|
+
> <Array(<DeleteWorkspaceWorkflow200Response>, Integer, Hash)> delete_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
307
304
|
|
|
308
305
|
```ruby
|
|
309
306
|
begin
|
|
310
307
|
# Delete a Workflow
|
|
311
|
-
data, status_code, headers = api_instance.
|
|
308
|
+
data, status_code, headers = api_instance.delete_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
312
309
|
p status_code # => 2xx
|
|
313
310
|
p headers # => { ... }
|
|
314
311
|
p data # => <DeleteWorkspaceWorkflow200Response>
|
|
315
312
|
rescue ApiSdkRb::ApiError => e
|
|
316
|
-
puts "Error when calling WorkflowsApi->
|
|
313
|
+
puts "Error when calling WorkflowsApi->delete_workspace_workflow_with_http_info: #{e}"
|
|
317
314
|
end
|
|
318
315
|
```
|
|
319
316
|
|
|
@@ -340,9 +337,9 @@ end
|
|
|
340
337
|
- **Accept**: application/json
|
|
341
338
|
|
|
342
339
|
|
|
343
|
-
##
|
|
340
|
+
## discard_workspace_workflow_changes
|
|
344
341
|
|
|
345
|
-
> <
|
|
342
|
+
> <WorkflowDetailResponse> discard_workspace_workflow_changes(workspace_id, workflow_id, publish_workspace_workflow_request, opts)
|
|
346
343
|
|
|
347
344
|
Discard the Unpublished Changes of a Workflow
|
|
348
345
|
|
|
@@ -370,28 +367,28 @@ opts = {
|
|
|
370
367
|
|
|
371
368
|
begin
|
|
372
369
|
# Discard the Unpublished Changes of a Workflow
|
|
373
|
-
result = api_instance.
|
|
370
|
+
result = api_instance.discard_workspace_workflow_changes(workspace_id, workflow_id, publish_workspace_workflow_request, opts)
|
|
374
371
|
p result
|
|
375
372
|
rescue ApiSdkRb::ApiError => e
|
|
376
|
-
puts "Error when calling WorkflowsApi->
|
|
373
|
+
puts "Error when calling WorkflowsApi->discard_workspace_workflow_changes: #{e}"
|
|
377
374
|
end
|
|
378
375
|
```
|
|
379
376
|
|
|
380
|
-
#### Using the
|
|
377
|
+
#### Using the discard_workspace_workflow_changes_with_http_info variant
|
|
381
378
|
|
|
382
379
|
This returns an Array which contains the response data, status code and headers.
|
|
383
380
|
|
|
384
|
-
> <Array(<
|
|
381
|
+
> <Array(<WorkflowDetailResponse>, Integer, Hash)> discard_workspace_workflow_changes_with_http_info(workspace_id, workflow_id, publish_workspace_workflow_request, opts)
|
|
385
382
|
|
|
386
383
|
```ruby
|
|
387
384
|
begin
|
|
388
385
|
# Discard the Unpublished Changes of a Workflow
|
|
389
|
-
data, status_code, headers = api_instance.
|
|
386
|
+
data, status_code, headers = api_instance.discard_workspace_workflow_changes_with_http_info(workspace_id, workflow_id, publish_workspace_workflow_request, opts)
|
|
390
387
|
p status_code # => 2xx
|
|
391
388
|
p headers # => { ... }
|
|
392
|
-
p data # => <
|
|
389
|
+
p data # => <WorkflowDetailResponse>
|
|
393
390
|
rescue ApiSdkRb::ApiError => e
|
|
394
|
-
puts "Error when calling WorkflowsApi->
|
|
391
|
+
puts "Error when calling WorkflowsApi->discard_workspace_workflow_changes_with_http_info: #{e}"
|
|
395
392
|
end
|
|
396
393
|
```
|
|
397
394
|
|
|
@@ -407,7 +404,7 @@ end
|
|
|
407
404
|
|
|
408
405
|
### Return type
|
|
409
406
|
|
|
410
|
-
[**
|
|
407
|
+
[**WorkflowDetailResponse**](WorkflowDetailResponse.md)
|
|
411
408
|
|
|
412
409
|
### Authorization
|
|
413
410
|
|
|
@@ -419,9 +416,9 @@ end
|
|
|
419
416
|
- **Accept**: application/json
|
|
420
417
|
|
|
421
418
|
|
|
422
|
-
##
|
|
419
|
+
## duplicate_workspace_workflow
|
|
423
420
|
|
|
424
|
-
> <
|
|
421
|
+
> <WorkflowDetailResponse> duplicate_workspace_workflow(workspace_id, workflow_id, idempotency_key, opts)
|
|
425
422
|
|
|
426
423
|
Duplicate a Workflow
|
|
427
424
|
|
|
@@ -449,28 +446,28 @@ opts = {
|
|
|
449
446
|
|
|
450
447
|
begin
|
|
451
448
|
# Duplicate a Workflow
|
|
452
|
-
result = api_instance.
|
|
449
|
+
result = api_instance.duplicate_workspace_workflow(workspace_id, workflow_id, idempotency_key, opts)
|
|
453
450
|
p result
|
|
454
451
|
rescue ApiSdkRb::ApiError => e
|
|
455
|
-
puts "Error when calling WorkflowsApi->
|
|
452
|
+
puts "Error when calling WorkflowsApi->duplicate_workspace_workflow: #{e}"
|
|
456
453
|
end
|
|
457
454
|
```
|
|
458
455
|
|
|
459
|
-
#### Using the
|
|
456
|
+
#### Using the duplicate_workspace_workflow_with_http_info variant
|
|
460
457
|
|
|
461
458
|
This returns an Array which contains the response data, status code and headers.
|
|
462
459
|
|
|
463
|
-
> <Array(<
|
|
460
|
+
> <Array(<WorkflowDetailResponse>, Integer, Hash)> duplicate_workspace_workflow_with_http_info(workspace_id, workflow_id, idempotency_key, opts)
|
|
464
461
|
|
|
465
462
|
```ruby
|
|
466
463
|
begin
|
|
467
464
|
# Duplicate a Workflow
|
|
468
|
-
data, status_code, headers = api_instance.
|
|
465
|
+
data, status_code, headers = api_instance.duplicate_workspace_workflow_with_http_info(workspace_id, workflow_id, idempotency_key, opts)
|
|
469
466
|
p status_code # => 2xx
|
|
470
467
|
p headers # => { ... }
|
|
471
|
-
p data # => <
|
|
468
|
+
p data # => <WorkflowDetailResponse>
|
|
472
469
|
rescue ApiSdkRb::ApiError => e
|
|
473
|
-
puts "Error when calling WorkflowsApi->
|
|
470
|
+
puts "Error when calling WorkflowsApi->duplicate_workspace_workflow_with_http_info: #{e}"
|
|
474
471
|
end
|
|
475
472
|
```
|
|
476
473
|
|
|
@@ -486,7 +483,7 @@ end
|
|
|
486
483
|
|
|
487
484
|
### Return type
|
|
488
485
|
|
|
489
|
-
[**
|
|
486
|
+
[**WorkflowDetailResponse**](WorkflowDetailResponse.md)
|
|
490
487
|
|
|
491
488
|
### Authorization
|
|
492
489
|
|
|
@@ -498,9 +495,9 @@ end
|
|
|
498
495
|
- **Accept**: application/json
|
|
499
496
|
|
|
500
497
|
|
|
501
|
-
##
|
|
498
|
+
## get_workspace_workflow
|
|
502
499
|
|
|
503
|
-
> <
|
|
500
|
+
> <WorkflowDetailResponse> get_workspace_workflow(workspace_id, workflow_id, opts)
|
|
504
501
|
|
|
505
502
|
Get a Workflow
|
|
506
503
|
|
|
@@ -527,28 +524,28 @@ opts = {
|
|
|
527
524
|
|
|
528
525
|
begin
|
|
529
526
|
# Get a Workflow
|
|
530
|
-
result = api_instance.
|
|
527
|
+
result = api_instance.get_workspace_workflow(workspace_id, workflow_id, opts)
|
|
531
528
|
p result
|
|
532
529
|
rescue ApiSdkRb::ApiError => e
|
|
533
|
-
puts "Error when calling WorkflowsApi->
|
|
530
|
+
puts "Error when calling WorkflowsApi->get_workspace_workflow: #{e}"
|
|
534
531
|
end
|
|
535
532
|
```
|
|
536
533
|
|
|
537
|
-
#### Using the
|
|
534
|
+
#### Using the get_workspace_workflow_with_http_info variant
|
|
538
535
|
|
|
539
536
|
This returns an Array which contains the response data, status code and headers.
|
|
540
537
|
|
|
541
|
-
> <Array(<
|
|
538
|
+
> <Array(<WorkflowDetailResponse>, Integer, Hash)> get_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
542
539
|
|
|
543
540
|
```ruby
|
|
544
541
|
begin
|
|
545
542
|
# Get a Workflow
|
|
546
|
-
data, status_code, headers = api_instance.
|
|
543
|
+
data, status_code, headers = api_instance.get_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
547
544
|
p status_code # => 2xx
|
|
548
545
|
p headers # => { ... }
|
|
549
|
-
p data # => <
|
|
546
|
+
p data # => <WorkflowDetailResponse>
|
|
550
547
|
rescue ApiSdkRb::ApiError => e
|
|
551
|
-
puts "Error when calling WorkflowsApi->
|
|
548
|
+
puts "Error when calling WorkflowsApi->get_workspace_workflow_with_http_info: #{e}"
|
|
552
549
|
end
|
|
553
550
|
```
|
|
554
551
|
|
|
@@ -563,7 +560,7 @@ end
|
|
|
563
560
|
|
|
564
561
|
### Return type
|
|
565
562
|
|
|
566
|
-
[**
|
|
563
|
+
[**WorkflowDetailResponse**](WorkflowDetailResponse.md)
|
|
567
564
|
|
|
568
565
|
### Authorization
|
|
569
566
|
|
|
@@ -575,13 +572,13 @@ end
|
|
|
575
572
|
- **Accept**: application/json
|
|
576
573
|
|
|
577
574
|
|
|
578
|
-
##
|
|
575
|
+
## get_workspace_workflow_stats
|
|
579
576
|
|
|
580
|
-
> <GetWorkspaceWorkflowStats200Response>
|
|
577
|
+
> <GetWorkspaceWorkflowStats200Response> get_workspace_workflow_stats(workspace_id, workflow_id, opts)
|
|
581
578
|
|
|
582
579
|
Get what Visitors Did in a Workflow
|
|
583
580
|
|
|
584
|
-
Counts per block and per connection over a range of UTC days (the last 30 days when not given, up to 366), for one version or for all of them. Only counts: how many visitors reached a block, took a connection, or could not be moved on. No visitor and no value a visitor typed is ever stored. For personal workspace, use 'personal' as workspaceId. For organization workspace, use the organization UUID as workspaceId. Any active member can read.
|
|
581
|
+
Counts per block and per connection over a range of UTC days (the last 30 days when not given, up to 366), for one version or for all of them. Only counts: how many visitors reached a block, took a connection, or could not be moved on, and, where the visitor's browser said why a block could not be shown, how many of those failures had each reason (`failedReasons`: a timeout, an error of the widget, a build that failed, or another reason). No visitor and no value a visitor typed is ever stored. For personal workspace, use 'personal' as workspaceId. For organization workspace, use the organization UUID as workspaceId. Any active member can read.
|
|
585
582
|
|
|
586
583
|
### Examples
|
|
587
584
|
|
|
@@ -607,28 +604,28 @@ opts = {
|
|
|
607
604
|
|
|
608
605
|
begin
|
|
609
606
|
# Get what Visitors Did in a Workflow
|
|
610
|
-
result = api_instance.
|
|
607
|
+
result = api_instance.get_workspace_workflow_stats(workspace_id, workflow_id, opts)
|
|
611
608
|
p result
|
|
612
609
|
rescue ApiSdkRb::ApiError => e
|
|
613
|
-
puts "Error when calling WorkflowsApi->
|
|
610
|
+
puts "Error when calling WorkflowsApi->get_workspace_workflow_stats: #{e}"
|
|
614
611
|
end
|
|
615
612
|
```
|
|
616
613
|
|
|
617
|
-
#### Using the
|
|
614
|
+
#### Using the get_workspace_workflow_stats_with_http_info variant
|
|
618
615
|
|
|
619
616
|
This returns an Array which contains the response data, status code and headers.
|
|
620
617
|
|
|
621
|
-
> <Array(<GetWorkspaceWorkflowStats200Response>, Integer, Hash)>
|
|
618
|
+
> <Array(<GetWorkspaceWorkflowStats200Response>, Integer, Hash)> get_workspace_workflow_stats_with_http_info(workspace_id, workflow_id, opts)
|
|
622
619
|
|
|
623
620
|
```ruby
|
|
624
621
|
begin
|
|
625
622
|
# Get what Visitors Did in a Workflow
|
|
626
|
-
data, status_code, headers = api_instance.
|
|
623
|
+
data, status_code, headers = api_instance.get_workspace_workflow_stats_with_http_info(workspace_id, workflow_id, opts)
|
|
627
624
|
p status_code # => 2xx
|
|
628
625
|
p headers # => { ... }
|
|
629
626
|
p data # => <GetWorkspaceWorkflowStats200Response>
|
|
630
627
|
rescue ApiSdkRb::ApiError => e
|
|
631
|
-
puts "Error when calling WorkflowsApi->
|
|
628
|
+
puts "Error when calling WorkflowsApi->get_workspace_workflow_stats_with_http_info: #{e}"
|
|
632
629
|
end
|
|
633
630
|
```
|
|
634
631
|
|
|
@@ -658,9 +655,9 @@ end
|
|
|
658
655
|
- **Accept**: application/json
|
|
659
656
|
|
|
660
657
|
|
|
661
|
-
##
|
|
658
|
+
## get_workspace_workflow_version
|
|
662
659
|
|
|
663
|
-
> <GetWorkspaceWorkflowVersion200Response>
|
|
660
|
+
> <GetWorkspaceWorkflowVersion200Response> get_workspace_workflow_version(workspace_id, workflow_id, version_id, opts)
|
|
664
661
|
|
|
665
662
|
Get a Published Version of a Workflow
|
|
666
663
|
|
|
@@ -688,28 +685,28 @@ opts = {
|
|
|
688
685
|
|
|
689
686
|
begin
|
|
690
687
|
# Get a Published Version of a Workflow
|
|
691
|
-
result = api_instance.
|
|
688
|
+
result = api_instance.get_workspace_workflow_version(workspace_id, workflow_id, version_id, opts)
|
|
692
689
|
p result
|
|
693
690
|
rescue ApiSdkRb::ApiError => e
|
|
694
|
-
puts "Error when calling WorkflowsApi->
|
|
691
|
+
puts "Error when calling WorkflowsApi->get_workspace_workflow_version: #{e}"
|
|
695
692
|
end
|
|
696
693
|
```
|
|
697
694
|
|
|
698
|
-
#### Using the
|
|
695
|
+
#### Using the get_workspace_workflow_version_with_http_info variant
|
|
699
696
|
|
|
700
697
|
This returns an Array which contains the response data, status code and headers.
|
|
701
698
|
|
|
702
|
-
> <Array(<GetWorkspaceWorkflowVersion200Response>, Integer, Hash)>
|
|
699
|
+
> <Array(<GetWorkspaceWorkflowVersion200Response>, Integer, Hash)> get_workspace_workflow_version_with_http_info(workspace_id, workflow_id, version_id, opts)
|
|
703
700
|
|
|
704
701
|
```ruby
|
|
705
702
|
begin
|
|
706
703
|
# Get a Published Version of a Workflow
|
|
707
|
-
data, status_code, headers = api_instance.
|
|
704
|
+
data, status_code, headers = api_instance.get_workspace_workflow_version_with_http_info(workspace_id, workflow_id, version_id, opts)
|
|
708
705
|
p status_code # => 2xx
|
|
709
706
|
p headers # => { ... }
|
|
710
707
|
p data # => <GetWorkspaceWorkflowVersion200Response>
|
|
711
708
|
rescue ApiSdkRb::ApiError => e
|
|
712
|
-
puts "Error when calling WorkflowsApi->
|
|
709
|
+
puts "Error when calling WorkflowsApi->get_workspace_workflow_version_with_http_info: #{e}"
|
|
713
710
|
end
|
|
714
711
|
```
|
|
715
712
|
|
|
@@ -737,78 +734,9 @@ end
|
|
|
737
734
|
- **Accept**: application/json
|
|
738
735
|
|
|
739
736
|
|
|
740
|
-
##
|
|
737
|
+
## list_workspace_workflow_composition_options
|
|
741
738
|
|
|
742
|
-
> <
|
|
743
|
-
|
|
744
|
-
List the workflows a partner offers as places to start
|
|
745
|
-
|
|
746
|
-
The partner's starting points, ordered by `position` and then by `key`: the published workflows it offers its managed users when they make a new workflow. Each says whether people can start from it now and, when they cannot, why. The list is the same for every managed user, and a managed user is shown only what is available. A starting point is one of the partner account's own published workflows, built from compositions the account made for itself (not for a customer or a team) and from widgets the partner already offers as presets (`setPartnerPreset`), and it uses at most 10 widgets. A partner offers up to 50. The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator.
|
|
747
|
-
|
|
748
|
-
### Examples
|
|
749
|
-
|
|
750
|
-
```ruby
|
|
751
|
-
require 'time'
|
|
752
|
-
require 'api-sdk-rb'
|
|
753
|
-
# setup authorization
|
|
754
|
-
ApiSdkRb.configure do |config|
|
|
755
|
-
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
756
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
757
|
-
end
|
|
758
|
-
|
|
759
|
-
api_instance = ApiSdkRb::WorkflowsApi.new
|
|
760
|
-
partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose starting points to list
|
|
761
|
-
|
|
762
|
-
begin
|
|
763
|
-
# List the workflows a partner offers as places to start
|
|
764
|
-
result = api_instance.list_partner_workflow_presets_1(partner_id)
|
|
765
|
-
p result
|
|
766
|
-
rescue ApiSdkRb::ApiError => e
|
|
767
|
-
puts "Error when calling WorkflowsApi->list_partner_workflow_presets_1: #{e}"
|
|
768
|
-
end
|
|
769
|
-
```
|
|
770
|
-
|
|
771
|
-
#### Using the list_partner_workflow_presets_1_with_http_info variant
|
|
772
|
-
|
|
773
|
-
This returns an Array which contains the response data, status code and headers.
|
|
774
|
-
|
|
775
|
-
> <Array(<ListPartnerWorkflowPresets200Response>, Integer, Hash)> list_partner_workflow_presets_1_with_http_info(partner_id)
|
|
776
|
-
|
|
777
|
-
```ruby
|
|
778
|
-
begin
|
|
779
|
-
# List the workflows a partner offers as places to start
|
|
780
|
-
data, status_code, headers = api_instance.list_partner_workflow_presets_1_with_http_info(partner_id)
|
|
781
|
-
p status_code # => 2xx
|
|
782
|
-
p headers # => { ... }
|
|
783
|
-
p data # => <ListPartnerWorkflowPresets200Response>
|
|
784
|
-
rescue ApiSdkRb::ApiError => e
|
|
785
|
-
puts "Error when calling WorkflowsApi->list_partner_workflow_presets_1_with_http_info: #{e}"
|
|
786
|
-
end
|
|
787
|
-
```
|
|
788
|
-
|
|
789
|
-
### Parameters
|
|
790
|
-
|
|
791
|
-
| Name | Type | Description | Notes |
|
|
792
|
-
| ---- | ---- | ----------- | ----- |
|
|
793
|
-
| **partner_id** | **String** | The partner whose starting points to list | |
|
|
794
|
-
|
|
795
|
-
### Return type
|
|
796
|
-
|
|
797
|
-
[**ListPartnerWorkflowPresets200Response**](ListPartnerWorkflowPresets200Response.md)
|
|
798
|
-
|
|
799
|
-
### Authorization
|
|
800
|
-
|
|
801
|
-
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
802
|
-
|
|
803
|
-
### HTTP request headers
|
|
804
|
-
|
|
805
|
-
- **Content-Type**: Not defined
|
|
806
|
-
- **Accept**: application/json
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
## list_workspace_workflow_composition_options_0
|
|
810
|
-
|
|
811
|
-
> <ListWorkspaceWorkflowCompositionOptions200Response> list_workspace_workflow_composition_options_0(workspace_id, opts)
|
|
739
|
+
> <ListWorkspaceWorkflowCompositionOptions200Response> list_workspace_workflow_composition_options(workspace_id, opts)
|
|
812
740
|
|
|
813
741
|
List the compositions a workflow can show, and what each can do
|
|
814
742
|
|
|
@@ -838,28 +766,28 @@ opts = {
|
|
|
838
766
|
|
|
839
767
|
begin
|
|
840
768
|
# List the compositions a workflow can show, and what each can do
|
|
841
|
-
result = api_instance.
|
|
769
|
+
result = api_instance.list_workspace_workflow_composition_options(workspace_id, opts)
|
|
842
770
|
p result
|
|
843
771
|
rescue ApiSdkRb::ApiError => e
|
|
844
|
-
puts "Error when calling WorkflowsApi->
|
|
772
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflow_composition_options: #{e}"
|
|
845
773
|
end
|
|
846
774
|
```
|
|
847
775
|
|
|
848
|
-
#### Using the
|
|
776
|
+
#### Using the list_workspace_workflow_composition_options_with_http_info variant
|
|
849
777
|
|
|
850
778
|
This returns an Array which contains the response data, status code and headers.
|
|
851
779
|
|
|
852
|
-
> <Array(<ListWorkspaceWorkflowCompositionOptions200Response>, Integer, Hash)>
|
|
780
|
+
> <Array(<ListWorkspaceWorkflowCompositionOptions200Response>, Integer, Hash)> list_workspace_workflow_composition_options_with_http_info(workspace_id, opts)
|
|
853
781
|
|
|
854
782
|
```ruby
|
|
855
783
|
begin
|
|
856
784
|
# List the compositions a workflow can show, and what each can do
|
|
857
|
-
data, status_code, headers = api_instance.
|
|
785
|
+
data, status_code, headers = api_instance.list_workspace_workflow_composition_options_with_http_info(workspace_id, opts)
|
|
858
786
|
p status_code # => 2xx
|
|
859
787
|
p headers # => { ... }
|
|
860
788
|
p data # => <ListWorkspaceWorkflowCompositionOptions200Response>
|
|
861
789
|
rescue ApiSdkRb::ApiError => e
|
|
862
|
-
puts "Error when calling WorkflowsApi->
|
|
790
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflow_composition_options_with_http_info: #{e}"
|
|
863
791
|
end
|
|
864
792
|
```
|
|
865
793
|
|
|
@@ -889,9 +817,9 @@ end
|
|
|
889
817
|
- **Accept**: application/json
|
|
890
818
|
|
|
891
819
|
|
|
892
|
-
##
|
|
820
|
+
## list_workspace_workflow_presets
|
|
893
821
|
|
|
894
|
-
> <ListWorkspaceWorkflowPresets200Response>
|
|
822
|
+
> <ListWorkspaceWorkflowPresets200Response> list_workspace_workflow_presets(workspace_id, opts)
|
|
895
823
|
|
|
896
824
|
List the starting points for a new Workflow
|
|
897
825
|
|
|
@@ -917,28 +845,28 @@ opts = {
|
|
|
917
845
|
|
|
918
846
|
begin
|
|
919
847
|
# List the starting points for a new Workflow
|
|
920
|
-
result = api_instance.
|
|
848
|
+
result = api_instance.list_workspace_workflow_presets(workspace_id, opts)
|
|
921
849
|
p result
|
|
922
850
|
rescue ApiSdkRb::ApiError => e
|
|
923
|
-
puts "Error when calling WorkflowsApi->
|
|
851
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflow_presets: #{e}"
|
|
924
852
|
end
|
|
925
853
|
```
|
|
926
854
|
|
|
927
|
-
#### Using the
|
|
855
|
+
#### Using the list_workspace_workflow_presets_with_http_info variant
|
|
928
856
|
|
|
929
857
|
This returns an Array which contains the response data, status code and headers.
|
|
930
858
|
|
|
931
|
-
> <Array(<ListWorkspaceWorkflowPresets200Response>, Integer, Hash)>
|
|
859
|
+
> <Array(<ListWorkspaceWorkflowPresets200Response>, Integer, Hash)> list_workspace_workflow_presets_with_http_info(workspace_id, opts)
|
|
932
860
|
|
|
933
861
|
```ruby
|
|
934
862
|
begin
|
|
935
863
|
# List the starting points for a new Workflow
|
|
936
|
-
data, status_code, headers = api_instance.
|
|
864
|
+
data, status_code, headers = api_instance.list_workspace_workflow_presets_with_http_info(workspace_id, opts)
|
|
937
865
|
p status_code # => 2xx
|
|
938
866
|
p headers # => { ... }
|
|
939
867
|
p data # => <ListWorkspaceWorkflowPresets200Response>
|
|
940
868
|
rescue ApiSdkRb::ApiError => e
|
|
941
|
-
puts "Error when calling WorkflowsApi->
|
|
869
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflow_presets_with_http_info: #{e}"
|
|
942
870
|
end
|
|
943
871
|
```
|
|
944
872
|
|
|
@@ -964,9 +892,9 @@ end
|
|
|
964
892
|
- **Accept**: application/json
|
|
965
893
|
|
|
966
894
|
|
|
967
|
-
##
|
|
895
|
+
## list_workspace_workflow_versions
|
|
968
896
|
|
|
969
|
-
> <ListWorkspaceWorkflowVersions200Response>
|
|
897
|
+
> <ListWorkspaceWorkflowVersions200Response> list_workspace_workflow_versions(workspace_id, workflow_id, opts)
|
|
970
898
|
|
|
971
899
|
List the Published Versions of a Workflow
|
|
972
900
|
|
|
@@ -993,28 +921,28 @@ opts = {
|
|
|
993
921
|
|
|
994
922
|
begin
|
|
995
923
|
# List the Published Versions of a Workflow
|
|
996
|
-
result = api_instance.
|
|
924
|
+
result = api_instance.list_workspace_workflow_versions(workspace_id, workflow_id, opts)
|
|
997
925
|
p result
|
|
998
926
|
rescue ApiSdkRb::ApiError => e
|
|
999
|
-
puts "Error when calling WorkflowsApi->
|
|
927
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflow_versions: #{e}"
|
|
1000
928
|
end
|
|
1001
929
|
```
|
|
1002
930
|
|
|
1003
|
-
#### Using the
|
|
931
|
+
#### Using the list_workspace_workflow_versions_with_http_info variant
|
|
1004
932
|
|
|
1005
933
|
This returns an Array which contains the response data, status code and headers.
|
|
1006
934
|
|
|
1007
|
-
> <Array(<ListWorkspaceWorkflowVersions200Response>, Integer, Hash)>
|
|
935
|
+
> <Array(<ListWorkspaceWorkflowVersions200Response>, Integer, Hash)> list_workspace_workflow_versions_with_http_info(workspace_id, workflow_id, opts)
|
|
1008
936
|
|
|
1009
937
|
```ruby
|
|
1010
938
|
begin
|
|
1011
939
|
# List the Published Versions of a Workflow
|
|
1012
|
-
data, status_code, headers = api_instance.
|
|
940
|
+
data, status_code, headers = api_instance.list_workspace_workflow_versions_with_http_info(workspace_id, workflow_id, opts)
|
|
1013
941
|
p status_code # => 2xx
|
|
1014
942
|
p headers # => { ... }
|
|
1015
943
|
p data # => <ListWorkspaceWorkflowVersions200Response>
|
|
1016
944
|
rescue ApiSdkRb::ApiError => e
|
|
1017
|
-
puts "Error when calling WorkflowsApi->
|
|
945
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflow_versions_with_http_info: #{e}"
|
|
1018
946
|
end
|
|
1019
947
|
```
|
|
1020
948
|
|
|
@@ -1041,9 +969,9 @@ end
|
|
|
1041
969
|
- **Accept**: application/json
|
|
1042
970
|
|
|
1043
971
|
|
|
1044
|
-
##
|
|
972
|
+
## list_workspace_workflows
|
|
1045
973
|
|
|
1046
|
-
> <ListWorkspaceWorkflows200Response>
|
|
974
|
+
> <ListWorkspaceWorkflows200Response> list_workspace_workflows(workspace_id, opts)
|
|
1047
975
|
|
|
1048
976
|
List the Workflows of a Workspace
|
|
1049
977
|
|
|
@@ -1074,28 +1002,28 @@ opts = {
|
|
|
1074
1002
|
|
|
1075
1003
|
begin
|
|
1076
1004
|
# List the Workflows of a Workspace
|
|
1077
|
-
result = api_instance.
|
|
1005
|
+
result = api_instance.list_workspace_workflows(workspace_id, opts)
|
|
1078
1006
|
p result
|
|
1079
1007
|
rescue ApiSdkRb::ApiError => e
|
|
1080
|
-
puts "Error when calling WorkflowsApi->
|
|
1008
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflows: #{e}"
|
|
1081
1009
|
end
|
|
1082
1010
|
```
|
|
1083
1011
|
|
|
1084
|
-
#### Using the
|
|
1012
|
+
#### Using the list_workspace_workflows_with_http_info variant
|
|
1085
1013
|
|
|
1086
1014
|
This returns an Array which contains the response data, status code and headers.
|
|
1087
1015
|
|
|
1088
|
-
> <Array(<ListWorkspaceWorkflows200Response>, Integer, Hash)>
|
|
1016
|
+
> <Array(<ListWorkspaceWorkflows200Response>, Integer, Hash)> list_workspace_workflows_with_http_info(workspace_id, opts)
|
|
1089
1017
|
|
|
1090
1018
|
```ruby
|
|
1091
1019
|
begin
|
|
1092
1020
|
# List the Workflows of a Workspace
|
|
1093
|
-
data, status_code, headers = api_instance.
|
|
1021
|
+
data, status_code, headers = api_instance.list_workspace_workflows_with_http_info(workspace_id, opts)
|
|
1094
1022
|
p status_code # => 2xx
|
|
1095
1023
|
p headers # => { ... }
|
|
1096
1024
|
p data # => <ListWorkspaceWorkflows200Response>
|
|
1097
1025
|
rescue ApiSdkRb::ApiError => e
|
|
1098
|
-
puts "Error when calling WorkflowsApi->
|
|
1026
|
+
puts "Error when calling WorkflowsApi->list_workspace_workflows_with_http_info: #{e}"
|
|
1099
1027
|
end
|
|
1100
1028
|
```
|
|
1101
1029
|
|
|
@@ -1126,9 +1054,9 @@ end
|
|
|
1126
1054
|
- **Accept**: application/json
|
|
1127
1055
|
|
|
1128
1056
|
|
|
1129
|
-
##
|
|
1057
|
+
## pause_workspace_workflow
|
|
1130
1058
|
|
|
1131
|
-
> <
|
|
1059
|
+
> <WorkflowResponse> pause_workspace_workflow(workspace_id, workflow_id, opts)
|
|
1132
1060
|
|
|
1133
1061
|
Pause a Workflow
|
|
1134
1062
|
|
|
@@ -1155,28 +1083,28 @@ opts = {
|
|
|
1155
1083
|
|
|
1156
1084
|
begin
|
|
1157
1085
|
# Pause a Workflow
|
|
1158
|
-
result = api_instance.
|
|
1086
|
+
result = api_instance.pause_workspace_workflow(workspace_id, workflow_id, opts)
|
|
1159
1087
|
p result
|
|
1160
1088
|
rescue ApiSdkRb::ApiError => e
|
|
1161
|
-
puts "Error when calling WorkflowsApi->
|
|
1089
|
+
puts "Error when calling WorkflowsApi->pause_workspace_workflow: #{e}"
|
|
1162
1090
|
end
|
|
1163
1091
|
```
|
|
1164
1092
|
|
|
1165
|
-
#### Using the
|
|
1093
|
+
#### Using the pause_workspace_workflow_with_http_info variant
|
|
1166
1094
|
|
|
1167
1095
|
This returns an Array which contains the response data, status code and headers.
|
|
1168
1096
|
|
|
1169
|
-
> <Array(<
|
|
1097
|
+
> <Array(<WorkflowResponse>, Integer, Hash)> pause_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
1170
1098
|
|
|
1171
1099
|
```ruby
|
|
1172
1100
|
begin
|
|
1173
1101
|
# Pause a Workflow
|
|
1174
|
-
data, status_code, headers = api_instance.
|
|
1102
|
+
data, status_code, headers = api_instance.pause_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
1175
1103
|
p status_code # => 2xx
|
|
1176
1104
|
p headers # => { ... }
|
|
1177
|
-
p data # => <
|
|
1105
|
+
p data # => <WorkflowResponse>
|
|
1178
1106
|
rescue ApiSdkRb::ApiError => e
|
|
1179
|
-
puts "Error when calling WorkflowsApi->
|
|
1107
|
+
puts "Error when calling WorkflowsApi->pause_workspace_workflow_with_http_info: #{e}"
|
|
1180
1108
|
end
|
|
1181
1109
|
```
|
|
1182
1110
|
|
|
@@ -1191,7 +1119,7 @@ end
|
|
|
1191
1119
|
|
|
1192
1120
|
### Return type
|
|
1193
1121
|
|
|
1194
|
-
[**
|
|
1122
|
+
[**WorkflowResponse**](WorkflowResponse.md)
|
|
1195
1123
|
|
|
1196
1124
|
### Authorization
|
|
1197
1125
|
|
|
@@ -1203,9 +1131,9 @@ end
|
|
|
1203
1131
|
- **Accept**: application/json
|
|
1204
1132
|
|
|
1205
1133
|
|
|
1206
|
-
##
|
|
1134
|
+
## publish_workspace_workflow
|
|
1207
1135
|
|
|
1208
|
-
> <PublishWorkspaceWorkflow200Response>
|
|
1136
|
+
> <PublishWorkspaceWorkflow200Response> publish_workspace_workflow(workspace_id, workflow_id, idempotency_key, publish_workspace_workflow_request, opts)
|
|
1209
1137
|
|
|
1210
1138
|
Publish the Draft of a Workflow
|
|
1211
1139
|
|
|
@@ -1234,28 +1162,28 @@ opts = {
|
|
|
1234
1162
|
|
|
1235
1163
|
begin
|
|
1236
1164
|
# Publish the Draft of a Workflow
|
|
1237
|
-
result = api_instance.
|
|
1165
|
+
result = api_instance.publish_workspace_workflow(workspace_id, workflow_id, idempotency_key, publish_workspace_workflow_request, opts)
|
|
1238
1166
|
p result
|
|
1239
1167
|
rescue ApiSdkRb::ApiError => e
|
|
1240
|
-
puts "Error when calling WorkflowsApi->
|
|
1168
|
+
puts "Error when calling WorkflowsApi->publish_workspace_workflow: #{e}"
|
|
1241
1169
|
end
|
|
1242
1170
|
```
|
|
1243
1171
|
|
|
1244
|
-
#### Using the
|
|
1172
|
+
#### Using the publish_workspace_workflow_with_http_info variant
|
|
1245
1173
|
|
|
1246
1174
|
This returns an Array which contains the response data, status code and headers.
|
|
1247
1175
|
|
|
1248
|
-
> <Array(<PublishWorkspaceWorkflow200Response>, Integer, Hash)>
|
|
1176
|
+
> <Array(<PublishWorkspaceWorkflow200Response>, Integer, Hash)> publish_workspace_workflow_with_http_info(workspace_id, workflow_id, idempotency_key, publish_workspace_workflow_request, opts)
|
|
1249
1177
|
|
|
1250
1178
|
```ruby
|
|
1251
1179
|
begin
|
|
1252
1180
|
# Publish the Draft of a Workflow
|
|
1253
|
-
data, status_code, headers = api_instance.
|
|
1181
|
+
data, status_code, headers = api_instance.publish_workspace_workflow_with_http_info(workspace_id, workflow_id, idempotency_key, publish_workspace_workflow_request, opts)
|
|
1254
1182
|
p status_code # => 2xx
|
|
1255
1183
|
p headers # => { ... }
|
|
1256
1184
|
p data # => <PublishWorkspaceWorkflow200Response>
|
|
1257
1185
|
rescue ApiSdkRb::ApiError => e
|
|
1258
|
-
puts "Error when calling WorkflowsApi->
|
|
1186
|
+
puts "Error when calling WorkflowsApi->publish_workspace_workflow_with_http_info: #{e}"
|
|
1259
1187
|
end
|
|
1260
1188
|
```
|
|
1261
1189
|
|
|
@@ -1284,80 +1212,9 @@ end
|
|
|
1284
1212
|
- **Accept**: application/json
|
|
1285
1213
|
|
|
1286
1214
|
|
|
1287
|
-
##
|
|
1288
|
-
|
|
1289
|
-
> <RemovePartnerWorkflowPreset200Response> remove_partner_workflow_preset_1(partner_id, key)
|
|
1290
|
-
|
|
1291
|
-
Stop offering a workflow as a place to start
|
|
1292
|
-
|
|
1293
|
-
Removes the starting point under `key`. The workflow itself is not touched, and neither are the workflows people already started from it. Removing a starting point the partner does not offer is not an error: the answer is `removed: false`.
|
|
1294
|
-
|
|
1295
|
-
### Examples
|
|
1296
|
-
|
|
1297
|
-
```ruby
|
|
1298
|
-
require 'time'
|
|
1299
|
-
require 'api-sdk-rb'
|
|
1300
|
-
# setup authorization
|
|
1301
|
-
ApiSdkRb.configure do |config|
|
|
1302
|
-
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1303
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1304
|
-
end
|
|
1305
|
-
|
|
1306
|
-
api_instance = ApiSdkRb::WorkflowsApi.new
|
|
1307
|
-
partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose starting point to remove
|
|
1308
|
-
key = 'key_example' # String | The key of the starting point to remove
|
|
1309
|
-
|
|
1310
|
-
begin
|
|
1311
|
-
# Stop offering a workflow as a place to start
|
|
1312
|
-
result = api_instance.remove_partner_workflow_preset_1(partner_id, key)
|
|
1313
|
-
p result
|
|
1314
|
-
rescue ApiSdkRb::ApiError => e
|
|
1315
|
-
puts "Error when calling WorkflowsApi->remove_partner_workflow_preset_1: #{e}"
|
|
1316
|
-
end
|
|
1317
|
-
```
|
|
1215
|
+
## restore_workspace_workflow_version
|
|
1318
1216
|
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
This returns an Array which contains the response data, status code and headers.
|
|
1322
|
-
|
|
1323
|
-
> <Array(<RemovePartnerWorkflowPreset200Response>, Integer, Hash)> remove_partner_workflow_preset_1_with_http_info(partner_id, key)
|
|
1324
|
-
|
|
1325
|
-
```ruby
|
|
1326
|
-
begin
|
|
1327
|
-
# Stop offering a workflow as a place to start
|
|
1328
|
-
data, status_code, headers = api_instance.remove_partner_workflow_preset_1_with_http_info(partner_id, key)
|
|
1329
|
-
p status_code # => 2xx
|
|
1330
|
-
p headers # => { ... }
|
|
1331
|
-
p data # => <RemovePartnerWorkflowPreset200Response>
|
|
1332
|
-
rescue ApiSdkRb::ApiError => e
|
|
1333
|
-
puts "Error when calling WorkflowsApi->remove_partner_workflow_preset_1_with_http_info: #{e}"
|
|
1334
|
-
end
|
|
1335
|
-
```
|
|
1336
|
-
|
|
1337
|
-
### Parameters
|
|
1338
|
-
|
|
1339
|
-
| Name | Type | Description | Notes |
|
|
1340
|
-
| ---- | ---- | ----------- | ----- |
|
|
1341
|
-
| **partner_id** | **String** | The partner whose starting point to remove | |
|
|
1342
|
-
| **key** | **String** | The key of the starting point to remove | |
|
|
1343
|
-
|
|
1344
|
-
### Return type
|
|
1345
|
-
|
|
1346
|
-
[**RemovePartnerWorkflowPreset200Response**](RemovePartnerWorkflowPreset200Response.md)
|
|
1347
|
-
|
|
1348
|
-
### Authorization
|
|
1349
|
-
|
|
1350
|
-
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1351
|
-
|
|
1352
|
-
### HTTP request headers
|
|
1353
|
-
|
|
1354
|
-
- **Content-Type**: Not defined
|
|
1355
|
-
- **Accept**: application/json
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
## restore_workspace_workflow_version_0
|
|
1359
|
-
|
|
1360
|
-
> <CreateWorkspaceWorkflowFromPreset201Response> restore_workspace_workflow_version_0(workspace_id, workflow_id, version_id, publish_workspace_workflow_request, opts)
|
|
1217
|
+
> <WorkflowDetailResponse> restore_workspace_workflow_version(workspace_id, workflow_id, version_id, publish_workspace_workflow_request, opts)
|
|
1361
1218
|
|
|
1362
1219
|
Restore a Version of a Workflow into the Draft
|
|
1363
1220
|
|
|
@@ -1386,28 +1243,28 @@ opts = {
|
|
|
1386
1243
|
|
|
1387
1244
|
begin
|
|
1388
1245
|
# Restore a Version of a Workflow into the Draft
|
|
1389
|
-
result = api_instance.
|
|
1246
|
+
result = api_instance.restore_workspace_workflow_version(workspace_id, workflow_id, version_id, publish_workspace_workflow_request, opts)
|
|
1390
1247
|
p result
|
|
1391
1248
|
rescue ApiSdkRb::ApiError => e
|
|
1392
|
-
puts "Error when calling WorkflowsApi->
|
|
1249
|
+
puts "Error when calling WorkflowsApi->restore_workspace_workflow_version: #{e}"
|
|
1393
1250
|
end
|
|
1394
1251
|
```
|
|
1395
1252
|
|
|
1396
|
-
#### Using the
|
|
1253
|
+
#### Using the restore_workspace_workflow_version_with_http_info variant
|
|
1397
1254
|
|
|
1398
1255
|
This returns an Array which contains the response data, status code and headers.
|
|
1399
1256
|
|
|
1400
|
-
> <Array(<
|
|
1257
|
+
> <Array(<WorkflowDetailResponse>, Integer, Hash)> restore_workspace_workflow_version_with_http_info(workspace_id, workflow_id, version_id, publish_workspace_workflow_request, opts)
|
|
1401
1258
|
|
|
1402
1259
|
```ruby
|
|
1403
1260
|
begin
|
|
1404
1261
|
# Restore a Version of a Workflow into the Draft
|
|
1405
|
-
data, status_code, headers = api_instance.
|
|
1262
|
+
data, status_code, headers = api_instance.restore_workspace_workflow_version_with_http_info(workspace_id, workflow_id, version_id, publish_workspace_workflow_request, opts)
|
|
1406
1263
|
p status_code # => 2xx
|
|
1407
1264
|
p headers # => { ... }
|
|
1408
|
-
p data # => <
|
|
1265
|
+
p data # => <WorkflowDetailResponse>
|
|
1409
1266
|
rescue ApiSdkRb::ApiError => e
|
|
1410
|
-
puts "Error when calling WorkflowsApi->
|
|
1267
|
+
puts "Error when calling WorkflowsApi->restore_workspace_workflow_version_with_http_info: #{e}"
|
|
1411
1268
|
end
|
|
1412
1269
|
```
|
|
1413
1270
|
|
|
@@ -1424,7 +1281,7 @@ end
|
|
|
1424
1281
|
|
|
1425
1282
|
### Return type
|
|
1426
1283
|
|
|
1427
|
-
[**
|
|
1284
|
+
[**WorkflowDetailResponse**](WorkflowDetailResponse.md)
|
|
1428
1285
|
|
|
1429
1286
|
### Authorization
|
|
1430
1287
|
|
|
@@ -1436,9 +1293,9 @@ end
|
|
|
1436
1293
|
- **Accept**: application/json
|
|
1437
1294
|
|
|
1438
1295
|
|
|
1439
|
-
##
|
|
1296
|
+
## resume_workspace_workflow
|
|
1440
1297
|
|
|
1441
|
-
> <
|
|
1298
|
+
> <WorkflowResponse> resume_workspace_workflow(workspace_id, workflow_id, opts)
|
|
1442
1299
|
|
|
1443
1300
|
Resume a Paused Workflow
|
|
1444
1301
|
|
|
@@ -1465,28 +1322,28 @@ opts = {
|
|
|
1465
1322
|
|
|
1466
1323
|
begin
|
|
1467
1324
|
# Resume a Paused Workflow
|
|
1468
|
-
result = api_instance.
|
|
1325
|
+
result = api_instance.resume_workspace_workflow(workspace_id, workflow_id, opts)
|
|
1469
1326
|
p result
|
|
1470
1327
|
rescue ApiSdkRb::ApiError => e
|
|
1471
|
-
puts "Error when calling WorkflowsApi->
|
|
1328
|
+
puts "Error when calling WorkflowsApi->resume_workspace_workflow: #{e}"
|
|
1472
1329
|
end
|
|
1473
1330
|
```
|
|
1474
1331
|
|
|
1475
|
-
#### Using the
|
|
1332
|
+
#### Using the resume_workspace_workflow_with_http_info variant
|
|
1476
1333
|
|
|
1477
1334
|
This returns an Array which contains the response data, status code and headers.
|
|
1478
1335
|
|
|
1479
|
-
> <Array(<
|
|
1336
|
+
> <Array(<WorkflowResponse>, Integer, Hash)> resume_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
1480
1337
|
|
|
1481
1338
|
```ruby
|
|
1482
1339
|
begin
|
|
1483
1340
|
# Resume a Paused Workflow
|
|
1484
|
-
data, status_code, headers = api_instance.
|
|
1341
|
+
data, status_code, headers = api_instance.resume_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
1485
1342
|
p status_code # => 2xx
|
|
1486
1343
|
p headers # => { ... }
|
|
1487
|
-
p data # => <
|
|
1344
|
+
p data # => <WorkflowResponse>
|
|
1488
1345
|
rescue ApiSdkRb::ApiError => e
|
|
1489
|
-
puts "Error when calling WorkflowsApi->
|
|
1346
|
+
puts "Error when calling WorkflowsApi->resume_workspace_workflow_with_http_info: #{e}"
|
|
1490
1347
|
end
|
|
1491
1348
|
```
|
|
1492
1349
|
|
|
@@ -1501,7 +1358,7 @@ end
|
|
|
1501
1358
|
|
|
1502
1359
|
### Return type
|
|
1503
1360
|
|
|
1504
|
-
[**
|
|
1361
|
+
[**WorkflowResponse**](WorkflowResponse.md)
|
|
1505
1362
|
|
|
1506
1363
|
### Authorization
|
|
1507
1364
|
|
|
@@ -1513,9 +1370,9 @@ end
|
|
|
1513
1370
|
- **Accept**: application/json
|
|
1514
1371
|
|
|
1515
1372
|
|
|
1516
|
-
##
|
|
1373
|
+
## save_workspace_workflow
|
|
1517
1374
|
|
|
1518
|
-
> <
|
|
1375
|
+
> <WorkflowResponse> save_workspace_workflow(workspace_id, workflow_id, save_workspace_workflow_request, opts)
|
|
1519
1376
|
|
|
1520
1377
|
Save the Draft of a Workflow
|
|
1521
1378
|
|
|
@@ -1543,28 +1400,28 @@ opts = {
|
|
|
1543
1400
|
|
|
1544
1401
|
begin
|
|
1545
1402
|
# Save the Draft of a Workflow
|
|
1546
|
-
result = api_instance.
|
|
1403
|
+
result = api_instance.save_workspace_workflow(workspace_id, workflow_id, save_workspace_workflow_request, opts)
|
|
1547
1404
|
p result
|
|
1548
1405
|
rescue ApiSdkRb::ApiError => e
|
|
1549
|
-
puts "Error when calling WorkflowsApi->
|
|
1406
|
+
puts "Error when calling WorkflowsApi->save_workspace_workflow: #{e}"
|
|
1550
1407
|
end
|
|
1551
1408
|
```
|
|
1552
1409
|
|
|
1553
|
-
#### Using the
|
|
1410
|
+
#### Using the save_workspace_workflow_with_http_info variant
|
|
1554
1411
|
|
|
1555
1412
|
This returns an Array which contains the response data, status code and headers.
|
|
1556
1413
|
|
|
1557
|
-
> <Array(<
|
|
1414
|
+
> <Array(<WorkflowResponse>, Integer, Hash)> save_workspace_workflow_with_http_info(workspace_id, workflow_id, save_workspace_workflow_request, opts)
|
|
1558
1415
|
|
|
1559
1416
|
```ruby
|
|
1560
1417
|
begin
|
|
1561
1418
|
# Save the Draft of a Workflow
|
|
1562
|
-
data, status_code, headers = api_instance.
|
|
1419
|
+
data, status_code, headers = api_instance.save_workspace_workflow_with_http_info(workspace_id, workflow_id, save_workspace_workflow_request, opts)
|
|
1563
1420
|
p status_code # => 2xx
|
|
1564
1421
|
p headers # => { ... }
|
|
1565
|
-
p data # => <
|
|
1422
|
+
p data # => <WorkflowResponse>
|
|
1566
1423
|
rescue ApiSdkRb::ApiError => e
|
|
1567
|
-
puts "Error when calling WorkflowsApi->
|
|
1424
|
+
puts "Error when calling WorkflowsApi->save_workspace_workflow_with_http_info: #{e}"
|
|
1568
1425
|
end
|
|
1569
1426
|
```
|
|
1570
1427
|
|
|
@@ -1580,80 +1437,7 @@ end
|
|
|
1580
1437
|
|
|
1581
1438
|
### Return type
|
|
1582
1439
|
|
|
1583
|
-
[**
|
|
1584
|
-
|
|
1585
|
-
### Authorization
|
|
1586
|
-
|
|
1587
|
-
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1588
|
-
|
|
1589
|
-
### HTTP request headers
|
|
1590
|
-
|
|
1591
|
-
- **Content-Type**: application/json
|
|
1592
|
-
- **Accept**: application/json
|
|
1593
|
-
|
|
1594
|
-
|
|
1595
|
-
## set_partner_workflow_preset_1
|
|
1596
|
-
|
|
1597
|
-
> <SetPartnerWorkflowPreset200Response> set_partner_workflow_preset_1(partner_id, key, offer_workflow_preset_request)
|
|
1598
|
-
|
|
1599
|
-
Offer a workflow as a place to start, or replace what a key offers
|
|
1600
|
-
|
|
1601
|
-
Offers one of the partner account's own published workflows to its managed users under `key`. If the partner already offers something under that key it is replaced, so sending the same request twice is safe. Saving replaces the whole starting point: a `title`, `description` or `position` you leave out goes back to its default. Keys are 1 to 64 characters: lowercase letters, digits, hyphens and underscores, the first a letter or a digit. A workflow is offered once. What people get is the workflow's live version as it is when they start, so publishing the workflow changes what new starts get; workflows people already started are never touched. The offer is refused, and `error.details.reason` says why, when the workflow: - is not the partner account's own (a workflow of a team or of a customer, or of somebody else), or does not exist: 404, the same for both; - is archived (409 `workflow_archived`), or was never published (409 `workflow_not_published`); - shows no composition (422 `workflow_empty`), or a block shows a composition made for a customer or a team (422 `composition_not_own`); - chains more than 10 widgets (422 `too_many_widgets`), or a widget that the partner does not offer as a preset (422 `widget_not_preset`; `error.details.widgets` lists them, each with its `id` and `name`, so they can be offered first with `setPartnerPreset`); - is already offered under another key (409 `workflow_already_offered`; `error.details.key` says which), or the partner already offers 50 (409 `too_many_presets`). The caller must be the person who administers the partner (an API key of that account works), or a Widgetic administrator, who offers the partner's workflow on its behalf.
|
|
1602
|
-
|
|
1603
|
-
### Examples
|
|
1604
|
-
|
|
1605
|
-
```ruby
|
|
1606
|
-
require 'time'
|
|
1607
|
-
require 'api-sdk-rb'
|
|
1608
|
-
# setup authorization
|
|
1609
|
-
ApiSdkRb.configure do |config|
|
|
1610
|
-
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1611
|
-
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1612
|
-
end
|
|
1613
|
-
|
|
1614
|
-
api_instance = ApiSdkRb::WorkflowsApi.new
|
|
1615
|
-
partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose starting point to set
|
|
1616
|
-
key = 'key_example' # String | The name your code and the picker use for the starting point
|
|
1617
|
-
offer_workflow_preset_request = ApiSdkRb::OfferWorkflowPresetRequest.new({workflow_id: 'workflow_id_example'}) # OfferWorkflowPresetRequest |
|
|
1618
|
-
|
|
1619
|
-
begin
|
|
1620
|
-
# Offer a workflow as a place to start, or replace what a key offers
|
|
1621
|
-
result = api_instance.set_partner_workflow_preset_1(partner_id, key, offer_workflow_preset_request)
|
|
1622
|
-
p result
|
|
1623
|
-
rescue ApiSdkRb::ApiError => e
|
|
1624
|
-
puts "Error when calling WorkflowsApi->set_partner_workflow_preset_1: #{e}"
|
|
1625
|
-
end
|
|
1626
|
-
```
|
|
1627
|
-
|
|
1628
|
-
#### Using the set_partner_workflow_preset_1_with_http_info variant
|
|
1629
|
-
|
|
1630
|
-
This returns an Array which contains the response data, status code and headers.
|
|
1631
|
-
|
|
1632
|
-
> <Array(<SetPartnerWorkflowPreset200Response>, Integer, Hash)> set_partner_workflow_preset_1_with_http_info(partner_id, key, offer_workflow_preset_request)
|
|
1633
|
-
|
|
1634
|
-
```ruby
|
|
1635
|
-
begin
|
|
1636
|
-
# Offer a workflow as a place to start, or replace what a key offers
|
|
1637
|
-
data, status_code, headers = api_instance.set_partner_workflow_preset_1_with_http_info(partner_id, key, offer_workflow_preset_request)
|
|
1638
|
-
p status_code # => 2xx
|
|
1639
|
-
p headers # => { ... }
|
|
1640
|
-
p data # => <SetPartnerWorkflowPreset200Response>
|
|
1641
|
-
rescue ApiSdkRb::ApiError => e
|
|
1642
|
-
puts "Error when calling WorkflowsApi->set_partner_workflow_preset_1_with_http_info: #{e}"
|
|
1643
|
-
end
|
|
1644
|
-
```
|
|
1645
|
-
|
|
1646
|
-
### Parameters
|
|
1647
|
-
|
|
1648
|
-
| Name | Type | Description | Notes |
|
|
1649
|
-
| ---- | ---- | ----------- | ----- |
|
|
1650
|
-
| **partner_id** | **String** | The partner whose starting point to set | |
|
|
1651
|
-
| **key** | **String** | The name your code and the picker use for the starting point | |
|
|
1652
|
-
| **offer_workflow_preset_request** | [**OfferWorkflowPresetRequest**](OfferWorkflowPresetRequest.md) | | |
|
|
1653
|
-
|
|
1654
|
-
### Return type
|
|
1655
|
-
|
|
1656
|
-
[**SetPartnerWorkflowPreset200Response**](SetPartnerWorkflowPreset200Response.md)
|
|
1440
|
+
[**WorkflowResponse**](WorkflowResponse.md)
|
|
1657
1441
|
|
|
1658
1442
|
### Authorization
|
|
1659
1443
|
|
|
@@ -1665,9 +1449,9 @@ end
|
|
|
1665
1449
|
- **Accept**: application/json
|
|
1666
1450
|
|
|
1667
1451
|
|
|
1668
|
-
##
|
|
1452
|
+
## unarchive_workspace_workflow
|
|
1669
1453
|
|
|
1670
|
-
> <
|
|
1454
|
+
> <WorkflowResponse> unarchive_workspace_workflow(workspace_id, workflow_id, opts)
|
|
1671
1455
|
|
|
1672
1456
|
Unarchive a Workflow
|
|
1673
1457
|
|
|
@@ -1694,28 +1478,28 @@ opts = {
|
|
|
1694
1478
|
|
|
1695
1479
|
begin
|
|
1696
1480
|
# Unarchive a Workflow
|
|
1697
|
-
result = api_instance.
|
|
1481
|
+
result = api_instance.unarchive_workspace_workflow(workspace_id, workflow_id, opts)
|
|
1698
1482
|
p result
|
|
1699
1483
|
rescue ApiSdkRb::ApiError => e
|
|
1700
|
-
puts "Error when calling WorkflowsApi->
|
|
1484
|
+
puts "Error when calling WorkflowsApi->unarchive_workspace_workflow: #{e}"
|
|
1701
1485
|
end
|
|
1702
1486
|
```
|
|
1703
1487
|
|
|
1704
|
-
#### Using the
|
|
1488
|
+
#### Using the unarchive_workspace_workflow_with_http_info variant
|
|
1705
1489
|
|
|
1706
1490
|
This returns an Array which contains the response data, status code and headers.
|
|
1707
1491
|
|
|
1708
|
-
> <Array(<
|
|
1492
|
+
> <Array(<WorkflowResponse>, Integer, Hash)> unarchive_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
1709
1493
|
|
|
1710
1494
|
```ruby
|
|
1711
1495
|
begin
|
|
1712
1496
|
# Unarchive a Workflow
|
|
1713
|
-
data, status_code, headers = api_instance.
|
|
1497
|
+
data, status_code, headers = api_instance.unarchive_workspace_workflow_with_http_info(workspace_id, workflow_id, opts)
|
|
1714
1498
|
p status_code # => 2xx
|
|
1715
1499
|
p headers # => { ... }
|
|
1716
|
-
p data # => <
|
|
1500
|
+
p data # => <WorkflowResponse>
|
|
1717
1501
|
rescue ApiSdkRb::ApiError => e
|
|
1718
|
-
puts "Error when calling WorkflowsApi->
|
|
1502
|
+
puts "Error when calling WorkflowsApi->unarchive_workspace_workflow_with_http_info: #{e}"
|
|
1719
1503
|
end
|
|
1720
1504
|
```
|
|
1721
1505
|
|
|
@@ -1730,7 +1514,7 @@ end
|
|
|
1730
1514
|
|
|
1731
1515
|
### Return type
|
|
1732
1516
|
|
|
1733
|
-
[**
|
|
1517
|
+
[**WorkflowResponse**](WorkflowResponse.md)
|
|
1734
1518
|
|
|
1735
1519
|
### Authorization
|
|
1736
1520
|
|