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/README.md
CHANGED
|
@@ -7,7 +7,7 @@ API documentation for the Widgetic API Gateway
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 1.0.0
|
|
10
|
-
- Package version: 1.11.
|
|
10
|
+
- Package version: 1.11.133
|
|
11
11
|
- Generator version: 7.9.0
|
|
12
12
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
13
13
|
|
|
@@ -24,16 +24,16 @@ gem build api-sdk-rb.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./api-sdk-rb-1.11.
|
|
27
|
+
gem install ./api-sdk-rb-1.11.133.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./api-sdk-rb-1.11.
|
|
30
|
+
(for development, run `gem install --dev ./api-sdk-rb-1.11.133.gem` to install the development dependencies)
|
|
31
31
|
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
33
|
|
|
34
34
|
Finally add this to the Gemfile:
|
|
35
35
|
|
|
36
|
-
gem 'api-sdk-rb', '~> 1.11.
|
|
36
|
+
gem 'api-sdk-rb', '~> 1.11.133'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -72,10 +72,10 @@ opts = {
|
|
|
72
72
|
|
|
73
73
|
begin
|
|
74
74
|
#Reset the Brand Kit to the default
|
|
75
|
-
result = api_instance.
|
|
75
|
+
result = api_instance.delete_brand_kit(opts)
|
|
76
76
|
p result
|
|
77
77
|
rescue ApiSdkRb::ApiError => e
|
|
78
|
-
puts "Exception when calling BrandKitApi->
|
|
78
|
+
puts "Exception when calling BrandKitApi->delete_brand_kit: #{e}"
|
|
79
79
|
end
|
|
80
80
|
|
|
81
81
|
```
|
|
@@ -86,362 +86,175 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
86
86
|
|
|
87
87
|
Class | Method | HTTP request | Description
|
|
88
88
|
------------ | ------------- | ------------- | -------------
|
|
89
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
90
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
91
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
92
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
93
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
94
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
95
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
96
|
-
*ApiSdkRb::BrandKitApi* | [**
|
|
97
|
-
*ApiSdkRb::CanvasesApi* | [**
|
|
98
|
-
*ApiSdkRb::CanvasesApi* | [**
|
|
99
|
-
*ApiSdkRb::CanvasesApi* | [**
|
|
100
|
-
*ApiSdkRb::CanvasesApi* | [**
|
|
101
|
-
*ApiSdkRb::CanvasesApi* | [**
|
|
102
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
103
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
104
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
105
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
106
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
107
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
108
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
109
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
110
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
111
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
112
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
113
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
114
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
115
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
116
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
117
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
118
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
119
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
120
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
121
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
122
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
123
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
124
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
125
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
126
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
127
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
128
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
129
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
130
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
131
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
132
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
133
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
134
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
135
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
136
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
137
|
-
*ApiSdkRb::CompositionsApi* | [**
|
|
138
|
-
*ApiSdkRb::
|
|
139
|
-
*ApiSdkRb::
|
|
140
|
-
*ApiSdkRb::
|
|
141
|
-
*ApiSdkRb::
|
|
142
|
-
*ApiSdkRb::
|
|
143
|
-
*ApiSdkRb::
|
|
144
|
-
*ApiSdkRb::
|
|
145
|
-
*ApiSdkRb::
|
|
146
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
147
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
148
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
149
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
150
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
151
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
152
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
153
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
154
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
155
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
156
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
157
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
158
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
159
|
-
*ApiSdkRb::ManagedUsersApi* | [**
|
|
160
|
-
*ApiSdkRb::
|
|
161
|
-
*ApiSdkRb::
|
|
162
|
-
*ApiSdkRb::
|
|
163
|
-
*ApiSdkRb::
|
|
164
|
-
*ApiSdkRb::
|
|
165
|
-
*ApiSdkRb::
|
|
166
|
-
*ApiSdkRb::
|
|
167
|
-
*ApiSdkRb::
|
|
168
|
-
*ApiSdkRb::
|
|
169
|
-
*ApiSdkRb::
|
|
170
|
-
*ApiSdkRb::
|
|
171
|
-
*ApiSdkRb::
|
|
172
|
-
*ApiSdkRb::
|
|
173
|
-
*ApiSdkRb::
|
|
174
|
-
*ApiSdkRb::
|
|
175
|
-
*ApiSdkRb::
|
|
176
|
-
*ApiSdkRb::
|
|
177
|
-
*ApiSdkRb::
|
|
178
|
-
*ApiSdkRb::
|
|
179
|
-
*ApiSdkRb::
|
|
180
|
-
*ApiSdkRb::
|
|
181
|
-
*ApiSdkRb::
|
|
182
|
-
*ApiSdkRb::
|
|
183
|
-
*ApiSdkRb::
|
|
184
|
-
*ApiSdkRb::
|
|
185
|
-
*ApiSdkRb::
|
|
186
|
-
*ApiSdkRb::
|
|
187
|
-
*ApiSdkRb::
|
|
188
|
-
*ApiSdkRb::
|
|
189
|
-
*ApiSdkRb::
|
|
190
|
-
*ApiSdkRb::
|
|
191
|
-
*ApiSdkRb::
|
|
192
|
-
*ApiSdkRb::
|
|
193
|
-
*ApiSdkRb::
|
|
194
|
-
*ApiSdkRb::
|
|
195
|
-
*ApiSdkRb::
|
|
196
|
-
*ApiSdkRb::
|
|
197
|
-
*ApiSdkRb::
|
|
198
|
-
*ApiSdkRb::
|
|
199
|
-
*ApiSdkRb::
|
|
200
|
-
*ApiSdkRb::
|
|
201
|
-
*ApiSdkRb::
|
|
202
|
-
*ApiSdkRb::
|
|
203
|
-
*ApiSdkRb::
|
|
204
|
-
*ApiSdkRb::
|
|
205
|
-
*ApiSdkRb::
|
|
206
|
-
*ApiSdkRb::
|
|
207
|
-
*ApiSdkRb::
|
|
208
|
-
*ApiSdkRb::
|
|
209
|
-
*ApiSdkRb::
|
|
210
|
-
*ApiSdkRb::
|
|
211
|
-
*ApiSdkRb::
|
|
212
|
-
*ApiSdkRb::
|
|
213
|
-
*ApiSdkRb::
|
|
214
|
-
*ApiSdkRb::
|
|
215
|
-
*ApiSdkRb::
|
|
216
|
-
*ApiSdkRb::
|
|
217
|
-
*ApiSdkRb::
|
|
218
|
-
*ApiSdkRb::
|
|
219
|
-
*ApiSdkRb::
|
|
220
|
-
*ApiSdkRb::
|
|
221
|
-
*ApiSdkRb::
|
|
222
|
-
*ApiSdkRb::
|
|
223
|
-
*ApiSdkRb::
|
|
224
|
-
*ApiSdkRb::
|
|
225
|
-
*ApiSdkRb::
|
|
226
|
-
*ApiSdkRb::
|
|
227
|
-
*ApiSdkRb::
|
|
228
|
-
*ApiSdkRb::
|
|
229
|
-
*ApiSdkRb::
|
|
230
|
-
*ApiSdkRb::
|
|
231
|
-
*ApiSdkRb::
|
|
232
|
-
*ApiSdkRb::
|
|
233
|
-
*ApiSdkRb::
|
|
234
|
-
*ApiSdkRb::
|
|
235
|
-
*ApiSdkRb::
|
|
236
|
-
*ApiSdkRb::
|
|
237
|
-
*ApiSdkRb::
|
|
238
|
-
*ApiSdkRb::
|
|
239
|
-
*ApiSdkRb::
|
|
240
|
-
*ApiSdkRb::
|
|
241
|
-
*ApiSdkRb::
|
|
242
|
-
*ApiSdkRb::
|
|
243
|
-
*ApiSdkRb::
|
|
244
|
-
*ApiSdkRb::
|
|
245
|
-
*ApiSdkRb::
|
|
246
|
-
*ApiSdkRb::
|
|
247
|
-
*ApiSdkRb::
|
|
248
|
-
*ApiSdkRb::
|
|
249
|
-
*ApiSdkRb::
|
|
250
|
-
*ApiSdkRb::
|
|
251
|
-
*ApiSdkRb::
|
|
252
|
-
*ApiSdkRb::
|
|
253
|
-
*ApiSdkRb::
|
|
254
|
-
*ApiSdkRb::
|
|
255
|
-
*ApiSdkRb::
|
|
256
|
-
*ApiSdkRb::
|
|
257
|
-
*ApiSdkRb::
|
|
258
|
-
*ApiSdkRb::PartnerApi* | [**get_workspace_workflow**](docs/PartnerApi.md#get_workspace_workflow) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow
|
|
259
|
-
*ApiSdkRb::PartnerApi* | [**get_workspace_workflow_stats**](docs/PartnerApi.md#get_workspace_workflow_stats) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow
|
|
260
|
-
*ApiSdkRb::PartnerApi* | [**get_workspace_workflow_version**](docs/PartnerApi.md#get_workspace_workflow_version) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow
|
|
261
|
-
*ApiSdkRb::PartnerApi* | [**list_composition_entry_items**](docs/PartnerApi.md#list_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/items | List composition entry items with paging and filters
|
|
262
|
-
*ApiSdkRb::PartnerApi* | [**list_managed_user_entries**](docs/PartnerApi.md#list_managed_user_entries) | **GET** /managed-users/{id}/entries | List entries across a managed user's compositions
|
|
263
|
-
*ApiSdkRb::PartnerApi* | [**list_partner_notification_deliveries**](docs/PartnerApi.md#list_partner_notification_deliveries) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you
|
|
264
|
-
*ApiSdkRb::PartnerApi* | [**list_partner_notifications**](docs/PartnerApi.md#list_partner_notifications) | **GET** /partners/{partnerId}/notifications | What your partner account was told
|
|
265
|
-
*ApiSdkRb::PartnerApi* | [**list_partner_presets**](docs/PartnerApi.md#list_partner_presets) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets
|
|
266
|
-
*ApiSdkRb::PartnerApi* | [**list_partner_workflow_presets**](docs/PartnerApi.md#list_partner_workflow_presets) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start
|
|
267
|
-
*ApiSdkRb::PartnerApi* | [**list_workspace_workflow_composition_options**](docs/PartnerApi.md#list_workspace_workflow_composition_options) | **GET** /workspaces/{workspaceId}/workflows/composition-options | List the compositions a workflow can show, and what each can do
|
|
268
|
-
*ApiSdkRb::PartnerApi* | [**list_workspace_workflow_presets**](docs/PartnerApi.md#list_workspace_workflow_presets) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow
|
|
269
|
-
*ApiSdkRb::PartnerApi* | [**list_workspace_workflow_versions**](docs/PartnerApi.md#list_workspace_workflow_versions) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow
|
|
270
|
-
*ApiSdkRb::PartnerApi* | [**list_workspace_workflows**](docs/PartnerApi.md#list_workspace_workflows) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace
|
|
271
|
-
*ApiSdkRb::PartnerApi* | [**operations_id_get**](docs/PartnerApi.md#operations_id_get) | **GET** /operations/{id} | Get operation status
|
|
272
|
-
*ApiSdkRb::PartnerApi* | [**patch_brand_kit**](docs/PartnerApi.md#patch_brand_kit) | **PATCH** /brand-kit | Change part of the Brand Kit
|
|
273
|
-
*ApiSdkRb::PartnerApi* | [**patch_brand_kit_asset**](docs/PartnerApi.md#patch_brand_kit_asset) | **PATCH** /brand-kit/assets/{assetId} | Rename an icon or relabel a font variant
|
|
274
|
-
*ApiSdkRb::PartnerApi* | [**patch_composition_content_item**](docs/PartnerApi.md#patch_composition_content_item) | **PATCH** /compositions/{id}/content/{list}/items/{itemId} | Update a content list item
|
|
275
|
-
*ApiSdkRb::PartnerApi* | [**pause_workspace_workflow**](docs/PartnerApi.md#pause_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow
|
|
276
|
-
*ApiSdkRb::PartnerApi* | [**post_brand_kit_font**](docs/PartnerApi.md#post_brand_kit_font) | **POST** /brand-kit/fonts | Upload a font file to the Brand Kit
|
|
277
|
-
*ApiSdkRb::PartnerApi* | [**post_brand_kit_icon**](docs/PartnerApi.md#post_brand_kit_icon) | **POST** /brand-kit/icons | Add a named SVG icon to the Brand Kit
|
|
278
|
-
*ApiSdkRb::PartnerApi* | [**post_public_composition_embed_status**](docs/PartnerApi.md#post_public_composition_embed_status) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed
|
|
279
|
-
*ApiSdkRb::PartnerApi* | [**publish_workspace_workflow**](docs/PartnerApi.md#publish_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow
|
|
280
|
-
*ApiSdkRb::PartnerApi* | [**put_brand_kit**](docs/PartnerApi.md#put_brand_kit) | **PUT** /brand-kit | Save Brand Kit tokens
|
|
281
|
-
*ApiSdkRb::PartnerApi* | [**read_composition_entries**](docs/PartnerApi.md#read_composition_entries) | **GET** /compositions/{id}/entries/{table} | Read the Entries of a Composition's Table
|
|
282
|
-
*ApiSdkRb::PartnerApi* | [**remove_ai_answers_knowledge_document**](docs/PartnerApi.md#remove_ai_answers_knowledge_document) | **DELETE** /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId} | Remove a document from a widget's knowledge base
|
|
283
|
-
*ApiSdkRb::PartnerApi* | [**remove_partner_adapter_connection**](docs/PartnerApi.md#remove_partner_adapter_connection) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner
|
|
284
|
-
*ApiSdkRb::PartnerApi* | [**remove_partner_data_database**](docs/PartnerApi.md#remove_partner_data_database) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database
|
|
285
|
-
*ApiSdkRb::PartnerApi* | [**remove_partner_preset**](docs/PartnerApi.md#remove_partner_preset) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets
|
|
286
|
-
*ApiSdkRb::PartnerApi* | [**remove_partner_storage_destination**](docs/PartnerApi.md#remove_partner_storage_destination) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket
|
|
287
|
-
*ApiSdkRb::PartnerApi* | [**remove_partner_workflow_preset**](docs/PartnerApi.md#remove_partner_workflow_preset) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start
|
|
288
|
-
*ApiSdkRb::PartnerApi* | [**remove_user_adapter_connection**](docs/PartnerApi.md#remove_user_adapter_connection) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account
|
|
289
|
-
*ApiSdkRb::PartnerApi* | [**replay_partner_notification_delivery**](docs/PartnerApi.md#replay_partner_notification_delivery) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again
|
|
290
|
-
*ApiSdkRb::PartnerApi* | [**report_public_workflow_events**](docs/PartnerApi.md#report_public_workflow_events) | **POST** /embed/workflows/{workflowId}/events | Report what visitors did in a Workflow, as counts
|
|
291
|
-
*ApiSdkRb::PartnerApi* | [**restore_workspace_workflow_version**](docs/PartnerApi.md#restore_workspace_workflow_version) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft
|
|
292
|
-
*ApiSdkRb::PartnerApi* | [**resume_workspace_workflow**](docs/PartnerApi.md#resume_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow
|
|
293
|
-
*ApiSdkRb::PartnerApi* | [**revoke_managed_user_editor_session**](docs/PartnerApi.md#revoke_managed_user_editor_session) | **DELETE** /managed-users/{id}/editor-sessions/{sessionId} | End one editor session of a managed user
|
|
294
|
-
*ApiSdkRb::PartnerApi* | [**revoke_managed_user_editor_sessions**](docs/PartnerApi.md#revoke_managed_user_editor_sessions) | **DELETE** /managed-users/{id}/editor-sessions | End every editor session of a managed user
|
|
295
|
-
*ApiSdkRb::PartnerApi* | [**rotate_partner_entry_context_secret**](docs/PartnerApi.md#rotate_partner_entry_context_secret) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds
|
|
296
|
-
*ApiSdkRb::PartnerApi* | [**rotate_partner_webhook_secret**](docs/PartnerApi.md#rotate_partner_webhook_secret) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook
|
|
297
|
-
*ApiSdkRb::PartnerApi* | [**save_workspace_workflow**](docs/PartnerApi.md#save_workspace_workflow) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow
|
|
298
|
-
*ApiSdkRb::PartnerApi* | [**send_partner_notification_test_event**](docs/PartnerApi.md#send_partner_notification_test_event) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook
|
|
299
|
-
*ApiSdkRb::PartnerApi* | [**set_composition_data_source**](docs/PartnerApi.md#set_composition_data_source) | **PUT** /compositions/{id}/data-source | Bind a public JSON data source for embed refresh
|
|
300
|
-
*ApiSdkRb::PartnerApi* | [**set_dynamic_content**](docs/PartnerApi.md#set_dynamic_content) | **PUT** /compositions/{id}/content | Set Dynamic Content
|
|
301
|
-
*ApiSdkRb::PartnerApi* | [**set_managed_user_design_defaults**](docs/PartnerApi.md#set_managed_user_design_defaults) | **PUT** /managed-users/{id}/design-defaults | Set or clear design defaults for one managed user
|
|
302
|
-
*ApiSdkRb::PartnerApi* | [**set_managed_user_limits**](docs/PartnerApi.md#set_managed_user_limits) | **PUT** /managed-users/{id}/limits | Set or clear the monthly credit cap for one managed user
|
|
303
|
-
*ApiSdkRb::PartnerApi* | [**set_partner_adapter_connection**](docs/PartnerApi.md#set_partner_adapter_connection) | **PUT** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to a partner
|
|
304
|
-
*ApiSdkRb::PartnerApi* | [**set_partner_data_database**](docs/PartnerApi.md#set_partner_data_database) | **PUT** /partners/{partnerId}/data-database | Keep the data of a partner's compositions in a Neon database of its own
|
|
305
|
-
*ApiSdkRb::PartnerApi* | [**set_partner_design_defaults**](docs/PartnerApi.md#set_partner_design_defaults) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults
|
|
306
|
-
*ApiSdkRb::PartnerApi* | [**set_partner_preset**](docs/PartnerApi.md#set_partner_preset) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset
|
|
307
|
-
*ApiSdkRb::PartnerApi* | [**set_partner_storage_destination**](docs/PartnerApi.md#set_partner_storage_destination) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored
|
|
308
|
-
*ApiSdkRb::PartnerApi* | [**set_partner_workflow_preset**](docs/PartnerApi.md#set_partner_workflow_preset) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers
|
|
309
|
-
*ApiSdkRb::PartnerApi* | [**set_user_adapter_connection**](docs/PartnerApi.md#set_user_adapter_connection) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account
|
|
310
|
-
*ApiSdkRb::PartnerApi* | [**unarchive_workspace_workflow**](docs/PartnerApi.md#unarchive_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow
|
|
311
|
-
*ApiSdkRb::PartnerApi* | [**update_canvas**](docs/PartnerApi.md#update_canvas) | **PUT** /canvases/{id} | Update Canvas
|
|
312
|
-
*ApiSdkRb::PartnerApi* | [**update_composition**](docs/PartnerApi.md#update_composition) | **PUT** /compositions/{id} | Update Composition
|
|
313
|
-
*ApiSdkRb::PartnerApi* | [**update_composition_database_record**](docs/PartnerApi.md#update_composition_database_record) | **PUT** /compositions/{id}/database/{table}/{recordId} | Update Record In Composition Database
|
|
314
|
-
*ApiSdkRb::PartnerApi* | [**update_composition_status**](docs/PartnerApi.md#update_composition_status) | **PUT** /compositions/{id}/status | Update Composition Status
|
|
315
|
-
*ApiSdkRb::PartnerApi* | [**update_managed_user**](docs/PartnerApi.md#update_managed_user) | **PUT** /managed-users/{id} | Update Managed User
|
|
316
|
-
*ApiSdkRb::PartnerApi* | [**update_partner_entry_context_signing**](docs/PartnerApi.md#update_partner_entry_context_signing) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it
|
|
317
|
-
*ApiSdkRb::PartnerApi* | [**update_partner_notification_settings**](docs/PartnerApi.md#update_partner_notification_settings) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go
|
|
318
|
-
*ApiSdkRb::PartnerApi* | [**update_personal_workspace_domain**](docs/PartnerApi.md#update_personal_workspace_domain) | **PUT** /users/{id}/workspace/domains/{domainId} | Change a website on your list
|
|
319
|
-
*ApiSdkRb::PartnerApi* | [**update_user_api_key**](docs/PartnerApi.md#update_user_api_key) | **PUT** /users/{id}/keys/{keyId} | Rename an API key, or switch it off or on
|
|
320
|
-
*ApiSdkRb::PartnerApi* | [**upload_public_composition_adapter_file**](docs/PartnerApi.md#upload_public_composition_adapter_file) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget
|
|
321
|
-
*ApiSdkRb::PartnerApi* | [**uploads_get**](docs/PartnerApi.md#uploads_get) | **GET** /uploads | List the account's uploads
|
|
322
|
-
*ApiSdkRb::PartnerApi* | [**uploads_id_delete**](docs/PartnerApi.md#uploads_id_delete) | **DELETE** /uploads/{id} | Delete an upload
|
|
323
|
-
*ApiSdkRb::PartnerApi* | [**uploads_id_get**](docs/PartnerApi.md#uploads_id_get) | **GET** /uploads/{id} | Get an upload by id
|
|
324
|
-
*ApiSdkRb::PartnerApi* | [**uploads_limits_get**](docs/PartnerApi.md#uploads_limits_get) | **GET** /uploads/limits | Upload size limits and accepted file types
|
|
325
|
-
*ApiSdkRb::PartnerApi* | [**uploads_post**](docs/PartnerApi.md#uploads_post) | **POST** /uploads | Upload a file
|
|
326
|
-
*ApiSdkRb::PartnerApi* | [**validate_composition_content**](docs/PartnerApi.md#validate_composition_content) | **POST** /compositions/{id}/content/validate | Validate Content
|
|
327
|
-
*ApiSdkRb::PartnerApi* | [**validate_token**](docs/PartnerApi.md#validate_token) | **GET** /tokens/validate | Validate current authentication token
|
|
328
|
-
*ApiSdkRb::PartnerApi* | [**verify_partner_data_database**](docs/PartnerApi.md#verify_partner_data_database) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works
|
|
329
|
-
*ApiSdkRb::PartnerApi* | [**verify_partner_storage_destination**](docs/PartnerApi.md#verify_partner_storage_destination) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works
|
|
330
|
-
*ApiSdkRb::PartnersApi* | [**confirm_partner_adapter_connection_0**](docs/PartnersApi.md#confirm_partner_adapter_connection_0) | **POST** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm a partner's adapter address with the code that was emailed to it
|
|
331
|
-
*ApiSdkRb::PartnersApi* | [**create_partner_extra_credits_invoice_0**](docs/PartnersApi.md#create_partner_extra_credits_invoice_0) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner
|
|
332
|
-
*ApiSdkRb::PartnersApi* | [**get_my_partners_0**](docs/PartnersApi.md#get_my_partners_0) | **GET** /partners/mine | Find the partner you administer
|
|
333
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_adapter_connections_0**](docs/PartnersApi.md#get_partner_adapter_connections_0) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected
|
|
334
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_by_managed_user_0**](docs/PartnersApi.md#get_partner_analytics_by_managed_user_0) | **GET** /partners/{partnerId}/analytics/managed-users | What each managed user's widgets did
|
|
335
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_summary_0**](docs/PartnersApi.md#get_partner_analytics_summary_0) | **GET** /partners/{partnerId}/analytics/summary | What was done with a partner's published widgets
|
|
336
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_timeline_0**](docs/PartnersApi.md#get_partner_analytics_timeline_0) | **GET** /partners/{partnerId}/analytics/timeline | What was done with a partner's widgets, day by day
|
|
337
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_top_widgets_0**](docs/PartnersApi.md#get_partner_analytics_top_widgets_0) | **GET** /partners/{partnerId}/analytics/top-widgets | Which widgets were viewed the most
|
|
338
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_billing_overview_0**](docs/PartnersApi.md#get_partner_billing_overview_0) | **GET** /partners/{partnerId}/billing-overview | Get comprehensive partner billing overview
|
|
339
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_contract_0**](docs/PartnersApi.md#get_partner_contract_0) | **GET** /partners/{partnerId}/contract | Get a partner's contract
|
|
340
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_credit_balance_0**](docs/PartnersApi.md#get_partner_credit_balance_0) | **GET** /partners/{partnerId}/credits/balance | Get partner credit balance
|
|
341
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_credit_transactions_0**](docs/PartnersApi.md#get_partner_credit_transactions_0) | **GET** /partners/{partnerId}/credits/transactions | Get partner credit transaction history
|
|
342
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_data_database_0**](docs/PartnersApi.md#get_partner_data_database_0) | **GET** /partners/{partnerId}/data-database | See the Neon database a partner keeps the data of its compositions in
|
|
343
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_design_defaults_0**](docs/PartnersApi.md#get_partner_design_defaults_0) | **GET** /partners/{partnerId}/design-defaults | Read partner-wide design defaults
|
|
344
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_entry_context_signing_0**](docs/PartnersApi.md#get_partner_entry_context_signing_0) | **GET** /partners/{partnerId}/entry-context-signing | See how the context of your embeds is signed
|
|
345
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_notification_settings_0**](docs/PartnersApi.md#get_partner_notification_settings_0) | **GET** /partners/{partnerId}/notifications/settings | Where your notifications go
|
|
346
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_storage_destination_0**](docs/PartnersApi.md#get_partner_storage_destination_0) | **GET** /partners/{partnerId}/storage | Get where a partner's uploaded files are stored
|
|
347
|
-
*ApiSdkRb::PartnersApi* | [**get_partner_storage_usage_0**](docs/PartnersApi.md#get_partner_storage_usage_0) | **GET** /partners/{partnerId}/storage/usage | What a partner's customers store
|
|
348
|
-
*ApiSdkRb::PartnersApi* | [**list_partner_notification_deliveries_0**](docs/PartnersApi.md#list_partner_notification_deliveries_0) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you
|
|
349
|
-
*ApiSdkRb::PartnersApi* | [**list_partner_notifications_0**](docs/PartnersApi.md#list_partner_notifications_0) | **GET** /partners/{partnerId}/notifications | What your partner account was told
|
|
350
|
-
*ApiSdkRb::PartnersApi* | [**list_partner_presets_0**](docs/PartnersApi.md#list_partner_presets_0) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets
|
|
351
|
-
*ApiSdkRb::PartnersApi* | [**list_partner_workflow_presets_0**](docs/PartnersApi.md#list_partner_workflow_presets_0) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start
|
|
352
|
-
*ApiSdkRb::PartnersApi* | [**remove_partner_adapter_connection_0**](docs/PartnersApi.md#remove_partner_adapter_connection_0) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner
|
|
353
|
-
*ApiSdkRb::PartnersApi* | [**remove_partner_data_database_0**](docs/PartnersApi.md#remove_partner_data_database_0) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database
|
|
354
|
-
*ApiSdkRb::PartnersApi* | [**remove_partner_preset_0**](docs/PartnersApi.md#remove_partner_preset_0) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets
|
|
355
|
-
*ApiSdkRb::PartnersApi* | [**remove_partner_storage_destination_0**](docs/PartnersApi.md#remove_partner_storage_destination_0) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket
|
|
356
|
-
*ApiSdkRb::PartnersApi* | [**remove_partner_workflow_preset_0**](docs/PartnersApi.md#remove_partner_workflow_preset_0) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start
|
|
357
|
-
*ApiSdkRb::PartnersApi* | [**replay_partner_notification_delivery_0**](docs/PartnersApi.md#replay_partner_notification_delivery_0) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again
|
|
358
|
-
*ApiSdkRb::PartnersApi* | [**rotate_partner_entry_context_secret_0**](docs/PartnersApi.md#rotate_partner_entry_context_secret_0) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds
|
|
359
|
-
*ApiSdkRb::PartnersApi* | [**rotate_partner_webhook_secret_0**](docs/PartnersApi.md#rotate_partner_webhook_secret_0) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook
|
|
360
|
-
*ApiSdkRb::PartnersApi* | [**send_partner_notification_test_event_0**](docs/PartnersApi.md#send_partner_notification_test_event_0) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook
|
|
361
|
-
*ApiSdkRb::PartnersApi* | [**set_partner_adapter_connection_0**](docs/PartnersApi.md#set_partner_adapter_connection_0) | **PUT** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to a partner
|
|
362
|
-
*ApiSdkRb::PartnersApi* | [**set_partner_data_database_0**](docs/PartnersApi.md#set_partner_data_database_0) | **PUT** /partners/{partnerId}/data-database | Keep the data of a partner's compositions in a Neon database of its own
|
|
363
|
-
*ApiSdkRb::PartnersApi* | [**set_partner_design_defaults_0**](docs/PartnersApi.md#set_partner_design_defaults_0) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults
|
|
364
|
-
*ApiSdkRb::PartnersApi* | [**set_partner_preset_0**](docs/PartnersApi.md#set_partner_preset_0) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset
|
|
365
|
-
*ApiSdkRb::PartnersApi* | [**set_partner_storage_destination_0**](docs/PartnersApi.md#set_partner_storage_destination_0) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored
|
|
366
|
-
*ApiSdkRb::PartnersApi* | [**set_partner_workflow_preset_0**](docs/PartnersApi.md#set_partner_workflow_preset_0) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers
|
|
367
|
-
*ApiSdkRb::PartnersApi* | [**update_partner_entry_context_signing_0**](docs/PartnersApi.md#update_partner_entry_context_signing_0) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it
|
|
368
|
-
*ApiSdkRb::PartnersApi* | [**update_partner_notification_settings_0**](docs/PartnersApi.md#update_partner_notification_settings_0) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go
|
|
369
|
-
*ApiSdkRb::PartnersApi* | [**verify_partner_data_database_0**](docs/PartnersApi.md#verify_partner_data_database_0) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works
|
|
370
|
-
*ApiSdkRb::PartnersApi* | [**verify_partner_storage_destination_0**](docs/PartnersApi.md#verify_partner_storage_destination_0) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works
|
|
371
|
-
*ApiSdkRb::PublicEmbedApi* | [**call_public_composition_adapter_0**](docs/PublicEmbedApi.md#call_public_composition_adapter_0) | **POST** /embed/compositions/{compositionId}/adapters/{adapterId}/{operation} | Call a gateway operation of an adapter a published widget uses
|
|
372
|
-
*ApiSdkRb::PublicEmbedApi* | [**create_public_composition_entry_0**](docs/PublicEmbedApi.md#create_public_composition_entry_0) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway
|
|
373
|
-
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_embed_0**](docs/PublicEmbedApi.md#get_public_composition_embed_0) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL
|
|
374
|
-
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_iframe_0**](docs/PublicEmbedApi.md#get_public_composition_iframe_0) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values
|
|
375
|
-
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_0**](docs/PublicEmbedApi.md#get_public_workflow_0) | **GET** /embed/workflows/{workflowId} | Read the published Workflow of an embed
|
|
376
|
-
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_frame_0**](docs/PublicEmbedApi.md#get_public_workflow_frame_0) | **GET** /embed/workflows/{workflowId}/frame | Show a published Workflow in a page of its own
|
|
377
|
-
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_version_0**](docs/PublicEmbedApi.md#get_public_workflow_version_0) | **GET** /embed/workflows/{workflowId}/versions/{versionId} | Read one published version of a Workflow
|
|
378
|
-
*ApiSdkRb::PublicEmbedApi* | [**post_public_composition_embed_status_0**](docs/PublicEmbedApi.md#post_public_composition_embed_status_0) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed
|
|
379
|
-
*ApiSdkRb::PublicEmbedApi* | [**report_public_workflow_events_0**](docs/PublicEmbedApi.md#report_public_workflow_events_0) | **POST** /embed/workflows/{workflowId}/events | Report what visitors did in a Workflow, as counts
|
|
380
|
-
*ApiSdkRb::PublicEmbedApi* | [**upload_public_composition_adapter_file_0**](docs/PublicEmbedApi.md#upload_public_composition_adapter_file_0) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget
|
|
381
|
-
*ApiSdkRb::TokensApi* | [**validate_token_0**](docs/TokensApi.md#validate_token_0) | **GET** /tokens/validate | Validate current authentication token
|
|
382
|
-
*ApiSdkRb::UploadsApi* | [**uploads_get_0**](docs/UploadsApi.md#uploads_get_0) | **GET** /uploads | List the account's uploads
|
|
383
|
-
*ApiSdkRb::UploadsApi* | [**uploads_id_delete_0**](docs/UploadsApi.md#uploads_id_delete_0) | **DELETE** /uploads/{id} | Delete an upload
|
|
384
|
-
*ApiSdkRb::UploadsApi* | [**uploads_id_get_0**](docs/UploadsApi.md#uploads_id_get_0) | **GET** /uploads/{id} | Get an upload by id
|
|
385
|
-
*ApiSdkRb::UploadsApi* | [**uploads_limits_get_0**](docs/UploadsApi.md#uploads_limits_get_0) | **GET** /uploads/limits | Upload size limits and accepted file types
|
|
386
|
-
*ApiSdkRb::UploadsApi* | [**uploads_post_0**](docs/UploadsApi.md#uploads_post_0) | **POST** /uploads | Upload a file
|
|
387
|
-
*ApiSdkRb::UsersApi* | [**add_personal_workspace_domain_0**](docs/UsersApi.md#add_personal_workspace_domain_0) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets
|
|
388
|
-
*ApiSdkRb::UsersApi* | [**confirm_user_adapter_connection_0**](docs/UsersApi.md#confirm_user_adapter_connection_0) | **POST** /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm an adapter address with the code that was emailed to it
|
|
389
|
-
*ApiSdkRb::UsersApi* | [**create_user_api_key_0**](docs/UsersApi.md#create_user_api_key_0) | **POST** /users/{id}/keys | Create an API key
|
|
390
|
-
*ApiSdkRb::UsersApi* | [**delete_personal_workspace_domain_0**](docs/UsersApi.md#delete_personal_workspace_domain_0) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets
|
|
391
|
-
*ApiSdkRb::UsersApi* | [**delete_user_api_key_0**](docs/UsersApi.md#delete_user_api_key_0) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key
|
|
392
|
-
*ApiSdkRb::UsersApi* | [**get_personal_workspace_domains_0**](docs/UsersApi.md#get_personal_workspace_domains_0) | **GET** /users/{id}/workspace/domains | List the websites allowed to show your widgets
|
|
393
|
-
*ApiSdkRb::UsersApi* | [**get_user_adapter_connections_0**](docs/UsersApi.md#get_user_adapter_connections_0) | **GET** /users/{userId}/adapter-connections | See which adapter keys an account has connected
|
|
394
|
-
*ApiSdkRb::UsersApi* | [**get_user_api_key_usage_logs_0**](docs/UsersApi.md#get_user_api_key_usage_logs_0) | **GET** /users/{id}/api-keys/{keyId}/logs | Read what an API key was used for
|
|
395
|
-
*ApiSdkRb::UsersApi* | [**get_user_api_keys_0**](docs/UsersApi.md#get_user_api_keys_0) | **GET** /users/{id}/keys | List the API keys of an account
|
|
396
|
-
*ApiSdkRb::UsersApi* | [**remove_user_adapter_connection_0**](docs/UsersApi.md#remove_user_adapter_connection_0) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account
|
|
397
|
-
*ApiSdkRb::UsersApi* | [**set_user_adapter_connection_0**](docs/UsersApi.md#set_user_adapter_connection_0) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account
|
|
398
|
-
*ApiSdkRb::UsersApi* | [**update_personal_workspace_domain_0**](docs/UsersApi.md#update_personal_workspace_domain_0) | **PUT** /users/{id}/workspace/domains/{domainId} | Change a website on your list
|
|
399
|
-
*ApiSdkRb::UsersApi* | [**update_user_api_key_0**](docs/UsersApi.md#update_user_api_key_0) | **PUT** /users/{id}/keys/{keyId} | Rename an API key, or switch it off or on
|
|
400
|
-
*ApiSdkRb::WidgetsApi* | [**create_composition_from_widget_0**](docs/WidgetsApi.md#create_composition_from_widget_0) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call
|
|
401
|
-
*ApiSdkRb::WidgetsApi* | [**create_widget_0**](docs/WidgetsApi.md#create_widget_0) | **POST** /widgets | Create Widget
|
|
402
|
-
*ApiSdkRb::WidgetsApi* | [**get_widgets_0**](docs/WidgetsApi.md#get_widgets_0) | **GET** /widgets | List Widgets
|
|
403
|
-
*ApiSdkRb::WidgetsApi* | [**get_widgets_batch_0**](docs/WidgetsApi.md#get_widgets_batch_0) | **POST** /widgets/batch | Get Widgets Batch
|
|
404
|
-
*ApiSdkRb::WorkflowsApi* | [**archive_workspace_workflow_0**](docs/WorkflowsApi.md#archive_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/archive | Archive a Workflow
|
|
405
|
-
*ApiSdkRb::WorkflowsApi* | [**create_workspace_workflow_0**](docs/WorkflowsApi.md#create_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows | Create a Workflow
|
|
406
|
-
*ApiSdkRb::WorkflowsApi* | [**create_workspace_workflow_from_preset_0**](docs/WorkflowsApi.md#create_workspace_workflow_from_preset_0) | **POST** /workspaces/{workspaceId}/workflows/from-preset | Start a Workflow from a starting point
|
|
407
|
-
*ApiSdkRb::WorkflowsApi* | [**delete_workspace_workflow_0**](docs/WorkflowsApi.md#delete_workspace_workflow_0) | **DELETE** /workspaces/{workspaceId}/workflows/{workflowId} | Delete a Workflow
|
|
408
|
-
*ApiSdkRb::WorkflowsApi* | [**discard_workspace_workflow_changes_0**](docs/WorkflowsApi.md#discard_workspace_workflow_changes_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/discard | Discard the Unpublished Changes of a Workflow
|
|
409
|
-
*ApiSdkRb::WorkflowsApi* | [**duplicate_workspace_workflow_0**](docs/WorkflowsApi.md#duplicate_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/duplicate | Duplicate a Workflow
|
|
410
|
-
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_0**](docs/WorkflowsApi.md#get_workspace_workflow_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow
|
|
411
|
-
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_stats_0**](docs/WorkflowsApi.md#get_workspace_workflow_stats_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow
|
|
412
|
-
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_version_0**](docs/WorkflowsApi.md#get_workspace_workflow_version_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow
|
|
413
|
-
*ApiSdkRb::WorkflowsApi* | [**list_partner_workflow_presets_1**](docs/WorkflowsApi.md#list_partner_workflow_presets_1) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start
|
|
414
|
-
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_composition_options_0**](docs/WorkflowsApi.md#list_workspace_workflow_composition_options_0) | **GET** /workspaces/{workspaceId}/workflows/composition-options | List the compositions a workflow can show, and what each can do
|
|
415
|
-
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_presets_0**](docs/WorkflowsApi.md#list_workspace_workflow_presets_0) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow
|
|
416
|
-
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_versions_0**](docs/WorkflowsApi.md#list_workspace_workflow_versions_0) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow
|
|
417
|
-
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflows_0**](docs/WorkflowsApi.md#list_workspace_workflows_0) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace
|
|
418
|
-
*ApiSdkRb::WorkflowsApi* | [**pause_workspace_workflow_0**](docs/WorkflowsApi.md#pause_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow
|
|
419
|
-
*ApiSdkRb::WorkflowsApi* | [**publish_workspace_workflow_0**](docs/WorkflowsApi.md#publish_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow
|
|
420
|
-
*ApiSdkRb::WorkflowsApi* | [**remove_partner_workflow_preset_1**](docs/WorkflowsApi.md#remove_partner_workflow_preset_1) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start
|
|
421
|
-
*ApiSdkRb::WorkflowsApi* | [**restore_workspace_workflow_version_0**](docs/WorkflowsApi.md#restore_workspace_workflow_version_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft
|
|
422
|
-
*ApiSdkRb::WorkflowsApi* | [**resume_workspace_workflow_0**](docs/WorkflowsApi.md#resume_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow
|
|
423
|
-
*ApiSdkRb::WorkflowsApi* | [**save_workspace_workflow_0**](docs/WorkflowsApi.md#save_workspace_workflow_0) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow
|
|
424
|
-
*ApiSdkRb::WorkflowsApi* | [**set_partner_workflow_preset_1**](docs/WorkflowsApi.md#set_partner_workflow_preset_1) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers
|
|
425
|
-
*ApiSdkRb::WorkflowsApi* | [**unarchive_workspace_workflow_0**](docs/WorkflowsApi.md#unarchive_workspace_workflow_0) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow
|
|
426
|
-
*ApiSdkRb::WorkspacesApi* | [**archive_workspace_workflow_1**](docs/WorkspacesApi.md#archive_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/archive | Archive a Workflow
|
|
427
|
-
*ApiSdkRb::WorkspacesApi* | [**create_workspace_workflow_1**](docs/WorkspacesApi.md#create_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows | Create a Workflow
|
|
428
|
-
*ApiSdkRb::WorkspacesApi* | [**create_workspace_workflow_from_preset_1**](docs/WorkspacesApi.md#create_workspace_workflow_from_preset_1) | **POST** /workspaces/{workspaceId}/workflows/from-preset | Start a Workflow from a starting point
|
|
429
|
-
*ApiSdkRb::WorkspacesApi* | [**delete_workspace_workflow_1**](docs/WorkspacesApi.md#delete_workspace_workflow_1) | **DELETE** /workspaces/{workspaceId}/workflows/{workflowId} | Delete a Workflow
|
|
430
|
-
*ApiSdkRb::WorkspacesApi* | [**discard_workspace_workflow_changes_1**](docs/WorkspacesApi.md#discard_workspace_workflow_changes_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/discard | Discard the Unpublished Changes of a Workflow
|
|
431
|
-
*ApiSdkRb::WorkspacesApi* | [**duplicate_workspace_workflow_1**](docs/WorkspacesApi.md#duplicate_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/duplicate | Duplicate a Workflow
|
|
432
|
-
*ApiSdkRb::WorkspacesApi* | [**get_workspace_workflow_1**](docs/WorkspacesApi.md#get_workspace_workflow_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow
|
|
433
|
-
*ApiSdkRb::WorkspacesApi* | [**get_workspace_workflow_stats_1**](docs/WorkspacesApi.md#get_workspace_workflow_stats_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow
|
|
434
|
-
*ApiSdkRb::WorkspacesApi* | [**get_workspace_workflow_version_1**](docs/WorkspacesApi.md#get_workspace_workflow_version_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow
|
|
435
|
-
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflow_composition_options_1**](docs/WorkspacesApi.md#list_workspace_workflow_composition_options_1) | **GET** /workspaces/{workspaceId}/workflows/composition-options | List the compositions a workflow can show, and what each can do
|
|
436
|
-
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflow_presets_1**](docs/WorkspacesApi.md#list_workspace_workflow_presets_1) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow
|
|
437
|
-
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflow_versions_1**](docs/WorkspacesApi.md#list_workspace_workflow_versions_1) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow
|
|
438
|
-
*ApiSdkRb::WorkspacesApi* | [**list_workspace_workflows_1**](docs/WorkspacesApi.md#list_workspace_workflows_1) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace
|
|
439
|
-
*ApiSdkRb::WorkspacesApi* | [**pause_workspace_workflow_1**](docs/WorkspacesApi.md#pause_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow
|
|
440
|
-
*ApiSdkRb::WorkspacesApi* | [**publish_workspace_workflow_1**](docs/WorkspacesApi.md#publish_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow
|
|
441
|
-
*ApiSdkRb::WorkspacesApi* | [**restore_workspace_workflow_version_1**](docs/WorkspacesApi.md#restore_workspace_workflow_version_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft
|
|
442
|
-
*ApiSdkRb::WorkspacesApi* | [**resume_workspace_workflow_1**](docs/WorkspacesApi.md#resume_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow
|
|
443
|
-
*ApiSdkRb::WorkspacesApi* | [**save_workspace_workflow_1**](docs/WorkspacesApi.md#save_workspace_workflow_1) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow
|
|
444
|
-
*ApiSdkRb::WorkspacesApi* | [**unarchive_workspace_workflow_1**](docs/WorkspacesApi.md#unarchive_workspace_workflow_1) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow
|
|
89
|
+
*ApiSdkRb::BrandKitApi* | [**delete_brand_kit**](docs/BrandKitApi.md#delete_brand_kit) | **DELETE** /brand-kit | Reset the Brand Kit to the default
|
|
90
|
+
*ApiSdkRb::BrandKitApi* | [**delete_brand_kit_asset**](docs/BrandKitApi.md#delete_brand_kit_asset) | **DELETE** /brand-kit/assets/{assetId} | Remove a font or icon from the Brand Kit
|
|
91
|
+
*ApiSdkRb::BrandKitApi* | [**get_brand_kit**](docs/BrandKitApi.md#get_brand_kit) | **GET** /brand-kit | The Brand Kit of the current workspace
|
|
92
|
+
*ApiSdkRb::BrandKitApi* | [**patch_brand_kit**](docs/BrandKitApi.md#patch_brand_kit) | **PATCH** /brand-kit | Change part of the Brand Kit
|
|
93
|
+
*ApiSdkRb::BrandKitApi* | [**patch_brand_kit_asset**](docs/BrandKitApi.md#patch_brand_kit_asset) | **PATCH** /brand-kit/assets/{assetId} | Rename an icon or relabel a font variant
|
|
94
|
+
*ApiSdkRb::BrandKitApi* | [**post_brand_kit_font**](docs/BrandKitApi.md#post_brand_kit_font) | **POST** /brand-kit/fonts | Upload a font file to the Brand Kit
|
|
95
|
+
*ApiSdkRb::BrandKitApi* | [**post_brand_kit_icon**](docs/BrandKitApi.md#post_brand_kit_icon) | **POST** /brand-kit/icons | Add a named SVG icon to the Brand Kit
|
|
96
|
+
*ApiSdkRb::BrandKitApi* | [**put_brand_kit**](docs/BrandKitApi.md#put_brand_kit) | **PUT** /brand-kit | Save Brand Kit tokens
|
|
97
|
+
*ApiSdkRb::CanvasesApi* | [**create_canvas**](docs/CanvasesApi.md#create_canvas) | **POST** /canvases | Create Canvas
|
|
98
|
+
*ApiSdkRb::CanvasesApi* | [**delete_canvas**](docs/CanvasesApi.md#delete_canvas) | **DELETE** /canvases/{id} | Delete Canvas
|
|
99
|
+
*ApiSdkRb::CanvasesApi* | [**get_all_canvases**](docs/CanvasesApi.md#get_all_canvases) | **GET** /canvases | Get All Canvases
|
|
100
|
+
*ApiSdkRb::CanvasesApi* | [**get_canvas**](docs/CanvasesApi.md#get_canvas) | **GET** /canvases/{id} | Get Canvas
|
|
101
|
+
*ApiSdkRb::CanvasesApi* | [**update_canvas**](docs/CanvasesApi.md#update_canvas) | **PUT** /canvases/{id} | Update Canvas
|
|
102
|
+
*ApiSdkRb::CompositionsApi* | [**add_ai_answers_knowledge_document**](docs/CompositionsApi.md#add_ai_answers_knowledge_document) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents | Add a document for a widget's AI to answer from
|
|
103
|
+
*ApiSdkRb::CompositionsApi* | [**add_ai_answers_knowledge_file**](docs/CompositionsApi.md#add_ai_answers_knowledge_file) | **POST** /compositions/{id}/adapters/ai-answers/knowledge/documents/file | Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
104
|
+
*ApiSdkRb::CompositionsApi* | [**check_composition_access**](docs/CompositionsApi.md#check_composition_access) | **GET** /compositions/{id}/access | Check Composition Access
|
|
105
|
+
*ApiSdkRb::CompositionsApi* | [**create_composition**](docs/CompositionsApi.md#create_composition) | **POST** /compositions | Create Composition
|
|
106
|
+
*ApiSdkRb::CompositionsApi* | [**create_composition_content_item**](docs/CompositionsApi.md#create_composition_content_item) | **POST** /compositions/{id}/content/{list}/items | Add a content list item
|
|
107
|
+
*ApiSdkRb::CompositionsApi* | [**create_composition_database_record**](docs/CompositionsApi.md#create_composition_database_record) | **POST** /compositions/{id}/database/{table} | Create Record In Composition Database
|
|
108
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition**](docs/CompositionsApi.md#delete_composition) | **DELETE** /compositions/{id} | Delete Composition
|
|
109
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_content_item**](docs/CompositionsApi.md#delete_composition_content_item) | **DELETE** /compositions/{id}/content/{list}/items/{itemId} | Delete a content list item
|
|
110
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_data_source**](docs/CompositionsApi.md#delete_composition_data_source) | **DELETE** /compositions/{id}/data-source | Remove the composition data source binding
|
|
111
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_database_record**](docs/CompositionsApi.md#delete_composition_database_record) | **DELETE** /compositions/{id}/database/{table}/{recordId} | Delete Record From Composition Database
|
|
112
|
+
*ApiSdkRb::CompositionsApi* | [**delete_composition_entry_items**](docs/CompositionsApi.md#delete_composition_entry_items) | **DELETE** /compositions/{id}/entries/{table}/items | Delete composition entry items by id or host context
|
|
113
|
+
*ApiSdkRb::CompositionsApi* | [**describe_composition_entries**](docs/CompositionsApi.md#describe_composition_entries) | **GET** /compositions/{id}/entries | Describe What a Composition Keeps
|
|
114
|
+
*ApiSdkRb::CompositionsApi* | [**duplicate_composition**](docs/CompositionsApi.md#duplicate_composition) | **POST** /compositions/{id}/duplicate | Duplicate Composition
|
|
115
|
+
*ApiSdkRb::CompositionsApi* | [**export_composition_entry_items**](docs/CompositionsApi.md#export_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/export | Export composition entry items
|
|
116
|
+
*ApiSdkRb::CompositionsApi* | [**get_ai_answers_knowledge**](docs/CompositionsApi.md#get_ai_answers_knowledge) | **GET** /compositions/{id}/adapters/ai-answers/knowledge | See the documents a widget's AI answers from
|
|
117
|
+
*ApiSdkRb::CompositionsApi* | [**get_all_compositions**](docs/CompositionsApi.md#get_all_compositions) | **GET** /compositions | Get All Compositions
|
|
118
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_by_id**](docs/CompositionsApi.md#get_composition_by_id) | **GET** /compositions/{id} | Get Composition
|
|
119
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_content**](docs/CompositionsApi.md#get_composition_content) | **GET** /compositions/{id}/content | Get Current Content
|
|
120
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_content_schema**](docs/CompositionsApi.md#get_composition_content_schema) | **GET** /compositions/{id}/schema/content | Get Content Schema
|
|
121
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_data_source**](docs/CompositionsApi.md#get_composition_data_source) | **GET** /compositions/{id}/data-source | Read the composition data source binding
|
|
122
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_database_record**](docs/CompositionsApi.md#get_composition_database_record) | **GET** /compositions/{id}/database/{table}/{recordId} | Get Record From Composition Database
|
|
123
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_database_records**](docs/CompositionsApi.md#get_composition_database_records) | **GET** /compositions/{id}/database/{table} | Get All Records From Composition Database Table
|
|
124
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_design**](docs/CompositionsApi.md#get_composition_design) | **GET** /compositions/{id}/design | Get Composition Design
|
|
125
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_design_schema**](docs/CompositionsApi.md#get_composition_design_schema) | **GET** /compositions/{id}/schema/design | Get Design Schema
|
|
126
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_embed_schema**](docs/CompositionsApi.md#get_composition_embed_schema) | **GET** /compositions/{id}/schema/embed | Get Embed Schema
|
|
127
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_embed_settings**](docs/CompositionsApi.md#get_composition_embed_settings) | **GET** /compositions/{id}/embed-settings | Get Composition Embed Settings
|
|
128
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_preview**](docs/CompositionsApi.md#get_composition_preview) | **GET** /compositions/{id}/preview | Get Composition Preview
|
|
129
|
+
*ApiSdkRb::CompositionsApi* | [**get_composition_versions**](docs/CompositionsApi.md#get_composition_versions) | **GET** /compositions/{id}/versions | Get Composition Versions
|
|
130
|
+
*ApiSdkRb::CompositionsApi* | [**get_compositions_batch**](docs/CompositionsApi.md#get_compositions_batch) | **POST** /compositions/batch | Get Compositions Batch
|
|
131
|
+
*ApiSdkRb::CompositionsApi* | [**list_composition_entry_items**](docs/CompositionsApi.md#list_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/items | List composition entry items with paging and filters
|
|
132
|
+
*ApiSdkRb::CompositionsApi* | [**patch_composition_content_item**](docs/CompositionsApi.md#patch_composition_content_item) | **PATCH** /compositions/{id}/content/{list}/items/{itemId} | Update a content list item
|
|
133
|
+
*ApiSdkRb::CompositionsApi* | [**read_composition_entries**](docs/CompositionsApi.md#read_composition_entries) | **GET** /compositions/{id}/entries/{table} | Read the Entries of a Composition's Table
|
|
134
|
+
*ApiSdkRb::CompositionsApi* | [**remove_ai_answers_knowledge_document**](docs/CompositionsApi.md#remove_ai_answers_knowledge_document) | **DELETE** /compositions/{id}/adapters/ai-answers/knowledge/documents/{documentId} | Remove a document from a widget's knowledge base
|
|
135
|
+
*ApiSdkRb::CompositionsApi* | [**set_composition_data_source**](docs/CompositionsApi.md#set_composition_data_source) | **PUT** /compositions/{id}/data-source | Bind a public JSON data source for embed refresh
|
|
136
|
+
*ApiSdkRb::CompositionsApi* | [**set_dynamic_content**](docs/CompositionsApi.md#set_dynamic_content) | **PUT** /compositions/{id}/content | Set Dynamic Content
|
|
137
|
+
*ApiSdkRb::CompositionsApi* | [**update_composition**](docs/CompositionsApi.md#update_composition) | **PUT** /compositions/{id} | Update Composition
|
|
138
|
+
*ApiSdkRb::CompositionsApi* | [**update_composition_database_record**](docs/CompositionsApi.md#update_composition_database_record) | **PUT** /compositions/{id}/database/{table}/{recordId} | Update Record In Composition Database
|
|
139
|
+
*ApiSdkRb::CompositionsApi* | [**update_composition_status**](docs/CompositionsApi.md#update_composition_status) | **PUT** /compositions/{id}/status | Update Composition Status
|
|
140
|
+
*ApiSdkRb::CompositionsApi* | [**validate_composition_content**](docs/CompositionsApi.md#validate_composition_content) | **POST** /compositions/{id}/content/validate | Validate Content
|
|
141
|
+
*ApiSdkRb::CreditsApi* | [**get_user_credit_balance**](docs/CreditsApi.md#get_user_credit_balance) | **GET** /credits/user/{userId}/balance | Get an account's credit balance
|
|
142
|
+
*ApiSdkRb::CreditsApi* | [**get_user_credit_transactions**](docs/CreditsApi.md#get_user_credit_transactions) | **GET** /credits/user/{userId}/transactions | List an account's credit ledger
|
|
143
|
+
*ApiSdkRb::EntitlementsApi* | [**get_managed_user_entitlements**](docs/EntitlementsApi.md#get_managed_user_entitlements) | **GET** /entitlements/managed-users/{managedUserId} | Get managed user entitlements
|
|
144
|
+
*ApiSdkRb::EntitlementsApi* | [**get_partner_entitlements**](docs/EntitlementsApi.md#get_partner_entitlements) | **GET** /entitlements/partners/{partnerId} | Get partner entitlements
|
|
145
|
+
*ApiSdkRb::InvoicesApi* | [**get_invoices_by_partner_id**](docs/InvoicesApi.md#get_invoices_by_partner_id) | **GET** /invoices/partner/{partnerId} | List a partner's invoices
|
|
146
|
+
*ApiSdkRb::ManagedUsersApi* | [**copy_preset_for_managed_user**](docs/ManagedUsersApi.md#copy_preset_for_managed_user) | **POST** /managed-users/{id}/presets/{key}/copy | Give a managed user a copy of one of your presets
|
|
147
|
+
*ApiSdkRb::ManagedUsersApi* | [**create_composition_from_preset**](docs/ManagedUsersApi.md#create_composition_from_preset) | **POST** /managed-users/{id}/presets/{key}/composition | Create a composition from one of your presets in one call
|
|
148
|
+
*ApiSdkRb::ManagedUsersApi* | [**create_managed_user**](docs/ManagedUsersApi.md#create_managed_user) | **POST** /managed-users | Create Managed User
|
|
149
|
+
*ApiSdkRb::ManagedUsersApi* | [**create_managed_user_editor_session**](docs/ManagedUsersApi.md#create_managed_user_editor_session) | **POST** /managed-users/{id}/editor-sessions | Create an editor session for a managed user
|
|
150
|
+
*ApiSdkRb::ManagedUsersApi* | [**delete_managed_user**](docs/ManagedUsersApi.md#delete_managed_user) | **DELETE** /managed-users/{id} | Delete Managed User
|
|
151
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_all_managed_users**](docs/ManagedUsersApi.md#get_all_managed_users) | **GET** /managed-users | Get Managed Users
|
|
152
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_by_id**](docs/ManagedUsersApi.md#get_managed_user_by_id) | **GET** /managed-users/{id} | Get Managed User By ID
|
|
153
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_design_defaults**](docs/ManagedUsersApi.md#get_managed_user_design_defaults) | **GET** /managed-users/{id}/design-defaults | Read design defaults for one managed user
|
|
154
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_limits**](docs/ManagedUsersApi.md#get_managed_user_limits) | **GET** /managed-users/{id}/limits | Read monthly credit cap and usage for one managed user
|
|
155
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_storage_usage**](docs/ManagedUsersApi.md#get_managed_user_storage_usage) | **GET** /managed-users/{id}/storage-usage | Storage used by one managed user's uploads
|
|
156
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_user_usage**](docs/ManagedUsersApi.md#get_managed_user_usage) | **GET** /managed-users/{id}/usage | What a managed user's editor sessions spent
|
|
157
|
+
*ApiSdkRb::ManagedUsersApi* | [**get_managed_users_by_manager_id**](docs/ManagedUsersApi.md#get_managed_users_by_manager_id) | **GET** /users/{managerId}/managed-users | Get Managed Users By Manager
|
|
158
|
+
*ApiSdkRb::ManagedUsersApi* | [**list_managed_user_entries**](docs/ManagedUsersApi.md#list_managed_user_entries) | **GET** /managed-users/{id}/entries | List entries across a managed user's compositions
|
|
159
|
+
*ApiSdkRb::ManagedUsersApi* | [**revoke_managed_user_editor_session**](docs/ManagedUsersApi.md#revoke_managed_user_editor_session) | **DELETE** /managed-users/{id}/editor-sessions/{sessionId} | End one editor session of a managed user
|
|
160
|
+
*ApiSdkRb::ManagedUsersApi* | [**revoke_managed_user_editor_sessions**](docs/ManagedUsersApi.md#revoke_managed_user_editor_sessions) | **DELETE** /managed-users/{id}/editor-sessions | End every editor session of a managed user
|
|
161
|
+
*ApiSdkRb::ManagedUsersApi* | [**set_managed_user_design_defaults**](docs/ManagedUsersApi.md#set_managed_user_design_defaults) | **PUT** /managed-users/{id}/design-defaults | Set or clear design defaults for one managed user
|
|
162
|
+
*ApiSdkRb::ManagedUsersApi* | [**set_managed_user_limits**](docs/ManagedUsersApi.md#set_managed_user_limits) | **PUT** /managed-users/{id}/limits | Set or clear the monthly credit cap for one managed user
|
|
163
|
+
*ApiSdkRb::ManagedUsersApi* | [**update_managed_user**](docs/ManagedUsersApi.md#update_managed_user) | **PUT** /managed-users/{id} | Update Managed User
|
|
164
|
+
*ApiSdkRb::OperationsApi* | [**get_operation**](docs/OperationsApi.md#get_operation) | **GET** /operations/{id} | Get operation status
|
|
165
|
+
*ApiSdkRb::PartnersApi* | [**confirm_partner_adapter_connection**](docs/PartnersApi.md#confirm_partner_adapter_connection) | **POST** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm a partner's adapter address with the code that was emailed to it
|
|
166
|
+
*ApiSdkRb::PartnersApi* | [**create_partner_extra_credits_invoice**](docs/PartnersApi.md#create_partner_extra_credits_invoice) | **POST** /partners/{partnerId}/credits/extra-invoice | Buy extra credits for a partner
|
|
167
|
+
*ApiSdkRb::PartnersApi* | [**get_my_partners**](docs/PartnersApi.md#get_my_partners) | **GET** /partners/mine | Find the partner you administer
|
|
168
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_adapter_connections**](docs/PartnersApi.md#get_partner_adapter_connections) | **GET** /partners/{partnerId}/adapter-connections | See which adapter keys a partner has connected
|
|
169
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_by_managed_user**](docs/PartnersApi.md#get_partner_analytics_by_managed_user) | **GET** /partners/{partnerId}/analytics/managed-users | What each managed user's widgets did
|
|
170
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_summary**](docs/PartnersApi.md#get_partner_analytics_summary) | **GET** /partners/{partnerId}/analytics/summary | What was done with a partner's published widgets
|
|
171
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_timeline**](docs/PartnersApi.md#get_partner_analytics_timeline) | **GET** /partners/{partnerId}/analytics/timeline | What was done with a partner's widgets, day by day
|
|
172
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_analytics_top_widgets**](docs/PartnersApi.md#get_partner_analytics_top_widgets) | **GET** /partners/{partnerId}/analytics/top-widgets | Which widgets were viewed the most
|
|
173
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_billing_overview**](docs/PartnersApi.md#get_partner_billing_overview) | **GET** /partners/{partnerId}/billing-overview | Get comprehensive partner billing overview
|
|
174
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_contract**](docs/PartnersApi.md#get_partner_contract) | **GET** /partners/{partnerId}/contract | Get a partner's contract
|
|
175
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_credit_balance**](docs/PartnersApi.md#get_partner_credit_balance) | **GET** /partners/{partnerId}/credits/balance | Get partner credit balance
|
|
176
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_credit_transactions**](docs/PartnersApi.md#get_partner_credit_transactions) | **GET** /partners/{partnerId}/credits/transactions | Get partner credit transaction history
|
|
177
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_data_database**](docs/PartnersApi.md#get_partner_data_database) | **GET** /partners/{partnerId}/data-database | See the Neon database a partner keeps the data of its compositions in
|
|
178
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_design_defaults**](docs/PartnersApi.md#get_partner_design_defaults) | **GET** /partners/{partnerId}/design-defaults | Read partner-wide design defaults
|
|
179
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_entry_context_signing**](docs/PartnersApi.md#get_partner_entry_context_signing) | **GET** /partners/{partnerId}/entry-context-signing | See how the context of your embeds is signed
|
|
180
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_notification_settings**](docs/PartnersApi.md#get_partner_notification_settings) | **GET** /partners/{partnerId}/notifications/settings | Where your notifications go
|
|
181
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_storage_destination**](docs/PartnersApi.md#get_partner_storage_destination) | **GET** /partners/{partnerId}/storage | Get where a partner's uploaded files are stored
|
|
182
|
+
*ApiSdkRb::PartnersApi* | [**get_partner_storage_usage**](docs/PartnersApi.md#get_partner_storage_usage) | **GET** /partners/{partnerId}/storage/usage | What a partner's customers store
|
|
183
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_notification_deliveries**](docs/PartnersApi.md#list_partner_notification_deliveries) | **GET** /partners/{partnerId}/notifications/deliveries | How your notifications reached you
|
|
184
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_notifications**](docs/PartnersApi.md#list_partner_notifications) | **GET** /partners/{partnerId}/notifications | What your partner account was told
|
|
185
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_presets**](docs/PartnersApi.md#list_partner_presets) | **GET** /partners/{partnerId}/presets | List the widgets a partner offers as presets
|
|
186
|
+
*ApiSdkRb::PartnersApi* | [**list_partner_workflow_presets**](docs/PartnersApi.md#list_partner_workflow_presets) | **GET** /partners/{partnerId}/workflow-presets | List the workflows a partner offers as places to start
|
|
187
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_adapter_connection**](docs/PartnersApi.md#remove_partner_adapter_connection) | **DELETE** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from a partner
|
|
188
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_data_database**](docs/PartnersApi.md#remove_partner_data_database) | **DELETE** /partners/{partnerId}/data-database | Stop keeping the data of a partner's compositions in its own database
|
|
189
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_preset**](docs/PartnersApi.md#remove_partner_preset) | **DELETE** /partners/{partnerId}/presets/{key} | Take a widget off the partner's presets
|
|
190
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_storage_destination**](docs/PartnersApi.md#remove_partner_storage_destination) | **DELETE** /partners/{partnerId}/storage | Stop storing a partner's uploaded files in its own bucket
|
|
191
|
+
*ApiSdkRb::PartnersApi* | [**remove_partner_workflow_preset**](docs/PartnersApi.md#remove_partner_workflow_preset) | **DELETE** /partners/{partnerId}/workflow-presets/{key} | Stop offering a workflow as a place to start
|
|
192
|
+
*ApiSdkRb::PartnersApi* | [**replay_partner_notification_delivery**](docs/PartnersApi.md#replay_partner_notification_delivery) | **POST** /partners/{partnerId}/notifications/deliveries/{deliveryId}/replay | Send a webhook delivery again
|
|
193
|
+
*ApiSdkRb::PartnersApi* | [**rotate_partner_entry_context_secret**](docs/PartnersApi.md#rotate_partner_entry_context_secret) | **POST** /partners/{partnerId}/entry-context-signing/secret | Make a secret to sign the context of your embeds
|
|
194
|
+
*ApiSdkRb::PartnersApi* | [**rotate_partner_webhook_secret**](docs/PartnersApi.md#rotate_partner_webhook_secret) | **POST** /partners/{partnerId}/notifications/webhook-secret | Make a new secret for your webhook
|
|
195
|
+
*ApiSdkRb::PartnersApi* | [**send_partner_notification_test_event**](docs/PartnersApi.md#send_partner_notification_test_event) | **POST** /partners/{partnerId}/notifications/test-event | Send a test event to your webhook
|
|
196
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_adapter_connection**](docs/PartnersApi.md#set_partner_adapter_connection) | **PUT** /partners/{partnerId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to a partner
|
|
197
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_data_database**](docs/PartnersApi.md#set_partner_data_database) | **PUT** /partners/{partnerId}/data-database | Keep the data of a partner's compositions in a Neon database of its own
|
|
198
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_design_defaults**](docs/PartnersApi.md#set_partner_design_defaults) | **PUT** /partners/{partnerId}/design-defaults | Set or clear partner-wide design defaults
|
|
199
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_preset**](docs/PartnersApi.md#set_partner_preset) | **PUT** /partners/{partnerId}/presets/{key} | Make a widget a preset, or replace a preset
|
|
200
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_storage_destination**](docs/PartnersApi.md#set_partner_storage_destination) | **PUT** /partners/{partnerId}/storage | Set where a partner's uploaded files are stored
|
|
201
|
+
*ApiSdkRb::PartnersApi* | [**set_partner_workflow_preset**](docs/PartnersApi.md#set_partner_workflow_preset) | **PUT** /partners/{partnerId}/workflow-presets/{key} | Offer a workflow as a place to start, or replace what a key offers
|
|
202
|
+
*ApiSdkRb::PartnersApi* | [**update_partner_entry_context_signing**](docs/PartnersApi.md#update_partner_entry_context_signing) | **PUT** /partners/{partnerId}/entry-context-signing | Require a signed context, or stop requiring it
|
|
203
|
+
*ApiSdkRb::PartnersApi* | [**update_partner_notification_settings**](docs/PartnersApi.md#update_partner_notification_settings) | **PUT** /partners/{partnerId}/notifications/settings | Choose where your notifications go
|
|
204
|
+
*ApiSdkRb::PartnersApi* | [**verify_partner_data_database**](docs/PartnersApi.md#verify_partner_data_database) | **POST** /partners/{partnerId}/data-database/verify | Check that a partner's own database still works
|
|
205
|
+
*ApiSdkRb::PartnersApi* | [**verify_partner_storage_destination**](docs/PartnersApi.md#verify_partner_storage_destination) | **POST** /partners/{partnerId}/storage/verify | Check that a partner's storage destination still works
|
|
206
|
+
*ApiSdkRb::PublicEmbedApi* | [**call_public_composition_adapter**](docs/PublicEmbedApi.md#call_public_composition_adapter) | **POST** /embed/compositions/{compositionId}/adapters/{adapterId}/{operation} | Call a gateway operation of an adapter a published widget uses
|
|
207
|
+
*ApiSdkRb::PublicEmbedApi* | [**create_public_composition_entry**](docs/PublicEmbedApi.md#create_public_composition_entry) | **POST** /embed/compositions/{compositionId}/entries/{table} | Append a visitor entry through the gateway
|
|
208
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_embed**](docs/PublicEmbedApi.md#get_public_composition_embed) | **GET** /embed/compositions/{compositionId} | Resolve a composition UUID to a published widget URL
|
|
209
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_composition_iframe**](docs/PublicEmbedApi.md#get_public_composition_iframe) | **GET** /embed/compositions/{compositionId}/frame | Embed a published composition with its saved values
|
|
210
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow**](docs/PublicEmbedApi.md#get_public_workflow) | **GET** /embed/workflows/{workflowId} | Read the published Workflow of an embed
|
|
211
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_frame**](docs/PublicEmbedApi.md#get_public_workflow_frame) | **GET** /embed/workflows/{workflowId}/frame | Show a published Workflow in a page of its own
|
|
212
|
+
*ApiSdkRb::PublicEmbedApi* | [**get_public_workflow_version**](docs/PublicEmbedApi.md#get_public_workflow_version) | **GET** /embed/workflows/{workflowId}/versions/{versionId} | Read one published version of a Workflow
|
|
213
|
+
*ApiSdkRb::PublicEmbedApi* | [**post_public_composition_embed_status**](docs/PublicEmbedApi.md#post_public_composition_embed_status) | **POST** /embed/compositions/status | Batch-check whether compositions are currently served for embed
|
|
214
|
+
*ApiSdkRb::PublicEmbedApi* | [**report_public_workflow_events**](docs/PublicEmbedApi.md#report_public_workflow_events) | **POST** /embed/workflows/{workflowId}/events | Report what visitors did in a Workflow, as counts
|
|
215
|
+
*ApiSdkRb::PublicEmbedApi* | [**upload_public_composition_adapter_file**](docs/PublicEmbedApi.md#upload_public_composition_adapter_file) | **PUT** /embed/compositions/{compositionId}/adapters/upload/files/{ticket} | Send the file a visitor chose through the upload adapter of a published widget
|
|
216
|
+
*ApiSdkRb::TokensApi* | [**validate_token**](docs/TokensApi.md#validate_token) | **GET** /tokens/validate | Validate current authentication token
|
|
217
|
+
*ApiSdkRb::UploadsApi* | [**delete_upload**](docs/UploadsApi.md#delete_upload) | **DELETE** /uploads/{id} | Delete an upload
|
|
218
|
+
*ApiSdkRb::UploadsApi* | [**get_upload**](docs/UploadsApi.md#get_upload) | **GET** /uploads/{id} | Get an upload by id
|
|
219
|
+
*ApiSdkRb::UploadsApi* | [**get_upload_limits**](docs/UploadsApi.md#get_upload_limits) | **GET** /uploads/limits | Upload size limits and accepted file types
|
|
220
|
+
*ApiSdkRb::UploadsApi* | [**list_uploads**](docs/UploadsApi.md#list_uploads) | **GET** /uploads | List the account's uploads
|
|
221
|
+
*ApiSdkRb::UploadsApi* | [**upload_file**](docs/UploadsApi.md#upload_file) | **POST** /uploads | Upload a file
|
|
222
|
+
*ApiSdkRb::UsersApi* | [**add_personal_workspace_domain**](docs/UsersApi.md#add_personal_workspace_domain) | **POST** /users/{id}/workspace/domains | Allow a website to show your widgets
|
|
223
|
+
*ApiSdkRb::UsersApi* | [**confirm_user_adapter_connection**](docs/UsersApi.md#confirm_user_adapter_connection) | **POST** /users/{userId}/adapter-connections/{adapterId}/{credentialKey}/confirm | Confirm an adapter address with the code that was emailed to it
|
|
224
|
+
*ApiSdkRb::UsersApi* | [**create_user_api_key**](docs/UsersApi.md#create_user_api_key) | **POST** /users/{id}/keys | Create an API key
|
|
225
|
+
*ApiSdkRb::UsersApi* | [**delete_personal_workspace_domain**](docs/UsersApi.md#delete_personal_workspace_domain) | **DELETE** /users/{id}/workspace/domains/{domainId} | Stop allowing a website to show your widgets
|
|
226
|
+
*ApiSdkRb::UsersApi* | [**delete_user_api_key**](docs/UsersApi.md#delete_user_api_key) | **DELETE** /users/{id}/keys/{keyId} | Delete an API key
|
|
227
|
+
*ApiSdkRb::UsersApi* | [**get_personal_workspace_domains**](docs/UsersApi.md#get_personal_workspace_domains) | **GET** /users/{id}/workspace/domains | List the websites allowed to show your widgets
|
|
228
|
+
*ApiSdkRb::UsersApi* | [**get_user_adapter_connections**](docs/UsersApi.md#get_user_adapter_connections) | **GET** /users/{userId}/adapter-connections | See which adapter keys an account has connected
|
|
229
|
+
*ApiSdkRb::UsersApi* | [**get_user_api_key_usage_logs**](docs/UsersApi.md#get_user_api_key_usage_logs) | **GET** /users/{id}/api-keys/{keyId}/logs | Read what an API key was used for
|
|
230
|
+
*ApiSdkRb::UsersApi* | [**get_user_api_keys**](docs/UsersApi.md#get_user_api_keys) | **GET** /users/{id}/keys | List the API keys of an account
|
|
231
|
+
*ApiSdkRb::UsersApi* | [**remove_user_adapter_connection**](docs/UsersApi.md#remove_user_adapter_connection) | **DELETE** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Remove an adapter key from an account
|
|
232
|
+
*ApiSdkRb::UsersApi* | [**set_user_adapter_connection**](docs/UsersApi.md#set_user_adapter_connection) | **PUT** /users/{userId}/adapter-connections/{adapterId}/{credentialKey} | Connect an adapter key to an account
|
|
233
|
+
*ApiSdkRb::UsersApi* | [**update_personal_workspace_domain**](docs/UsersApi.md#update_personal_workspace_domain) | **PUT** /users/{id}/workspace/domains/{domainId} | Change a website on your list
|
|
234
|
+
*ApiSdkRb::UsersApi* | [**update_user_api_key**](docs/UsersApi.md#update_user_api_key) | **PUT** /users/{id}/keys/{keyId} | Rename an API key, or switch it off or on
|
|
235
|
+
*ApiSdkRb::WidgetsApi* | [**create_composition_from_widget**](docs/WidgetsApi.md#create_composition_from_widget) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call
|
|
236
|
+
*ApiSdkRb::WidgetsApi* | [**create_widget**](docs/WidgetsApi.md#create_widget) | **POST** /widgets | Create Widget
|
|
237
|
+
*ApiSdkRb::WidgetsApi* | [**get_widgets**](docs/WidgetsApi.md#get_widgets) | **GET** /widgets | List Widgets
|
|
238
|
+
*ApiSdkRb::WidgetsApi* | [**get_widgets_batch**](docs/WidgetsApi.md#get_widgets_batch) | **POST** /widgets/batch | Get Widgets Batch
|
|
239
|
+
*ApiSdkRb::WorkflowsApi* | [**archive_workspace_workflow**](docs/WorkflowsApi.md#archive_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/archive | Archive a Workflow
|
|
240
|
+
*ApiSdkRb::WorkflowsApi* | [**create_workspace_workflow**](docs/WorkflowsApi.md#create_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows | Create a Workflow
|
|
241
|
+
*ApiSdkRb::WorkflowsApi* | [**create_workspace_workflow_from_preset**](docs/WorkflowsApi.md#create_workspace_workflow_from_preset) | **POST** /workspaces/{workspaceId}/workflows/from-preset | Start a Workflow from a starting point
|
|
242
|
+
*ApiSdkRb::WorkflowsApi* | [**delete_workspace_workflow**](docs/WorkflowsApi.md#delete_workspace_workflow) | **DELETE** /workspaces/{workspaceId}/workflows/{workflowId} | Delete a Workflow
|
|
243
|
+
*ApiSdkRb::WorkflowsApi* | [**discard_workspace_workflow_changes**](docs/WorkflowsApi.md#discard_workspace_workflow_changes) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/discard | Discard the Unpublished Changes of a Workflow
|
|
244
|
+
*ApiSdkRb::WorkflowsApi* | [**duplicate_workspace_workflow**](docs/WorkflowsApi.md#duplicate_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/duplicate | Duplicate a Workflow
|
|
245
|
+
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow**](docs/WorkflowsApi.md#get_workspace_workflow) | **GET** /workspaces/{workspaceId}/workflows/{workflowId} | Get a Workflow
|
|
246
|
+
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_stats**](docs/WorkflowsApi.md#get_workspace_workflow_stats) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/stats | Get what Visitors Did in a Workflow
|
|
247
|
+
*ApiSdkRb::WorkflowsApi* | [**get_workspace_workflow_version**](docs/WorkflowsApi.md#get_workspace_workflow_version) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId} | Get a Published Version of a Workflow
|
|
248
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_composition_options**](docs/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
|
|
249
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_presets**](docs/WorkflowsApi.md#list_workspace_workflow_presets) | **GET** /workspaces/{workspaceId}/workflows/presets | List the starting points for a new Workflow
|
|
250
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflow_versions**](docs/WorkflowsApi.md#list_workspace_workflow_versions) | **GET** /workspaces/{workspaceId}/workflows/{workflowId}/versions | List the Published Versions of a Workflow
|
|
251
|
+
*ApiSdkRb::WorkflowsApi* | [**list_workspace_workflows**](docs/WorkflowsApi.md#list_workspace_workflows) | **GET** /workspaces/{workspaceId}/workflows | List the Workflows of a Workspace
|
|
252
|
+
*ApiSdkRb::WorkflowsApi* | [**pause_workspace_workflow**](docs/WorkflowsApi.md#pause_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/pause | Pause a Workflow
|
|
253
|
+
*ApiSdkRb::WorkflowsApi* | [**publish_workspace_workflow**](docs/WorkflowsApi.md#publish_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/publish | Publish the Draft of a Workflow
|
|
254
|
+
*ApiSdkRb::WorkflowsApi* | [**restore_workspace_workflow_version**](docs/WorkflowsApi.md#restore_workspace_workflow_version) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/versions/{versionId}/restore | Restore a Version of a Workflow into the Draft
|
|
255
|
+
*ApiSdkRb::WorkflowsApi* | [**resume_workspace_workflow**](docs/WorkflowsApi.md#resume_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/resume | Resume a Paused Workflow
|
|
256
|
+
*ApiSdkRb::WorkflowsApi* | [**save_workspace_workflow**](docs/WorkflowsApi.md#save_workspace_workflow) | **PUT** /workspaces/{workspaceId}/workflows/{workflowId} | Save the Draft of a Workflow
|
|
257
|
+
*ApiSdkRb::WorkflowsApi* | [**unarchive_workspace_workflow**](docs/WorkflowsApi.md#unarchive_workspace_workflow) | **POST** /workspaces/{workspaceId}/workflows/{workflowId}/unarchive | Unarchive a Workflow
|
|
445
258
|
|
|
446
259
|
|
|
447
260
|
## Documentation for Models
|
|
@@ -449,13 +262,17 @@ Class | Method | HTTP request | Description
|
|
|
449
262
|
- [ApiSdkRb::AccountCreditBalance](docs/AccountCreditBalance.md)
|
|
450
263
|
- [ApiSdkRb::AccountCreditBalanceResponse](docs/AccountCreditBalanceResponse.md)
|
|
451
264
|
- [ApiSdkRb::AccountCreditTransaction](docs/AccountCreditTransaction.md)
|
|
265
|
+
- [ApiSdkRb::AccountCreditTransactionListResponse](docs/AccountCreditTransactionListResponse.md)
|
|
452
266
|
- [ApiSdkRb::AdapterConnection](docs/AdapterConnection.md)
|
|
267
|
+
- [ApiSdkRb::AdapterConnectionListResponse](docs/AdapterConnectionListResponse.md)
|
|
453
268
|
- [ApiSdkRb::AdapterConnectionRemoval](docs/AdapterConnectionRemoval.md)
|
|
454
|
-
- [ApiSdkRb::
|
|
269
|
+
- [ApiSdkRb::AdapterConnectionRemovalResponse](docs/AdapterConnectionRemovalResponse.md)
|
|
270
|
+
- [ApiSdkRb::AdapterConnectionResponse](docs/AdapterConnectionResponse.md)
|
|
455
271
|
- [ApiSdkRb::AddAiAnswersKnowledgeDocumentRequest](docs/AddAiAnswersKnowledgeDocumentRequest.md)
|
|
456
272
|
- [ApiSdkRb::AddDomainRequest](docs/AddDomainRequest.md)
|
|
457
273
|
- [ApiSdkRb::AiAnswersKnowledge](docs/AiAnswersKnowledge.md)
|
|
458
274
|
- [ApiSdkRb::AiAnswersKnowledgeDocument](docs/AiAnswersKnowledgeDocument.md)
|
|
275
|
+
- [ApiSdkRb::AiAnswersKnowledgeDocumentResponse](docs/AiAnswersKnowledgeDocumentResponse.md)
|
|
459
276
|
- [ApiSdkRb::AiAnswersKnowledgeRemoval](docs/AiAnswersKnowledgeRemoval.md)
|
|
460
277
|
- [ApiSdkRb::AiAnswersKnowledgeTotals](docs/AiAnswersKnowledgeTotals.md)
|
|
461
278
|
- [ApiSdkRb::ApiKeyScope](docs/ApiKeyScope.md)
|
|
@@ -469,6 +286,7 @@ Class | Method | HTTP request | Description
|
|
|
469
286
|
- [ApiSdkRb::BrandKitViewOwner](docs/BrandKitViewOwner.md)
|
|
470
287
|
- [ApiSdkRb::BrandKitViewResponse](docs/BrandKitViewResponse.md)
|
|
471
288
|
- [ApiSdkRb::BrandSpacing](docs/BrandSpacing.md)
|
|
289
|
+
- [ApiSdkRb::BrandTextStyle](docs/BrandTextStyle.md)
|
|
472
290
|
- [ApiSdkRb::Canvas](docs/Canvas.md)
|
|
473
291
|
- [ApiSdkRb::CanvasResponse](docs/CanvasResponse.md)
|
|
474
292
|
- [ApiSdkRb::CheckCompositionAccessResponse](docs/CheckCompositionAccessResponse.md)
|
|
@@ -476,6 +294,7 @@ Class | Method | HTTP request | Description
|
|
|
476
294
|
- [ApiSdkRb::Composition](docs/Composition.md)
|
|
477
295
|
- [ApiSdkRb::CompositionDataSource](docs/CompositionDataSource.md)
|
|
478
296
|
- [ApiSdkRb::CompositionDataSourceResponse](docs/CompositionDataSourceResponse.md)
|
|
297
|
+
- [ApiSdkRb::CompositionDatabaseRecordResponse](docs/CompositionDatabaseRecordResponse.md)
|
|
479
298
|
- [ApiSdkRb::CompositionEntriesDescription](docs/CompositionEntriesDescription.md)
|
|
480
299
|
- [ApiSdkRb::CompositionEntriesDescriptionResponse](docs/CompositionEntriesDescriptionResponse.md)
|
|
481
300
|
- [ApiSdkRb::CompositionEntriesReading](docs/CompositionEntriesReading.md)
|
|
@@ -496,19 +315,16 @@ Class | Method | HTTP request | Description
|
|
|
496
315
|
- [ApiSdkRb::ConfirmAdapterConnectionRequest](docs/ConfirmAdapterConnectionRequest.md)
|
|
497
316
|
- [ApiSdkRb::ContentCheckFinding](docs/ContentCheckFinding.md)
|
|
498
317
|
- [ApiSdkRb::ContentItemWriteResult](docs/ContentItemWriteResult.md)
|
|
318
|
+
- [ApiSdkRb::ContentItemWriteResultResponse](docs/ContentItemWriteResultResponse.md)
|
|
499
319
|
- [ApiSdkRb::ContentItemWriteResultValidationResult](docs/ContentItemWriteResultValidationResult.md)
|
|
500
320
|
- [ApiSdkRb::CopyPartnerPresetRequest](docs/CopyPartnerPresetRequest.md)
|
|
501
321
|
- [ApiSdkRb::CreateCanvasRequest](docs/CreateCanvasRequest.md)
|
|
502
|
-
- [ApiSdkRb::CreateCompositionContentItem201Response](docs/CreateCompositionContentItem201Response.md)
|
|
503
322
|
- [ApiSdkRb::CreateCompositionContentItemRequest](docs/CreateCompositionContentItemRequest.md)
|
|
504
|
-
- [ApiSdkRb::CreateCompositionDatabaseRecord201Response](docs/CreateCompositionDatabaseRecord201Response.md)
|
|
505
323
|
- [ApiSdkRb::CreateCompositionFromPresetRequest](docs/CreateCompositionFromPresetRequest.md)
|
|
506
|
-
- [ApiSdkRb::CreateCompositionFromWidget201Response](docs/CreateCompositionFromWidget201Response.md)
|
|
507
324
|
- [ApiSdkRb::CreateCompositionFromWidgetRequest](docs/CreateCompositionFromWidgetRequest.md)
|
|
508
325
|
- [ApiSdkRb::CreateUserApiKeyRequest](docs/CreateUserApiKeyRequest.md)
|
|
509
326
|
- [ApiSdkRb::CreateWidget201Response](docs/CreateWidget201Response.md)
|
|
510
327
|
- [ApiSdkRb::CreateWidget201ResponseData](docs/CreateWidget201ResponseData.md)
|
|
511
|
-
- [ApiSdkRb::CreateWorkspaceWorkflowFromPreset201Response](docs/CreateWorkspaceWorkflowFromPreset201Response.md)
|
|
512
328
|
- [ApiSdkRb::CreateWorkspaceWorkflowFromPresetRequest](docs/CreateWorkspaceWorkflowFromPresetRequest.md)
|
|
513
329
|
- [ApiSdkRb::CreateWorkspaceWorkflowRequest](docs/CreateWorkspaceWorkflowRequest.md)
|
|
514
330
|
- [ApiSdkRb::CreatedUserApiKey](docs/CreatedUserApiKey.md)
|
|
@@ -517,13 +333,15 @@ Class | Method | HTTP request | Description
|
|
|
517
333
|
- [ApiSdkRb::DeleteCompositionContentItemResponseData](docs/DeleteCompositionContentItemResponseData.md)
|
|
518
334
|
- [ApiSdkRb::DeleteCompositionDataSourceResponse](docs/DeleteCompositionDataSourceResponse.md)
|
|
519
335
|
- [ApiSdkRb::DeleteCompositionDataSourceResponseData](docs/DeleteCompositionDataSourceResponseData.md)
|
|
520
|
-
- [ApiSdkRb::DeleteManagedUser200Response](docs/DeleteManagedUser200Response.md)
|
|
521
336
|
- [ApiSdkRb::DeletePersonalWorkspaceDomainResponse](docs/DeletePersonalWorkspaceDomainResponse.md)
|
|
522
337
|
- [ApiSdkRb::DeletePersonalWorkspaceDomainResponseData](docs/DeletePersonalWorkspaceDomainResponseData.md)
|
|
338
|
+
- [ApiSdkRb::DeleteUpload200Response](docs/DeleteUpload200Response.md)
|
|
339
|
+
- [ApiSdkRb::DeleteUpload200ResponseData](docs/DeleteUpload200ResponseData.md)
|
|
523
340
|
- [ApiSdkRb::DeleteUserApiKeyResponse](docs/DeleteUserApiKeyResponse.md)
|
|
524
341
|
- [ApiSdkRb::DeleteUserApiKeyResponseData](docs/DeleteUserApiKeyResponseData.md)
|
|
525
342
|
- [ApiSdkRb::DeleteWorkspaceWorkflow200Response](docs/DeleteWorkspaceWorkflow200Response.md)
|
|
526
343
|
- [ApiSdkRb::DesignDefaults](docs/DesignDefaults.md)
|
|
344
|
+
- [ApiSdkRb::DesignDefaultsResponse](docs/DesignDefaultsResponse.md)
|
|
527
345
|
- [ApiSdkRb::DuplicateComposition202Response](docs/DuplicateComposition202Response.md)
|
|
528
346
|
- [ApiSdkRb::DuplicateComposition202ResponseData](docs/DuplicateComposition202ResponseData.md)
|
|
529
347
|
- [ApiSdkRb::DuplicateCompositionRequest](docs/DuplicateCompositionRequest.md)
|
|
@@ -559,15 +377,15 @@ Class | Method | HTTP request | Description
|
|
|
559
377
|
- [ApiSdkRb::GetInvoicesByPartnerId200Response](docs/GetInvoicesByPartnerId200Response.md)
|
|
560
378
|
- [ApiSdkRb::GetManagedUserEntitlementsResponse](docs/GetManagedUserEntitlementsResponse.md)
|
|
561
379
|
- [ApiSdkRb::GetManagedUserEntitlementsResponseData](docs/GetManagedUserEntitlementsResponseData.md)
|
|
562
|
-
- [ApiSdkRb::GetManagedUserLimits200Response](docs/GetManagedUserLimits200Response.md)
|
|
563
380
|
- [ApiSdkRb::GetManagedUserStorageUsage200Response](docs/GetManagedUserStorageUsage200Response.md)
|
|
564
381
|
- [ApiSdkRb::GetManagedUserStorageUsage200ResponseData](docs/GetManagedUserStorageUsage200ResponseData.md)
|
|
565
382
|
- [ApiSdkRb::GetManagedUserStorageUsage200ResponseDataByPurpose](docs/GetManagedUserStorageUsage200ResponseDataByPurpose.md)
|
|
566
383
|
- [ApiSdkRb::GetManagedUsersByManagerIdResponse](docs/GetManagedUsersByManagerIdResponse.md)
|
|
567
384
|
- [ApiSdkRb::GetManagedUsersByManagerIdResponseData](docs/GetManagedUsersByManagerIdResponseData.md)
|
|
385
|
+
- [ApiSdkRb::GetOperationResponse](docs/GetOperationResponse.md)
|
|
386
|
+
- [ApiSdkRb::GetOperationResponseData](docs/GetOperationResponseData.md)
|
|
387
|
+
- [ApiSdkRb::GetOperationResponseDataMetadata](docs/GetOperationResponseDataMetadata.md)
|
|
568
388
|
- [ApiSdkRb::GetPartnerBillingOverview200Response](docs/GetPartnerBillingOverview200Response.md)
|
|
569
|
-
- [ApiSdkRb::GetPartnerCreditTransactions200Response](docs/GetPartnerCreditTransactions200Response.md)
|
|
570
|
-
- [ApiSdkRb::GetPartnerDesignDefaults200Response](docs/GetPartnerDesignDefaults200Response.md)
|
|
571
389
|
- [ApiSdkRb::GetPartnerEntitlementsResponse](docs/GetPartnerEntitlementsResponse.md)
|
|
572
390
|
- [ApiSdkRb::GetPartnerEntitlementsResponseData](docs/GetPartnerEntitlementsResponseData.md)
|
|
573
391
|
- [ApiSdkRb::GetPersonalWorkspaceDomains200Response](docs/GetPersonalWorkspaceDomains200Response.md)
|
|
@@ -578,8 +396,6 @@ Class | Method | HTTP request | Description
|
|
|
578
396
|
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseDirect](docs/GetPublicCompositionEmbed200ResponseDirect.md)
|
|
579
397
|
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseEntries](docs/GetPublicCompositionEmbed200ResponseEntries.md)
|
|
580
398
|
- [ApiSdkRb::GetPublicCompositionEmbed200ResponseMedia](docs/GetPublicCompositionEmbed200ResponseMedia.md)
|
|
581
|
-
- [ApiSdkRb::GetPublicWorkflow200Response](docs/GetPublicWorkflow200Response.md)
|
|
582
|
-
- [ApiSdkRb::GetUserAdapterConnections200Response](docs/GetUserAdapterConnections200Response.md)
|
|
583
399
|
- [ApiSdkRb::GetUserApiKeyUsageLogsResponse](docs/GetUserApiKeyUsageLogsResponse.md)
|
|
584
400
|
- [ApiSdkRb::GetUserApiKeyUsageLogsResponseData](docs/GetUserApiKeyUsageLogsResponseData.md)
|
|
585
401
|
- [ApiSdkRb::GetUserApiKeys200Response](docs/GetUserApiKeys200Response.md)
|
|
@@ -592,6 +408,7 @@ Class | Method | HTTP request | Description
|
|
|
592
408
|
- [ApiSdkRb::GetWorkspaceWorkflowVersion200Response](docs/GetWorkspaceWorkflowVersion200Response.md)
|
|
593
409
|
- [ApiSdkRb::ListPartnerPresets200Response](docs/ListPartnerPresets200Response.md)
|
|
594
410
|
- [ApiSdkRb::ListPartnerWorkflowPresets200Response](docs/ListPartnerWorkflowPresets200Response.md)
|
|
411
|
+
- [ApiSdkRb::ListUploads200Response](docs/ListUploads200Response.md)
|
|
595
412
|
- [ApiSdkRb::ListWorkspaceWorkflowCompositionOptions200Response](docs/ListWorkspaceWorkflowCompositionOptions200Response.md)
|
|
596
413
|
- [ApiSdkRb::ListWorkspaceWorkflowPresets200Response](docs/ListWorkspaceWorkflowPresets200Response.md)
|
|
597
414
|
- [ApiSdkRb::ListWorkspaceWorkflowVersions200Response](docs/ListWorkspaceWorkflowVersions200Response.md)
|
|
@@ -601,8 +418,10 @@ Class | Method | HTTP request | Description
|
|
|
601
418
|
- [ApiSdkRb::ManagedUserEntriesPageSuccess](docs/ManagedUserEntriesPageSuccess.md)
|
|
602
419
|
- [ApiSdkRb::ManagedUserEntryItem](docs/ManagedUserEntryItem.md)
|
|
603
420
|
- [ApiSdkRb::ManagedUserLimits](docs/ManagedUserLimits.md)
|
|
421
|
+
- [ApiSdkRb::ManagedUserLimitsResponse](docs/ManagedUserLimitsResponse.md)
|
|
604
422
|
- [ApiSdkRb::ManagedUserOperationUsage](docs/ManagedUserOperationUsage.md)
|
|
605
423
|
- [ApiSdkRb::ManagedUserRemoval](docs/ManagedUserRemoval.md)
|
|
424
|
+
- [ApiSdkRb::ManagedUserRemovalResponse](docs/ManagedUserRemovalResponse.md)
|
|
606
425
|
- [ApiSdkRb::ManagedUserResponse](docs/ManagedUserResponse.md)
|
|
607
426
|
- [ApiSdkRb::ManagedUserUsage](docs/ManagedUserUsage.md)
|
|
608
427
|
- [ApiSdkRb::ManagedUserUsageResponse](docs/ManagedUserUsageResponse.md)
|
|
@@ -618,8 +437,6 @@ Class | Method | HTTP request | Description
|
|
|
618
437
|
- [ApiSdkRb::OfferedWorkflowPreset](docs/OfferedWorkflowPreset.md)
|
|
619
438
|
- [ApiSdkRb::OfferedWorkflowPresetList](docs/OfferedWorkflowPresetList.md)
|
|
620
439
|
- [ApiSdkRb::OfferedWorkflowPresetWidget](docs/OfferedWorkflowPresetWidget.md)
|
|
621
|
-
- [ApiSdkRb::OperationsIdGetResponse](docs/OperationsIdGetResponse.md)
|
|
622
|
-
- [ApiSdkRb::OperationsIdGetResponseData](docs/OperationsIdGetResponseData.md)
|
|
623
440
|
- [ApiSdkRb::PartnerAnalyticsByManagedUser](docs/PartnerAnalyticsByManagedUser.md)
|
|
624
441
|
- [ApiSdkRb::PartnerAnalyticsByManagedUserResponse](docs/PartnerAnalyticsByManagedUserResponse.md)
|
|
625
442
|
- [ApiSdkRb::PartnerAnalyticsOfDay](docs/PartnerAnalyticsOfDay.md)
|
|
@@ -711,6 +528,7 @@ Class | Method | HTTP request | Description
|
|
|
711
528
|
- [ApiSdkRb::PublicWorkflowEventsRequest](docs/PublicWorkflowEventsRequest.md)
|
|
712
529
|
- [ApiSdkRb::PublicWorkflowEventsRequestEventsInner](docs/PublicWorkflowEventsRequestEventsInner.md)
|
|
713
530
|
- [ApiSdkRb::PublicWorkflowEventsRequestHeightsInner](docs/PublicWorkflowEventsRequestHeightsInner.md)
|
|
531
|
+
- [ApiSdkRb::PublicWorkflowResponse](docs/PublicWorkflowResponse.md)
|
|
714
532
|
- [ApiSdkRb::PublicWorkflowTranslation](docs/PublicWorkflowTranslation.md)
|
|
715
533
|
- [ApiSdkRb::PublishWorkspaceWorkflow200Response](docs/PublishWorkspaceWorkflow200Response.md)
|
|
716
534
|
- [ApiSdkRb::PublishWorkspaceWorkflowRequest](docs/PublishWorkspaceWorkflowRequest.md)
|
|
@@ -718,13 +536,11 @@ Class | Method | HTTP request | Description
|
|
|
718
536
|
- [ApiSdkRb::PutBrandKitRequest](docs/PutBrandKitRequest.md)
|
|
719
537
|
- [ApiSdkRb::RemoveAiAnswersKnowledgeDocument200Response](docs/RemoveAiAnswersKnowledgeDocument200Response.md)
|
|
720
538
|
- [ApiSdkRb::RemovePartnerWorkflowPreset200Response](docs/RemovePartnerWorkflowPreset200Response.md)
|
|
721
|
-
- [ApiSdkRb::RemoveUserAdapterConnection200Response](docs/RemoveUserAdapterConnection200Response.md)
|
|
722
539
|
- [ApiSdkRb::ReportPublicWorkflowEvents200Response](docs/ReportPublicWorkflowEvents200Response.md)
|
|
723
540
|
- [ApiSdkRb::RequestExtraCredits](docs/RequestExtraCredits.md)
|
|
724
541
|
- [ApiSdkRb::ResponseMeta](docs/ResponseMeta.md)
|
|
725
542
|
- [ApiSdkRb::RevokeManagedUserEditorSessionsResponse](docs/RevokeManagedUserEditorSessionsResponse.md)
|
|
726
543
|
- [ApiSdkRb::RevokeManagedUserEditorSessionsResponseData](docs/RevokeManagedUserEditorSessionsResponseData.md)
|
|
727
|
-
- [ApiSdkRb::SaveWorkspaceWorkflow200Response](docs/SaveWorkspaceWorkflow200Response.md)
|
|
728
544
|
- [ApiSdkRb::SaveWorkspaceWorkflowRequest](docs/SaveWorkspaceWorkflowRequest.md)
|
|
729
545
|
- [ApiSdkRb::SetAdapterConnectionRequest](docs/SetAdapterConnectionRequest.md)
|
|
730
546
|
- [ApiSdkRb::SetCompositionDataSourceRequest](docs/SetCompositionDataSourceRequest.md)
|
|
@@ -738,7 +554,6 @@ Class | Method | HTTP request | Description
|
|
|
738
554
|
- [ApiSdkRb::SetPartnerPresetRequest](docs/SetPartnerPresetRequest.md)
|
|
739
555
|
- [ApiSdkRb::SetPartnerStorageDestinationRequest](docs/SetPartnerStorageDestinationRequest.md)
|
|
740
556
|
- [ApiSdkRb::SetPartnerWorkflowPreset200Response](docs/SetPartnerWorkflowPreset200Response.md)
|
|
741
|
-
- [ApiSdkRb::SetUserAdapterConnection200Response](docs/SetUserAdapterConnection200Response.md)
|
|
742
557
|
- [ApiSdkRb::SuccessResponse](docs/SuccessResponse.md)
|
|
743
558
|
- [ApiSdkRb::UpdateCanvasRequest](docs/UpdateCanvasRequest.md)
|
|
744
559
|
- [ApiSdkRb::UpdateComposition](docs/UpdateComposition.md)
|
|
@@ -752,9 +567,6 @@ Class | Method | HTTP request | Description
|
|
|
752
567
|
- [ApiSdkRb::UploadLimits](docs/UploadLimits.md)
|
|
753
568
|
- [ApiSdkRb::UploadLimitsResponse](docs/UploadLimitsResponse.md)
|
|
754
569
|
- [ApiSdkRb::UploadResponse](docs/UploadResponse.md)
|
|
755
|
-
- [ApiSdkRb::UploadsGet200Response](docs/UploadsGet200Response.md)
|
|
756
|
-
- [ApiSdkRb::UploadsIdDelete200Response](docs/UploadsIdDelete200Response.md)
|
|
757
|
-
- [ApiSdkRb::UploadsIdDelete200ResponseData](docs/UploadsIdDelete200ResponseData.md)
|
|
758
570
|
- [ApiSdkRb::UserApiKey](docs/UserApiKey.md)
|
|
759
571
|
- [ApiSdkRb::UserApiKeyResponse](docs/UserApiKeyResponse.md)
|
|
760
572
|
- [ApiSdkRb::UserApiKeyUsageLog](docs/UserApiKeyUsageLog.md)
|
|
@@ -763,6 +575,16 @@ Class | Method | HTTP request | Description
|
|
|
763
575
|
- [ApiSdkRb::ValidateToken200Response](docs/ValidateToken200Response.md)
|
|
764
576
|
- [ApiSdkRb::ValidateToken200ResponseData](docs/ValidateToken200ResponseData.md)
|
|
765
577
|
- [ApiSdkRb::Widget](docs/Widget.md)
|
|
578
|
+
- [ApiSdkRb::WidgetClarification](docs/WidgetClarification.md)
|
|
579
|
+
- [ApiSdkRb::WidgetClarificationOption](docs/WidgetClarificationOption.md)
|
|
580
|
+
- [ApiSdkRb::WidgetClarificationQuestion](docs/WidgetClarificationQuestion.md)
|
|
581
|
+
- [ApiSdkRb::WidgetNextStep](docs/WidgetNextStep.md)
|
|
582
|
+
- [ApiSdkRb::WidgetPlan](docs/WidgetPlan.md)
|
|
583
|
+
- [ApiSdkRb::WidgetPlanDecisions](docs/WidgetPlanDecisions.md)
|
|
584
|
+
- [ApiSdkRb::WidgetPlanDecisionsAdaptersInner](docs/WidgetPlanDecisionsAdaptersInner.md)
|
|
585
|
+
- [ApiSdkRb::WidgetPlanDecisionsLibrariesInner](docs/WidgetPlanDecisionsLibrariesInner.md)
|
|
586
|
+
- [ApiSdkRb::WidgetPlanDecisionsResponsive](docs/WidgetPlanDecisionsResponsive.md)
|
|
587
|
+
- [ApiSdkRb::WidgetPlanTask](docs/WidgetPlanTask.md)
|
|
766
588
|
- [ApiSdkRb::Workflow](docs/Workflow.md)
|
|
767
589
|
- [ApiSdkRb::WorkflowCompositionAction](docs/WorkflowCompositionAction.md)
|
|
768
590
|
- [ApiSdkRb::WorkflowCompositionField](docs/WorkflowCompositionField.md)
|
|
@@ -775,7 +597,10 @@ Class | Method | HTTP request | Description
|
|
|
775
597
|
- [ApiSdkRb::WorkflowCounter](docs/WorkflowCounter.md)
|
|
776
598
|
- [ApiSdkRb::WorkflowDetail](docs/WorkflowDetail.md)
|
|
777
599
|
- [ApiSdkRb::WorkflowDetailAllOfLastEditedBy](docs/WorkflowDetailAllOfLastEditedBy.md)
|
|
600
|
+
- [ApiSdkRb::WorkflowDetailResponse](docs/WorkflowDetailResponse.md)
|
|
778
601
|
- [ApiSdkRb::WorkflowEdge](docs/WorkflowEdge.md)
|
|
602
|
+
- [ApiSdkRb::WorkflowFailureReason](docs/WorkflowFailureReason.md)
|
|
603
|
+
- [ApiSdkRb::WorkflowFailureReasonCounter](docs/WorkflowFailureReasonCounter.md)
|
|
779
604
|
- [ApiSdkRb::WorkflowFieldReference](docs/WorkflowFieldReference.md)
|
|
780
605
|
- [ApiSdkRb::WorkflowGraph](docs/WorkflowGraph.md)
|
|
781
606
|
- [ApiSdkRb::WorkflowIssue](docs/WorkflowIssue.md)
|
|
@@ -788,6 +613,7 @@ Class | Method | HTTP request | Description
|
|
|
788
613
|
- [ApiSdkRb::WorkflowPresetWidget](docs/WorkflowPresetWidget.md)
|
|
789
614
|
- [ApiSdkRb::WorkflowPublishResult](docs/WorkflowPublishResult.md)
|
|
790
615
|
- [ApiSdkRb::WorkflowRemoved](docs/WorkflowRemoved.md)
|
|
616
|
+
- [ApiSdkRb::WorkflowResponse](docs/WorkflowResponse.md)
|
|
791
617
|
- [ApiSdkRb::WorkflowSchedule](docs/WorkflowSchedule.md)
|
|
792
618
|
- [ApiSdkRb::WorkflowStats](docs/WorkflowStats.md)
|
|
793
619
|
- [ApiSdkRb::WorkflowStatus](docs/WorkflowStatus.md)
|