api-sdk-rb 1.11.111 → 1.11.133
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +207 -381
- data/docs/{GetPartnerCreditTransactions200Response.md → AccountCreditTransactionListResponse.md} +2 -2
- data/docs/{GetUserAdapterConnections200Response.md → AdapterConnectionListResponse.md} +2 -2
- data/docs/{RemoveUserAdapterConnection200Response.md → AdapterConnectionRemovalResponse.md} +2 -2
- data/docs/{SetUserAdapterConnection200Response.md → AdapterConnectionResponse.md} +2 -2
- data/docs/{AddAiAnswersKnowledgeDocument201Response.md → AiAnswersKnowledgeDocumentResponse.md} +2 -2
- data/docs/BrandKitApi.md +74 -74
- data/docs/BrandKitTokens.md +2 -0
- data/docs/BrandKitView.md +1 -1
- data/docs/BrandTextStyle.md +22 -0
- data/docs/CanvasesApi.md +45 -45
- data/docs/{CreateCompositionDatabaseRecord201Response.md → CompositionDatabaseRecordResponse.md} +2 -2
- data/docs/CompositionsApi.md +615 -349
- data/docs/{CreateCompositionContentItem201Response.md → ContentItemWriteResultResponse.md} +2 -2
- data/docs/CreditsApi.md +20 -20
- data/docs/{CreateCompositionFromWidget201Response.md → DeleteUpload200Response.md} +3 -3
- data/docs/{UploadsIdDelete200ResponseData.md → DeleteUpload200ResponseData.md} +2 -2
- data/docs/{GetPartnerDesignDefaults200Response.md → DesignDefaultsResponse.md} +2 -2
- data/docs/EntitlementsApi.md +18 -18
- data/docs/{OperationsIdGetResponse.md → GetOperationResponse.md} +3 -3
- data/docs/{OperationsIdGetResponseData.md → GetOperationResponseData.md} +3 -3
- data/docs/GetOperationResponseDataMetadata.md +24 -0
- data/docs/InvoicesApi.md +9 -9
- data/docs/{UploadsGet200Response.md → ListUploads200Response.md} +2 -2
- data/docs/{GetManagedUserLimits200Response.md → ManagedUserLimitsResponse.md} +2 -2
- data/docs/{DeleteManagedUser200Response.md → ManagedUserRemovalResponse.md} +2 -2
- data/docs/ManagedUsersApi.md +261 -171
- data/docs/OperationsApi.md +11 -11
- data/docs/PartnersApi.md +388 -388
- data/docs/PatchBrandKitRequest.md +2 -0
- data/docs/PublicEmbedApi.md +95 -95
- data/docs/PublicWorkflowEventsRequestEventsInner.md +3 -1
- data/docs/{GetPublicWorkflow200Response.md → PublicWorkflowResponse.md} +2 -2
- data/docs/TokensApi.md +11 -9
- data/docs/Upload.md +1 -1
- data/docs/UploadLimits.md +3 -3
- data/docs/UploadsApi.md +85 -85
- data/docs/UsersApi.md +125 -125
- data/docs/WidgetClarification.md +22 -0
- data/docs/WidgetClarificationOption.md +22 -0
- data/docs/WidgetClarificationQuestion.md +26 -0
- data/docs/WidgetNextStep.md +24 -0
- data/docs/WidgetPlan.md +26 -0
- data/docs/WidgetPlanDecisions.md +32 -0
- data/docs/WidgetPlanDecisionsAdaptersInner.md +20 -0
- data/docs/WidgetPlanDecisionsLibrariesInner.md +22 -0
- data/docs/WidgetPlanDecisionsResponsive.md +22 -0
- data/docs/WidgetPlanTask.md +24 -0
- data/docs/WidgetsApi.md +38 -38
- data/docs/{CreateWorkspaceWorkflowFromPreset201Response.md → WorkflowDetailResponse.md} +2 -2
- data/docs/WorkflowFailureReason.md +15 -0
- data/docs/WorkflowFailureReasonCounter.md +22 -0
- data/docs/{SaveWorkspaceWorkflow200Response.md → WorkflowResponse.md} +2 -2
- data/docs/WorkflowStats.md +4 -2
- data/docs/WorkflowsApi.md +197 -413
- data/lib/api-sdk-rb/api/brand_kit_api.rb +61 -61
- data/lib/api-sdk-rb/api/canvases_api.rb +39 -39
- data/lib/api-sdk-rb/api/compositions_api.rb +770 -441
- data/lib/api-sdk-rb/api/credits_api.rb +20 -20
- data/lib/api-sdk-rb/api/entitlements_api.rb +14 -14
- data/lib/api-sdk-rb/api/invoices_api.rb +10 -10
- data/lib/api-sdk-rb/api/managed_users_api.rb +278 -172
- data/lib/api-sdk-rb/api/operations_api.rb +10 -10
- data/lib/api-sdk-rb/api/partners_api.rb +389 -389
- data/lib/api-sdk-rb/api/public_embed_api.rb +95 -95
- data/lib/api-sdk-rb/api/tokens_api.rb +8 -6
- data/lib/api-sdk-rb/api/uploads_api.rb +96 -96
- data/lib/api-sdk-rb/api/users_api.rb +132 -132
- data/lib/api-sdk-rb/api/widgets_api.rb +40 -40
- data/lib/api-sdk-rb/api/workflows_api.rb +246 -468
- data/lib/api-sdk-rb/configuration.rb +0 -60
- data/lib/api-sdk-rb/models/{get_user_adapter_connections200_response.rb → account_credit_transaction_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{get_partner_credit_transactions200_response.rb → adapter_connection_list_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{save_workspace_workflow200_response.rb → adapter_connection_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/{set_user_adapter_connection200_response.rb → adapter_connection_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{add_ai_answers_knowledge_document201_response.rb → ai_answers_knowledge_document_response.rb} +3 -3
- data/lib/api-sdk-rb/models/brand_kit_tokens.rb +33 -2
- data/lib/api-sdk-rb/models/brand_kit_view.rb +1 -1
- data/lib/api-sdk-rb/models/brand_text_style.rb +344 -0
- data/lib/api-sdk-rb/models/{create_composition_database_record201_response.rb → composition_database_record_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{create_composition_content_item201_response.rb → content_item_write_result_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{operations_id_get_response.rb → delete_upload200_response.rb} +4 -5
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response_data.rb → delete_upload200_response_data.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_partner_design_defaults200_response.rb → design_defaults_response.rb} +3 -3
- data/lib/api-sdk-rb/models/get_operation_response.rb +247 -0
- data/lib/api-sdk-rb/models/{operations_id_get_response_data.rb → get_operation_response_data.rb} +5 -8
- data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb +283 -0
- data/lib/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb} +3 -3
- data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb} +4 -4
- data/lib/api-sdk-rb/models/patch_brand_kit_request.rb +32 -1
- data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb +26 -4
- data/lib/api-sdk-rb/models/{get_public_workflow200_response.rb → public_workflow_response.rb} +3 -3
- data/lib/api-sdk-rb/models/upload.rb +1 -1
- data/lib/api-sdk-rb/models/upload_limits.rb +3 -3
- data/lib/api-sdk-rb/models/widget_clarification.rb +279 -0
- data/lib/api-sdk-rb/models/{create_composition_from_widget201_response.rb → widget_clarification_option.rb} +40 -30
- data/lib/api-sdk-rb/models/widget_clarification_question.rb +329 -0
- data/lib/api-sdk-rb/models/widget_next_step.rb +307 -0
- data/lib/api-sdk-rb/models/widget_plan.rb +306 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions.rb +346 -0
- data/lib/api-sdk-rb/models/widget_plan_decisions_adapters_inner.rb +237 -0
- data/lib/api-sdk-rb/models/{create_workspace_workflow_from_preset201_response.rb → widget_plan_decisions_libraries_inner.rb} +39 -30
- data/lib/api-sdk-rb/models/widget_plan_decisions_responsive.rb +311 -0
- data/lib/api-sdk-rb/models/widget_plan_task.rb +320 -0
- data/lib/api-sdk-rb/models/{delete_managed_user200_response.rb → workflow_detail_response.rb} +4 -4
- data/lib/api-sdk-rb/models/workflow_failure_reason.rb +42 -0
- data/lib/api-sdk-rb/models/workflow_failure_reason_counter.rb +277 -0
- data/lib/api-sdk-rb/models/workflow_response.rb +246 -0
- data/lib/api-sdk-rb/models/workflow_stats.rb +17 -5
- data/lib/api-sdk-rb/version.rb +1 -1
- data/lib/api-sdk-rb.rb +32 -21
- data/spec/api/brand_kit_api_spec.rb +18 -18
- data/spec/api/canvases_api_spec.rb +10 -10
- data/spec/api/compositions_api_spec.rb +144 -83
- data/spec/api/credits_api_spec.rb +5 -5
- data/spec/api/entitlements_api_spec.rb +4 -4
- data/spec/api/invoices_api_spec.rb +2 -2
- data/spec/api/managed_users_api_spec.rb +63 -42
- data/spec/api/operations_api_spec.rb +3 -3
- data/spec/api/partners_api_spec.rb +91 -91
- data/spec/api/public_embed_api_spec.rb +23 -23
- data/spec/api/tokens_api_spec.rb +3 -2
- data/spec/api/uploads_api_spec.rb +24 -24
- data/spec/api/users_api_spec.rb +30 -30
- data/spec/api/widgets_api_spec.rb +9 -9
- data/spec/api/workflows_api_spec.rb +50 -89
- data/spec/models/{get_user_adapter_connections200_response_spec.rb → account_credit_transaction_list_response_spec.rb} +6 -6
- data/spec/models/{get_public_workflow200_response_spec.rb → adapter_connection_list_response_spec.rb} +6 -6
- data/spec/models/{save_workspace_workflow200_response_spec.rb → adapter_connection_removal_response_spec.rb} +6 -6
- data/spec/models/{delete_managed_user200_response_spec.rb → adapter_connection_response_spec.rb} +6 -6
- data/spec/models/ai_answers_knowledge_document_response_spec.rb +48 -0
- data/spec/models/brand_kit_tokens_spec.rb +6 -0
- data/spec/models/{create_composition_from_widget201_response_spec.rb → brand_text_style_spec.rb} +13 -9
- data/spec/models/{get_managed_user_limits200_response_spec.rb → composition_database_record_response_spec.rb} +6 -6
- data/spec/models/content_item_write_result_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_data_spec.rb → delete_upload200_response_data_spec.rb} +6 -6
- data/spec/models/{operations_id_get_response_spec.rb → delete_upload200_response_spec.rb} +6 -6
- data/spec/models/design_defaults_response_spec.rb +48 -0
- data/spec/models/get_operation_response_data_metadata_spec.rb +58 -0
- data/spec/models/{operations_id_get_response_data_spec.rb → get_operation_response_data_spec.rb} +6 -6
- data/spec/models/{uploads_get200_response_spec.rb → get_operation_response_spec.rb} +6 -6
- data/spec/models/list_uploads200_response_spec.rb +48 -0
- data/spec/models/managed_user_limits_response_spec.rb +48 -0
- data/spec/models/{uploads_id_delete200_response_spec.rb → managed_user_removal_response_spec.rb} +6 -6
- data/spec/models/patch_brand_kit_request_spec.rb +6 -0
- data/spec/models/public_workflow_events_request_events_inner_spec.rb +10 -0
- data/spec/models/public_workflow_response_spec.rb +48 -0
- data/spec/models/widget_clarification_option_spec.rb +48 -0
- data/spec/models/widget_clarification_question_spec.rb +60 -0
- data/spec/models/widget_clarification_spec.rb +48 -0
- data/spec/models/widget_next_step_spec.rb +58 -0
- data/spec/models/widget_plan_decisions_adapters_inner_spec.rb +42 -0
- data/spec/models/widget_plan_decisions_libraries_inner_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_responsive_spec.rb +48 -0
- data/spec/models/widget_plan_decisions_spec.rb +78 -0
- data/spec/models/{create_composition_database_record201_response_spec.rb → widget_plan_spec.rb} +21 -9
- data/spec/models/widget_plan_task_spec.rb +62 -0
- data/spec/models/workflow_detail_response_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_counter_spec.rb +48 -0
- data/spec/models/workflow_failure_reason_spec.rb +30 -0
- data/spec/models/workflow_response_spec.rb +48 -0
- data/spec/models/workflow_stats_spec.rb +6 -0
- metadata +130 -86
- data/docs/PartnerApi.md +0 -12714
- data/docs/UploadsIdDelete200Response.md +0 -22
- data/docs/WorkspacesApi.md +0 -1527
- data/lib/api-sdk-rb/api/partner_api.rb +0 -13791
- data/lib/api-sdk-rb/api/workspaces_api.rb +0 -1775
- data/lib/api-sdk-rb/models/remove_user_adapter_connection200_response.rb +0 -246
- data/spec/api/partner_api_spec.rb +0 -2437
- data/spec/api/workspaces_api_spec.rb +0 -339
- data/spec/models/add_ai_answers_knowledge_document201_response_spec.rb +0 -48
- data/spec/models/create_composition_content_item201_response_spec.rb +0 -48
- data/spec/models/create_workspace_workflow_from_preset201_response_spec.rb +0 -48
- data/spec/models/get_partner_credit_transactions200_response_spec.rb +0 -48
- data/spec/models/get_partner_design_defaults200_response_spec.rb +0 -48
- data/spec/models/remove_user_adapter_connection200_response_spec.rb +0 -48
- data/spec/models/set_user_adapter_connection200_response_spec.rb +0 -48
data/docs/CompositionsApi.md
CHANGED
|
@@ -4,47 +4,50 @@ All URIs are relative to *https://api.widgetic.com/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
12
|
-
| [**
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
15
|
-
| [**
|
|
16
|
-
| [**
|
|
17
|
-
| [**
|
|
18
|
-
| [**
|
|
19
|
-
| [**
|
|
20
|
-
| [**
|
|
21
|
-
| [**
|
|
22
|
-
| [**
|
|
23
|
-
| [**
|
|
24
|
-
| [**
|
|
25
|
-
| [**
|
|
26
|
-
| [**
|
|
27
|
-
| [**
|
|
28
|
-
| [**
|
|
29
|
-
| [**
|
|
30
|
-
| [**
|
|
31
|
-
| [**
|
|
32
|
-
| [**
|
|
33
|
-
| [**
|
|
34
|
-
| [**
|
|
35
|
-
| [**
|
|
36
|
-
| [**
|
|
37
|
-
| [**
|
|
38
|
-
| [**
|
|
39
|
-
| [**
|
|
40
|
-
| [**
|
|
41
|
-
| [**
|
|
42
|
-
| [**
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
7
|
+
| [**add_ai_answers_knowledge_document**](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 |
|
|
8
|
+
| [**add_ai_answers_knowledge_file**](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 |
|
|
9
|
+
| [**check_composition_access**](CompositionsApi.md#check_composition_access) | **GET** /compositions/{id}/access | Check Composition Access |
|
|
10
|
+
| [**create_composition**](CompositionsApi.md#create_composition) | **POST** /compositions | Create Composition |
|
|
11
|
+
| [**create_composition_content_item**](CompositionsApi.md#create_composition_content_item) | **POST** /compositions/{id}/content/{list}/items | Add a content list item |
|
|
12
|
+
| [**create_composition_database_record**](CompositionsApi.md#create_composition_database_record) | **POST** /compositions/{id}/database/{table} | Create Record In Composition Database |
|
|
13
|
+
| [**delete_composition**](CompositionsApi.md#delete_composition) | **DELETE** /compositions/{id} | Delete Composition |
|
|
14
|
+
| [**delete_composition_content_item**](CompositionsApi.md#delete_composition_content_item) | **DELETE** /compositions/{id}/content/{list}/items/{itemId} | Delete a content list item |
|
|
15
|
+
| [**delete_composition_data_source**](CompositionsApi.md#delete_composition_data_source) | **DELETE** /compositions/{id}/data-source | Remove the composition data source binding |
|
|
16
|
+
| [**delete_composition_database_record**](CompositionsApi.md#delete_composition_database_record) | **DELETE** /compositions/{id}/database/{table}/{recordId} | Delete Record From Composition Database |
|
|
17
|
+
| [**delete_composition_entry_items**](CompositionsApi.md#delete_composition_entry_items) | **DELETE** /compositions/{id}/entries/{table}/items | Delete composition entry items by id or host context |
|
|
18
|
+
| [**describe_composition_entries**](CompositionsApi.md#describe_composition_entries) | **GET** /compositions/{id}/entries | Describe What a Composition Keeps |
|
|
19
|
+
| [**duplicate_composition**](CompositionsApi.md#duplicate_composition) | **POST** /compositions/{id}/duplicate | Duplicate Composition |
|
|
20
|
+
| [**export_composition_entry_items**](CompositionsApi.md#export_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/export | Export composition entry items |
|
|
21
|
+
| [**get_ai_answers_knowledge**](CompositionsApi.md#get_ai_answers_knowledge) | **GET** /compositions/{id}/adapters/ai-answers/knowledge | See the documents a widget's AI answers from |
|
|
22
|
+
| [**get_all_compositions**](CompositionsApi.md#get_all_compositions) | **GET** /compositions | Get All Compositions |
|
|
23
|
+
| [**get_composition_by_id**](CompositionsApi.md#get_composition_by_id) | **GET** /compositions/{id} | Get Composition |
|
|
24
|
+
| [**get_composition_content**](CompositionsApi.md#get_composition_content) | **GET** /compositions/{id}/content | Get Current Content |
|
|
25
|
+
| [**get_composition_content_schema**](CompositionsApi.md#get_composition_content_schema) | **GET** /compositions/{id}/schema/content | Get Content Schema |
|
|
26
|
+
| [**get_composition_data_source**](CompositionsApi.md#get_composition_data_source) | **GET** /compositions/{id}/data-source | Read the composition data source binding |
|
|
27
|
+
| [**get_composition_database_record**](CompositionsApi.md#get_composition_database_record) | **GET** /compositions/{id}/database/{table}/{recordId} | Get Record From Composition Database |
|
|
28
|
+
| [**get_composition_database_records**](CompositionsApi.md#get_composition_database_records) | **GET** /compositions/{id}/database/{table} | Get All Records From Composition Database Table |
|
|
29
|
+
| [**get_composition_design**](CompositionsApi.md#get_composition_design) | **GET** /compositions/{id}/design | Get Composition Design |
|
|
30
|
+
| [**get_composition_design_schema**](CompositionsApi.md#get_composition_design_schema) | **GET** /compositions/{id}/schema/design | Get Design Schema |
|
|
31
|
+
| [**get_composition_embed_schema**](CompositionsApi.md#get_composition_embed_schema) | **GET** /compositions/{id}/schema/embed | Get Embed Schema |
|
|
32
|
+
| [**get_composition_embed_settings**](CompositionsApi.md#get_composition_embed_settings) | **GET** /compositions/{id}/embed-settings | Get Composition Embed Settings |
|
|
33
|
+
| [**get_composition_preview**](CompositionsApi.md#get_composition_preview) | **GET** /compositions/{id}/preview | Get Composition Preview |
|
|
34
|
+
| [**get_composition_versions**](CompositionsApi.md#get_composition_versions) | **GET** /compositions/{id}/versions | Get Composition Versions |
|
|
35
|
+
| [**get_compositions_batch**](CompositionsApi.md#get_compositions_batch) | **POST** /compositions/batch | Get Compositions Batch |
|
|
36
|
+
| [**list_composition_entry_items**](CompositionsApi.md#list_composition_entry_items) | **GET** /compositions/{id}/entries/{table}/items | List composition entry items with paging and filters |
|
|
37
|
+
| [**patch_composition_content_item**](CompositionsApi.md#patch_composition_content_item) | **PATCH** /compositions/{id}/content/{list}/items/{itemId} | Update a content list item |
|
|
38
|
+
| [**read_composition_entries**](CompositionsApi.md#read_composition_entries) | **GET** /compositions/{id}/entries/{table} | Read the Entries of a Composition's Table |
|
|
39
|
+
| [**remove_ai_answers_knowledge_document**](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 |
|
|
40
|
+
| [**set_composition_data_source**](CompositionsApi.md#set_composition_data_source) | **PUT** /compositions/{id}/data-source | Bind a public JSON data source for embed refresh |
|
|
41
|
+
| [**set_dynamic_content**](CompositionsApi.md#set_dynamic_content) | **PUT** /compositions/{id}/content | Set Dynamic Content |
|
|
42
|
+
| [**update_composition**](CompositionsApi.md#update_composition) | **PUT** /compositions/{id} | Update Composition |
|
|
43
|
+
| [**update_composition_database_record**](CompositionsApi.md#update_composition_database_record) | **PUT** /compositions/{id}/database/{table}/{recordId} | Update Record In Composition Database |
|
|
44
|
+
| [**update_composition_status**](CompositionsApi.md#update_composition_status) | **PUT** /compositions/{id}/status | Update Composition Status |
|
|
45
|
+
| [**validate_composition_content**](CompositionsApi.md#validate_composition_content) | **POST** /compositions/{id}/content/validate | Validate Content |
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
## add_ai_answers_knowledge_document
|
|
49
|
+
|
|
50
|
+
> <AiAnswersKnowledgeDocumentResponse> add_ai_answers_knowledge_document(id, add_ai_answers_knowledge_document_request, opts)
|
|
48
51
|
|
|
49
52
|
Add a document for a widget's AI to answer from
|
|
50
53
|
|
|
@@ -71,28 +74,28 @@ opts = {
|
|
|
71
74
|
|
|
72
75
|
begin
|
|
73
76
|
# Add a document for a widget's AI to answer from
|
|
74
|
-
result = api_instance.
|
|
77
|
+
result = api_instance.add_ai_answers_knowledge_document(id, add_ai_answers_knowledge_document_request, opts)
|
|
75
78
|
p result
|
|
76
79
|
rescue ApiSdkRb::ApiError => e
|
|
77
|
-
puts "Error when calling CompositionsApi->
|
|
80
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_document: #{e}"
|
|
78
81
|
end
|
|
79
82
|
```
|
|
80
83
|
|
|
81
|
-
#### Using the
|
|
84
|
+
#### Using the add_ai_answers_knowledge_document_with_http_info variant
|
|
82
85
|
|
|
83
86
|
This returns an Array which contains the response data, status code and headers.
|
|
84
87
|
|
|
85
|
-
> <Array(<
|
|
88
|
+
> <Array(<AiAnswersKnowledgeDocumentResponse>, Integer, Hash)> add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts)
|
|
86
89
|
|
|
87
90
|
```ruby
|
|
88
91
|
begin
|
|
89
92
|
# Add a document for a widget's AI to answer from
|
|
90
|
-
data, status_code, headers = api_instance.
|
|
93
|
+
data, status_code, headers = api_instance.add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts)
|
|
91
94
|
p status_code # => 2xx
|
|
92
95
|
p headers # => { ... }
|
|
93
|
-
p data # => <
|
|
96
|
+
p data # => <AiAnswersKnowledgeDocumentResponse>
|
|
94
97
|
rescue ApiSdkRb::ApiError => e
|
|
95
|
-
puts "Error when calling CompositionsApi->
|
|
98
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_document_with_http_info: #{e}"
|
|
96
99
|
end
|
|
97
100
|
```
|
|
98
101
|
|
|
@@ -107,7 +110,7 @@ end
|
|
|
107
110
|
|
|
108
111
|
### Return type
|
|
109
112
|
|
|
110
|
-
[**
|
|
113
|
+
[**AiAnswersKnowledgeDocumentResponse**](AiAnswersKnowledgeDocumentResponse.md)
|
|
111
114
|
|
|
112
115
|
### Authorization
|
|
113
116
|
|
|
@@ -119,9 +122,9 @@ end
|
|
|
119
122
|
- **Accept**: application/json
|
|
120
123
|
|
|
121
124
|
|
|
122
|
-
##
|
|
125
|
+
## add_ai_answers_knowledge_file
|
|
123
126
|
|
|
124
|
-
> <
|
|
127
|
+
> <AiAnswersKnowledgeDocumentResponse> add_ai_answers_knowledge_file(id, file, opts)
|
|
125
128
|
|
|
126
129
|
Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
127
130
|
|
|
@@ -149,28 +152,28 @@ opts = {
|
|
|
149
152
|
|
|
150
153
|
begin
|
|
151
154
|
# Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
152
|
-
result = api_instance.
|
|
155
|
+
result = api_instance.add_ai_answers_knowledge_file(id, file, opts)
|
|
153
156
|
p result
|
|
154
157
|
rescue ApiSdkRb::ApiError => e
|
|
155
|
-
puts "Error when calling CompositionsApi->
|
|
158
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_file: #{e}"
|
|
156
159
|
end
|
|
157
160
|
```
|
|
158
161
|
|
|
159
|
-
#### Using the
|
|
162
|
+
#### Using the add_ai_answers_knowledge_file_with_http_info variant
|
|
160
163
|
|
|
161
164
|
This returns an Array which contains the response data, status code and headers.
|
|
162
165
|
|
|
163
|
-
> <Array(<
|
|
166
|
+
> <Array(<AiAnswersKnowledgeDocumentResponse>, Integer, Hash)> add_ai_answers_knowledge_file_with_http_info(id, file, opts)
|
|
164
167
|
|
|
165
168
|
```ruby
|
|
166
169
|
begin
|
|
167
170
|
# Add a text file or a picture of a document (a PDF once PDFs are read) for a widget's AI to answer from
|
|
168
|
-
data, status_code, headers = api_instance.
|
|
171
|
+
data, status_code, headers = api_instance.add_ai_answers_knowledge_file_with_http_info(id, file, opts)
|
|
169
172
|
p status_code # => 2xx
|
|
170
173
|
p headers # => { ... }
|
|
171
|
-
p data # => <
|
|
174
|
+
p data # => <AiAnswersKnowledgeDocumentResponse>
|
|
172
175
|
rescue ApiSdkRb::ApiError => e
|
|
173
|
-
puts "Error when calling CompositionsApi->
|
|
176
|
+
puts "Error when calling CompositionsApi->add_ai_answers_knowledge_file_with_http_info: #{e}"
|
|
174
177
|
end
|
|
175
178
|
```
|
|
176
179
|
|
|
@@ -186,7 +189,7 @@ end
|
|
|
186
189
|
|
|
187
190
|
### Return type
|
|
188
191
|
|
|
189
|
-
[**
|
|
192
|
+
[**AiAnswersKnowledgeDocumentResponse**](AiAnswersKnowledgeDocumentResponse.md)
|
|
190
193
|
|
|
191
194
|
### Authorization
|
|
192
195
|
|
|
@@ -198,9 +201,9 @@ end
|
|
|
198
201
|
- **Accept**: application/json
|
|
199
202
|
|
|
200
203
|
|
|
201
|
-
##
|
|
204
|
+
## check_composition_access
|
|
202
205
|
|
|
203
|
-
> <CheckCompositionAccessResponse>
|
|
206
|
+
> <CheckCompositionAccessResponse> check_composition_access(id)
|
|
204
207
|
|
|
205
208
|
Check Composition Access
|
|
206
209
|
|
|
@@ -222,28 +225,28 @@ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Composition ID
|
|
|
222
225
|
|
|
223
226
|
begin
|
|
224
227
|
# Check Composition Access
|
|
225
|
-
result = api_instance.
|
|
228
|
+
result = api_instance.check_composition_access(id)
|
|
226
229
|
p result
|
|
227
230
|
rescue ApiSdkRb::ApiError => e
|
|
228
|
-
puts "Error when calling CompositionsApi->
|
|
231
|
+
puts "Error when calling CompositionsApi->check_composition_access: #{e}"
|
|
229
232
|
end
|
|
230
233
|
```
|
|
231
234
|
|
|
232
|
-
#### Using the
|
|
235
|
+
#### Using the check_composition_access_with_http_info variant
|
|
233
236
|
|
|
234
237
|
This returns an Array which contains the response data, status code and headers.
|
|
235
238
|
|
|
236
|
-
> <Array(<CheckCompositionAccessResponse>, Integer, Hash)>
|
|
239
|
+
> <Array(<CheckCompositionAccessResponse>, Integer, Hash)> check_composition_access_with_http_info(id)
|
|
237
240
|
|
|
238
241
|
```ruby
|
|
239
242
|
begin
|
|
240
243
|
# Check Composition Access
|
|
241
|
-
data, status_code, headers = api_instance.
|
|
244
|
+
data, status_code, headers = api_instance.check_composition_access_with_http_info(id)
|
|
242
245
|
p status_code # => 2xx
|
|
243
246
|
p headers # => { ... }
|
|
244
247
|
p data # => <CheckCompositionAccessResponse>
|
|
245
248
|
rescue ApiSdkRb::ApiError => e
|
|
246
|
-
puts "Error when calling CompositionsApi->
|
|
249
|
+
puts "Error when calling CompositionsApi->check_composition_access_with_http_info: #{e}"
|
|
247
250
|
end
|
|
248
251
|
```
|
|
249
252
|
|
|
@@ -267,9 +270,9 @@ end
|
|
|
267
270
|
- **Accept**: application/json
|
|
268
271
|
|
|
269
272
|
|
|
270
|
-
##
|
|
273
|
+
## create_composition
|
|
271
274
|
|
|
272
|
-
> <
|
|
275
|
+
> <CompositionResponse> create_composition(idempotency_key, new_composition, opts)
|
|
273
276
|
|
|
274
277
|
Create Composition
|
|
275
278
|
|
|
@@ -296,28 +299,28 @@ opts = {
|
|
|
296
299
|
|
|
297
300
|
begin
|
|
298
301
|
# Create Composition
|
|
299
|
-
result = api_instance.
|
|
302
|
+
result = api_instance.create_composition(idempotency_key, new_composition, opts)
|
|
300
303
|
p result
|
|
301
304
|
rescue ApiSdkRb::ApiError => e
|
|
302
|
-
puts "Error when calling CompositionsApi->
|
|
305
|
+
puts "Error when calling CompositionsApi->create_composition: #{e}"
|
|
303
306
|
end
|
|
304
307
|
```
|
|
305
308
|
|
|
306
|
-
#### Using the
|
|
309
|
+
#### Using the create_composition_with_http_info variant
|
|
307
310
|
|
|
308
311
|
This returns an Array which contains the response data, status code and headers.
|
|
309
312
|
|
|
310
|
-
> <Array(<
|
|
313
|
+
> <Array(<CompositionResponse>, Integer, Hash)> create_composition_with_http_info(idempotency_key, new_composition, opts)
|
|
311
314
|
|
|
312
315
|
```ruby
|
|
313
316
|
begin
|
|
314
317
|
# Create Composition
|
|
315
|
-
data, status_code, headers = api_instance.
|
|
318
|
+
data, status_code, headers = api_instance.create_composition_with_http_info(idempotency_key, new_composition, opts)
|
|
316
319
|
p status_code # => 2xx
|
|
317
320
|
p headers # => { ... }
|
|
318
|
-
p data # => <
|
|
321
|
+
p data # => <CompositionResponse>
|
|
319
322
|
rescue ApiSdkRb::ApiError => e
|
|
320
|
-
puts "Error when calling CompositionsApi->
|
|
323
|
+
puts "Error when calling CompositionsApi->create_composition_with_http_info: #{e}"
|
|
321
324
|
end
|
|
322
325
|
```
|
|
323
326
|
|
|
@@ -332,7 +335,7 @@ end
|
|
|
332
335
|
|
|
333
336
|
### Return type
|
|
334
337
|
|
|
335
|
-
[**
|
|
338
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
336
339
|
|
|
337
340
|
### Authorization
|
|
338
341
|
|
|
@@ -344,9 +347,9 @@ end
|
|
|
344
347
|
- **Accept**: application/json
|
|
345
348
|
|
|
346
349
|
|
|
347
|
-
##
|
|
350
|
+
## create_composition_content_item
|
|
348
351
|
|
|
349
|
-
> <
|
|
352
|
+
> <ContentItemWriteResultResponse> create_composition_content_item(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
350
353
|
|
|
351
354
|
Add a content list item
|
|
352
355
|
|
|
@@ -376,28 +379,28 @@ opts = {
|
|
|
376
379
|
|
|
377
380
|
begin
|
|
378
381
|
# Add a content list item
|
|
379
|
-
result = api_instance.
|
|
382
|
+
result = api_instance.create_composition_content_item(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
380
383
|
p result
|
|
381
384
|
rescue ApiSdkRb::ApiError => e
|
|
382
|
-
puts "Error when calling CompositionsApi->
|
|
385
|
+
puts "Error when calling CompositionsApi->create_composition_content_item: #{e}"
|
|
383
386
|
end
|
|
384
387
|
```
|
|
385
388
|
|
|
386
|
-
#### Using the
|
|
389
|
+
#### Using the create_composition_content_item_with_http_info variant
|
|
387
390
|
|
|
388
391
|
This returns an Array which contains the response data, status code and headers.
|
|
389
392
|
|
|
390
|
-
> <Array(<
|
|
393
|
+
> <Array(<ContentItemWriteResultResponse>, Integer, Hash)> create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
391
394
|
|
|
392
395
|
```ruby
|
|
393
396
|
begin
|
|
394
397
|
# Add a content list item
|
|
395
|
-
data, status_code, headers = api_instance.
|
|
398
|
+
data, status_code, headers = api_instance.create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
396
399
|
p status_code # => 2xx
|
|
397
400
|
p headers # => { ... }
|
|
398
|
-
p data # => <
|
|
401
|
+
p data # => <ContentItemWriteResultResponse>
|
|
399
402
|
rescue ApiSdkRb::ApiError => e
|
|
400
|
-
puts "Error when calling CompositionsApi->
|
|
403
|
+
puts "Error when calling CompositionsApi->create_composition_content_item_with_http_info: #{e}"
|
|
401
404
|
end
|
|
402
405
|
```
|
|
403
406
|
|
|
@@ -415,7 +418,7 @@ end
|
|
|
415
418
|
|
|
416
419
|
### Return type
|
|
417
420
|
|
|
418
|
-
[**
|
|
421
|
+
[**ContentItemWriteResultResponse**](ContentItemWriteResultResponse.md)
|
|
419
422
|
|
|
420
423
|
### Authorization
|
|
421
424
|
|
|
@@ -427,9 +430,9 @@ end
|
|
|
427
430
|
- **Accept**: application/json
|
|
428
431
|
|
|
429
432
|
|
|
430
|
-
##
|
|
433
|
+
## create_composition_database_record
|
|
431
434
|
|
|
432
|
-
> <
|
|
435
|
+
> <CompositionDatabaseRecordResponse> create_composition_database_record(id, table, idempotency_key, body, opts)
|
|
433
436
|
|
|
434
437
|
Create Record In Composition Database
|
|
435
438
|
|
|
@@ -458,28 +461,28 @@ opts = {
|
|
|
458
461
|
|
|
459
462
|
begin
|
|
460
463
|
# Create Record In Composition Database
|
|
461
|
-
result = api_instance.
|
|
464
|
+
result = api_instance.create_composition_database_record(id, table, idempotency_key, body, opts)
|
|
462
465
|
p result
|
|
463
466
|
rescue ApiSdkRb::ApiError => e
|
|
464
|
-
puts "Error when calling CompositionsApi->
|
|
467
|
+
puts "Error when calling CompositionsApi->create_composition_database_record: #{e}"
|
|
465
468
|
end
|
|
466
469
|
```
|
|
467
470
|
|
|
468
|
-
#### Using the
|
|
471
|
+
#### Using the create_composition_database_record_with_http_info variant
|
|
469
472
|
|
|
470
473
|
This returns an Array which contains the response data, status code and headers.
|
|
471
474
|
|
|
472
|
-
> <Array(<
|
|
475
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts)
|
|
473
476
|
|
|
474
477
|
```ruby
|
|
475
478
|
begin
|
|
476
479
|
# Create Record In Composition Database
|
|
477
|
-
data, status_code, headers = api_instance.
|
|
480
|
+
data, status_code, headers = api_instance.create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts)
|
|
478
481
|
p status_code # => 2xx
|
|
479
482
|
p headers # => { ... }
|
|
480
|
-
p data # => <
|
|
483
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
481
484
|
rescue ApiSdkRb::ApiError => e
|
|
482
|
-
puts "Error when calling CompositionsApi->
|
|
485
|
+
puts "Error when calling CompositionsApi->create_composition_database_record_with_http_info: #{e}"
|
|
483
486
|
end
|
|
484
487
|
```
|
|
485
488
|
|
|
@@ -496,7 +499,7 @@ end
|
|
|
496
499
|
|
|
497
500
|
### Return type
|
|
498
501
|
|
|
499
|
-
[**
|
|
502
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
500
503
|
|
|
501
504
|
### Authorization
|
|
502
505
|
|
|
@@ -508,9 +511,9 @@ end
|
|
|
508
511
|
- **Accept**: application/json
|
|
509
512
|
|
|
510
513
|
|
|
511
|
-
##
|
|
514
|
+
## delete_composition
|
|
512
515
|
|
|
513
|
-
>
|
|
516
|
+
> delete_composition(id, opts)
|
|
514
517
|
|
|
515
518
|
Delete Composition
|
|
516
519
|
|
|
@@ -536,27 +539,27 @@ opts = {
|
|
|
536
539
|
|
|
537
540
|
begin
|
|
538
541
|
# Delete Composition
|
|
539
|
-
api_instance.
|
|
542
|
+
api_instance.delete_composition(id, opts)
|
|
540
543
|
rescue ApiSdkRb::ApiError => e
|
|
541
|
-
puts "Error when calling CompositionsApi->
|
|
544
|
+
puts "Error when calling CompositionsApi->delete_composition: #{e}"
|
|
542
545
|
end
|
|
543
546
|
```
|
|
544
547
|
|
|
545
|
-
#### Using the
|
|
548
|
+
#### Using the delete_composition_with_http_info variant
|
|
546
549
|
|
|
547
550
|
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
548
551
|
|
|
549
|
-
> <Array(nil, Integer, Hash)>
|
|
552
|
+
> <Array(nil, Integer, Hash)> delete_composition_with_http_info(id, opts)
|
|
550
553
|
|
|
551
554
|
```ruby
|
|
552
555
|
begin
|
|
553
556
|
# Delete Composition
|
|
554
|
-
data, status_code, headers = api_instance.
|
|
557
|
+
data, status_code, headers = api_instance.delete_composition_with_http_info(id, opts)
|
|
555
558
|
p status_code # => 2xx
|
|
556
559
|
p headers # => { ... }
|
|
557
560
|
p data # => nil
|
|
558
561
|
rescue ApiSdkRb::ApiError => e
|
|
559
|
-
puts "Error when calling CompositionsApi->
|
|
562
|
+
puts "Error when calling CompositionsApi->delete_composition_with_http_info: #{e}"
|
|
560
563
|
end
|
|
561
564
|
```
|
|
562
565
|
|
|
@@ -582,9 +585,9 @@ nil (empty response body)
|
|
|
582
585
|
- **Accept**: application/json
|
|
583
586
|
|
|
584
587
|
|
|
585
|
-
##
|
|
588
|
+
## delete_composition_content_item
|
|
586
589
|
|
|
587
|
-
> <DeleteCompositionContentItemResponse>
|
|
590
|
+
> <DeleteCompositionContentItemResponse> delete_composition_content_item(id, list, item_id, idempotency_key, opts)
|
|
588
591
|
|
|
589
592
|
Delete a content list item
|
|
590
593
|
|
|
@@ -612,28 +615,28 @@ opts = {
|
|
|
612
615
|
|
|
613
616
|
begin
|
|
614
617
|
# Delete a content list item
|
|
615
|
-
result = api_instance.
|
|
618
|
+
result = api_instance.delete_composition_content_item(id, list, item_id, idempotency_key, opts)
|
|
616
619
|
p result
|
|
617
620
|
rescue ApiSdkRb::ApiError => e
|
|
618
|
-
puts "Error when calling CompositionsApi->
|
|
621
|
+
puts "Error when calling CompositionsApi->delete_composition_content_item: #{e}"
|
|
619
622
|
end
|
|
620
623
|
```
|
|
621
624
|
|
|
622
|
-
#### Using the
|
|
625
|
+
#### Using the delete_composition_content_item_with_http_info variant
|
|
623
626
|
|
|
624
627
|
This returns an Array which contains the response data, status code and headers.
|
|
625
628
|
|
|
626
|
-
> <Array(<DeleteCompositionContentItemResponse>, Integer, Hash)>
|
|
629
|
+
> <Array(<DeleteCompositionContentItemResponse>, Integer, Hash)> delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts)
|
|
627
630
|
|
|
628
631
|
```ruby
|
|
629
632
|
begin
|
|
630
633
|
# Delete a content list item
|
|
631
|
-
data, status_code, headers = api_instance.
|
|
634
|
+
data, status_code, headers = api_instance.delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts)
|
|
632
635
|
p status_code # => 2xx
|
|
633
636
|
p headers # => { ... }
|
|
634
637
|
p data # => <DeleteCompositionContentItemResponse>
|
|
635
638
|
rescue ApiSdkRb::ApiError => e
|
|
636
|
-
puts "Error when calling CompositionsApi->
|
|
639
|
+
puts "Error when calling CompositionsApi->delete_composition_content_item_with_http_info: #{e}"
|
|
637
640
|
end
|
|
638
641
|
```
|
|
639
642
|
|
|
@@ -663,9 +666,9 @@ end
|
|
|
663
666
|
- **Accept**: application/json
|
|
664
667
|
|
|
665
668
|
|
|
666
|
-
##
|
|
669
|
+
## delete_composition_data_source
|
|
667
670
|
|
|
668
|
-
> <DeleteCompositionDataSourceResponse>
|
|
671
|
+
> <DeleteCompositionDataSourceResponse> delete_composition_data_source(id, idempotency_key, opts)
|
|
669
672
|
|
|
670
673
|
Remove the composition data source binding
|
|
671
674
|
|
|
@@ -692,28 +695,28 @@ opts = {
|
|
|
692
695
|
|
|
693
696
|
begin
|
|
694
697
|
# Remove the composition data source binding
|
|
695
|
-
result = api_instance.
|
|
698
|
+
result = api_instance.delete_composition_data_source(id, idempotency_key, opts)
|
|
696
699
|
p result
|
|
697
700
|
rescue ApiSdkRb::ApiError => e
|
|
698
|
-
puts "Error when calling CompositionsApi->
|
|
701
|
+
puts "Error when calling CompositionsApi->delete_composition_data_source: #{e}"
|
|
699
702
|
end
|
|
700
703
|
```
|
|
701
704
|
|
|
702
|
-
#### Using the
|
|
705
|
+
#### Using the delete_composition_data_source_with_http_info variant
|
|
703
706
|
|
|
704
707
|
This returns an Array which contains the response data, status code and headers.
|
|
705
708
|
|
|
706
|
-
> <Array(<DeleteCompositionDataSourceResponse>, Integer, Hash)>
|
|
709
|
+
> <Array(<DeleteCompositionDataSourceResponse>, Integer, Hash)> delete_composition_data_source_with_http_info(id, idempotency_key, opts)
|
|
707
710
|
|
|
708
711
|
```ruby
|
|
709
712
|
begin
|
|
710
713
|
# Remove the composition data source binding
|
|
711
|
-
data, status_code, headers = api_instance.
|
|
714
|
+
data, status_code, headers = api_instance.delete_composition_data_source_with_http_info(id, idempotency_key, opts)
|
|
712
715
|
p status_code # => 2xx
|
|
713
716
|
p headers # => { ... }
|
|
714
717
|
p data # => <DeleteCompositionDataSourceResponse>
|
|
715
718
|
rescue ApiSdkRb::ApiError => e
|
|
716
|
-
puts "Error when calling CompositionsApi->
|
|
719
|
+
puts "Error when calling CompositionsApi->delete_composition_data_source_with_http_info: #{e}"
|
|
717
720
|
end
|
|
718
721
|
```
|
|
719
722
|
|
|
@@ -740,9 +743,9 @@ end
|
|
|
740
743
|
- **Accept**: application/json
|
|
741
744
|
|
|
742
745
|
|
|
743
|
-
##
|
|
746
|
+
## delete_composition_database_record
|
|
744
747
|
|
|
745
|
-
> <
|
|
748
|
+
> <CompositionDatabaseRecordResponse> delete_composition_database_record(id, table, record_id, opts)
|
|
746
749
|
|
|
747
750
|
Delete Record From Composition Database
|
|
748
751
|
|
|
@@ -770,28 +773,28 @@ opts = {
|
|
|
770
773
|
|
|
771
774
|
begin
|
|
772
775
|
# Delete Record From Composition Database
|
|
773
|
-
result = api_instance.
|
|
776
|
+
result = api_instance.delete_composition_database_record(id, table, record_id, opts)
|
|
774
777
|
p result
|
|
775
778
|
rescue ApiSdkRb::ApiError => e
|
|
776
|
-
puts "Error when calling CompositionsApi->
|
|
779
|
+
puts "Error when calling CompositionsApi->delete_composition_database_record: #{e}"
|
|
777
780
|
end
|
|
778
781
|
```
|
|
779
782
|
|
|
780
|
-
#### Using the
|
|
783
|
+
#### Using the delete_composition_database_record_with_http_info variant
|
|
781
784
|
|
|
782
785
|
This returns an Array which contains the response data, status code and headers.
|
|
783
786
|
|
|
784
|
-
> <Array(<
|
|
787
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> delete_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
785
788
|
|
|
786
789
|
```ruby
|
|
787
790
|
begin
|
|
788
791
|
# Delete Record From Composition Database
|
|
789
|
-
data, status_code, headers = api_instance.
|
|
792
|
+
data, status_code, headers = api_instance.delete_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
790
793
|
p status_code # => 2xx
|
|
791
794
|
p headers # => { ... }
|
|
792
|
-
p data # => <
|
|
795
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
793
796
|
rescue ApiSdkRb::ApiError => e
|
|
794
|
-
puts "Error when calling CompositionsApi->
|
|
797
|
+
puts "Error when calling CompositionsApi->delete_composition_database_record_with_http_info: #{e}"
|
|
795
798
|
end
|
|
796
799
|
```
|
|
797
800
|
|
|
@@ -807,7 +810,90 @@ end
|
|
|
807
810
|
|
|
808
811
|
### Return type
|
|
809
812
|
|
|
810
|
-
[**
|
|
813
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
814
|
+
|
|
815
|
+
### Authorization
|
|
816
|
+
|
|
817
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
818
|
+
|
|
819
|
+
### HTTP request headers
|
|
820
|
+
|
|
821
|
+
- **Content-Type**: Not defined
|
|
822
|
+
- **Accept**: application/json
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
## delete_composition_entry_items
|
|
826
|
+
|
|
827
|
+
> <CompositionEntryDeleteSuccess> delete_composition_entry_items(id, table, opts)
|
|
828
|
+
|
|
829
|
+
Delete composition entry items by id or host context
|
|
830
|
+
|
|
831
|
+
Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
832
|
+
|
|
833
|
+
### Examples
|
|
834
|
+
|
|
835
|
+
```ruby
|
|
836
|
+
require 'time'
|
|
837
|
+
require 'api-sdk-rb'
|
|
838
|
+
# setup authorization
|
|
839
|
+
ApiSdkRb.configure do |config|
|
|
840
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
841
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
842
|
+
end
|
|
843
|
+
|
|
844
|
+
api_instance = ApiSdkRb::CompositionsApi.new
|
|
845
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
846
|
+
table = 'table_example' # String |
|
|
847
|
+
opts = {
|
|
848
|
+
ids: 'ids_example', # String |
|
|
849
|
+
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
850
|
+
filter: { key: { key: 'inner_example'}}, # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
851
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
852
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
853
|
+
}
|
|
854
|
+
|
|
855
|
+
begin
|
|
856
|
+
# Delete composition entry items by id or host context
|
|
857
|
+
result = api_instance.delete_composition_entry_items(id, table, opts)
|
|
858
|
+
p result
|
|
859
|
+
rescue ApiSdkRb::ApiError => e
|
|
860
|
+
puts "Error when calling CompositionsApi->delete_composition_entry_items: #{e}"
|
|
861
|
+
end
|
|
862
|
+
```
|
|
863
|
+
|
|
864
|
+
#### Using the delete_composition_entry_items_with_http_info variant
|
|
865
|
+
|
|
866
|
+
This returns an Array which contains the response data, status code and headers.
|
|
867
|
+
|
|
868
|
+
> <Array(<CompositionEntryDeleteSuccess>, Integer, Hash)> delete_composition_entry_items_with_http_info(id, table, opts)
|
|
869
|
+
|
|
870
|
+
```ruby
|
|
871
|
+
begin
|
|
872
|
+
# Delete composition entry items by id or host context
|
|
873
|
+
data, status_code, headers = api_instance.delete_composition_entry_items_with_http_info(id, table, opts)
|
|
874
|
+
p status_code # => 2xx
|
|
875
|
+
p headers # => { ... }
|
|
876
|
+
p data # => <CompositionEntryDeleteSuccess>
|
|
877
|
+
rescue ApiSdkRb::ApiError => e
|
|
878
|
+
puts "Error when calling CompositionsApi->delete_composition_entry_items_with_http_info: #{e}"
|
|
879
|
+
end
|
|
880
|
+
```
|
|
881
|
+
|
|
882
|
+
### Parameters
|
|
883
|
+
|
|
884
|
+
| Name | Type | Description | Notes |
|
|
885
|
+
| ---- | ---- | ----------- | ----- |
|
|
886
|
+
| **id** | **String** | | |
|
|
887
|
+
| **table** | **String** | | |
|
|
888
|
+
| **ids** | **String** | | [optional] |
|
|
889
|
+
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
890
|
+
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
891
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
892
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
893
|
+
|
|
894
|
+
### Return type
|
|
895
|
+
|
|
896
|
+
[**CompositionEntryDeleteSuccess**](CompositionEntryDeleteSuccess.md)
|
|
811
897
|
|
|
812
898
|
### Authorization
|
|
813
899
|
|
|
@@ -819,9 +905,9 @@ end
|
|
|
819
905
|
- **Accept**: application/json
|
|
820
906
|
|
|
821
907
|
|
|
822
|
-
##
|
|
908
|
+
## describe_composition_entries
|
|
823
909
|
|
|
824
|
-
> <CompositionEntriesDescriptionResponse>
|
|
910
|
+
> <CompositionEntriesDescriptionResponse> describe_composition_entries(id, opts)
|
|
825
911
|
|
|
826
912
|
Describe What a Composition Keeps
|
|
827
913
|
|
|
@@ -847,28 +933,28 @@ opts = {
|
|
|
847
933
|
|
|
848
934
|
begin
|
|
849
935
|
# Describe What a Composition Keeps
|
|
850
|
-
result = api_instance.
|
|
936
|
+
result = api_instance.describe_composition_entries(id, opts)
|
|
851
937
|
p result
|
|
852
938
|
rescue ApiSdkRb::ApiError => e
|
|
853
|
-
puts "Error when calling CompositionsApi->
|
|
939
|
+
puts "Error when calling CompositionsApi->describe_composition_entries: #{e}"
|
|
854
940
|
end
|
|
855
941
|
```
|
|
856
942
|
|
|
857
|
-
#### Using the
|
|
943
|
+
#### Using the describe_composition_entries_with_http_info variant
|
|
858
944
|
|
|
859
945
|
This returns an Array which contains the response data, status code and headers.
|
|
860
946
|
|
|
861
|
-
> <Array(<CompositionEntriesDescriptionResponse>, Integer, Hash)>
|
|
947
|
+
> <Array(<CompositionEntriesDescriptionResponse>, Integer, Hash)> describe_composition_entries_with_http_info(id, opts)
|
|
862
948
|
|
|
863
949
|
```ruby
|
|
864
950
|
begin
|
|
865
951
|
# Describe What a Composition Keeps
|
|
866
|
-
data, status_code, headers = api_instance.
|
|
952
|
+
data, status_code, headers = api_instance.describe_composition_entries_with_http_info(id, opts)
|
|
867
953
|
p status_code # => 2xx
|
|
868
954
|
p headers # => { ... }
|
|
869
955
|
p data # => <CompositionEntriesDescriptionResponse>
|
|
870
956
|
rescue ApiSdkRb::ApiError => e
|
|
871
|
-
puts "Error when calling CompositionsApi->
|
|
957
|
+
puts "Error when calling CompositionsApi->describe_composition_entries_with_http_info: #{e}"
|
|
872
958
|
end
|
|
873
959
|
```
|
|
874
960
|
|
|
@@ -894,9 +980,9 @@ end
|
|
|
894
980
|
- **Accept**: application/json
|
|
895
981
|
|
|
896
982
|
|
|
897
|
-
##
|
|
983
|
+
## duplicate_composition
|
|
898
984
|
|
|
899
|
-
> <DuplicateComposition202Response>
|
|
985
|
+
> <DuplicateComposition202Response> duplicate_composition(id, idempotency_key, opts)
|
|
900
986
|
|
|
901
987
|
Duplicate Composition
|
|
902
988
|
|
|
@@ -924,28 +1010,28 @@ opts = {
|
|
|
924
1010
|
|
|
925
1011
|
begin
|
|
926
1012
|
# Duplicate Composition
|
|
927
|
-
result = api_instance.
|
|
1013
|
+
result = api_instance.duplicate_composition(id, idempotency_key, opts)
|
|
928
1014
|
p result
|
|
929
1015
|
rescue ApiSdkRb::ApiError => e
|
|
930
|
-
puts "Error when calling CompositionsApi->
|
|
1016
|
+
puts "Error when calling CompositionsApi->duplicate_composition: #{e}"
|
|
931
1017
|
end
|
|
932
1018
|
```
|
|
933
1019
|
|
|
934
|
-
#### Using the
|
|
1020
|
+
#### Using the duplicate_composition_with_http_info variant
|
|
935
1021
|
|
|
936
1022
|
This returns an Array which contains the response data, status code and headers.
|
|
937
1023
|
|
|
938
|
-
> <Array(<DuplicateComposition202Response>, Integer, Hash)>
|
|
1024
|
+
> <Array(<DuplicateComposition202Response>, Integer, Hash)> duplicate_composition_with_http_info(id, idempotency_key, opts)
|
|
939
1025
|
|
|
940
1026
|
```ruby
|
|
941
1027
|
begin
|
|
942
1028
|
# Duplicate Composition
|
|
943
|
-
data, status_code, headers = api_instance.
|
|
1029
|
+
data, status_code, headers = api_instance.duplicate_composition_with_http_info(id, idempotency_key, opts)
|
|
944
1030
|
p status_code # => 2xx
|
|
945
1031
|
p headers # => { ... }
|
|
946
1032
|
p data # => <DuplicateComposition202Response>
|
|
947
1033
|
rescue ApiSdkRb::ApiError => e
|
|
948
|
-
puts "Error when calling CompositionsApi->
|
|
1034
|
+
puts "Error when calling CompositionsApi->duplicate_composition_with_http_info: #{e}"
|
|
949
1035
|
end
|
|
950
1036
|
```
|
|
951
1037
|
|
|
@@ -973,9 +1059,98 @@ end
|
|
|
973
1059
|
- **Accept**: application/json
|
|
974
1060
|
|
|
975
1061
|
|
|
976
|
-
##
|
|
1062
|
+
## export_composition_entry_items
|
|
1063
|
+
|
|
1064
|
+
> String export_composition_entry_items(id, table, opts)
|
|
1065
|
+
|
|
1066
|
+
Export composition entry items
|
|
1067
|
+
|
|
1068
|
+
Streams up to 50,000 matching rows in batches of 1,000. Tables without cursor paging export at most one batch; when more rows exist the response sets `X-Widgetic-Export-Truncated: true`. Rate limit 20 requests per minute.
|
|
1069
|
+
|
|
1070
|
+
### Examples
|
|
1071
|
+
|
|
1072
|
+
```ruby
|
|
1073
|
+
require 'time'
|
|
1074
|
+
require 'api-sdk-rb'
|
|
1075
|
+
# setup authorization
|
|
1076
|
+
ApiSdkRb.configure do |config|
|
|
1077
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
1078
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1079
|
+
end
|
|
1080
|
+
|
|
1081
|
+
api_instance = ApiSdkRb::CompositionsApi.new
|
|
1082
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
1083
|
+
table = 'table_example' # String |
|
|
1084
|
+
opts = {
|
|
1085
|
+
format: 'csv', # String |
|
|
1086
|
+
order: 'asc', # String | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id.
|
|
1087
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`.
|
|
1088
|
+
_until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`).
|
|
1089
|
+
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
1090
|
+
filter: { key: { key: 'inner_example'}}, # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
1091
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1092
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
begin
|
|
1096
|
+
# Export composition entry items
|
|
1097
|
+
result = api_instance.export_composition_entry_items(id, table, opts)
|
|
1098
|
+
p result
|
|
1099
|
+
rescue ApiSdkRb::ApiError => e
|
|
1100
|
+
puts "Error when calling CompositionsApi->export_composition_entry_items: #{e}"
|
|
1101
|
+
end
|
|
1102
|
+
```
|
|
1103
|
+
|
|
1104
|
+
#### Using the export_composition_entry_items_with_http_info variant
|
|
1105
|
+
|
|
1106
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1107
|
+
|
|
1108
|
+
> <Array(String, Integer, Hash)> export_composition_entry_items_with_http_info(id, table, opts)
|
|
1109
|
+
|
|
1110
|
+
```ruby
|
|
1111
|
+
begin
|
|
1112
|
+
# Export composition entry items
|
|
1113
|
+
data, status_code, headers = api_instance.export_composition_entry_items_with_http_info(id, table, opts)
|
|
1114
|
+
p status_code # => 2xx
|
|
1115
|
+
p headers # => { ... }
|
|
1116
|
+
p data # => String
|
|
1117
|
+
rescue ApiSdkRb::ApiError => e
|
|
1118
|
+
puts "Error when calling CompositionsApi->export_composition_entry_items_with_http_info: #{e}"
|
|
1119
|
+
end
|
|
1120
|
+
```
|
|
1121
|
+
|
|
1122
|
+
### Parameters
|
|
1123
|
+
|
|
1124
|
+
| Name | Type | Description | Notes |
|
|
1125
|
+
| ---- | ---- | ----------- | ----- |
|
|
1126
|
+
| **id** | **String** | | |
|
|
1127
|
+
| **table** | **String** | | |
|
|
1128
|
+
| **format** | **String** | | [optional][default to 'csv'] |
|
|
1129
|
+
| **order** | **String** | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id. | [optional][default to 'desc'] |
|
|
1130
|
+
| **since** | **Time** | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`. | [optional] |
|
|
1131
|
+
| **_until** | **Time** | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`). | [optional] |
|
|
1132
|
+
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
1133
|
+
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
1134
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1135
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
1136
|
+
|
|
1137
|
+
### Return type
|
|
1138
|
+
|
|
1139
|
+
**String**
|
|
1140
|
+
|
|
1141
|
+
### Authorization
|
|
1142
|
+
|
|
1143
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
1144
|
+
|
|
1145
|
+
### HTTP request headers
|
|
1146
|
+
|
|
1147
|
+
- **Content-Type**: Not defined
|
|
1148
|
+
- **Accept**: text/csv, application/json
|
|
1149
|
+
|
|
977
1150
|
|
|
978
|
-
|
|
1151
|
+
## get_ai_answers_knowledge
|
|
1152
|
+
|
|
1153
|
+
> <GetAiAnswersKnowledge200Response> get_ai_answers_knowledge(id, opts)
|
|
979
1154
|
|
|
980
1155
|
See the documents a widget's AI answers from
|
|
981
1156
|
|
|
@@ -1001,28 +1176,28 @@ opts = {
|
|
|
1001
1176
|
|
|
1002
1177
|
begin
|
|
1003
1178
|
# See the documents a widget's AI answers from
|
|
1004
|
-
result = api_instance.
|
|
1179
|
+
result = api_instance.get_ai_answers_knowledge(id, opts)
|
|
1005
1180
|
p result
|
|
1006
1181
|
rescue ApiSdkRb::ApiError => e
|
|
1007
|
-
puts "Error when calling CompositionsApi->
|
|
1182
|
+
puts "Error when calling CompositionsApi->get_ai_answers_knowledge: #{e}"
|
|
1008
1183
|
end
|
|
1009
1184
|
```
|
|
1010
1185
|
|
|
1011
|
-
#### Using the
|
|
1186
|
+
#### Using the get_ai_answers_knowledge_with_http_info variant
|
|
1012
1187
|
|
|
1013
1188
|
This returns an Array which contains the response data, status code and headers.
|
|
1014
1189
|
|
|
1015
|
-
> <Array(<GetAiAnswersKnowledge200Response>, Integer, Hash)>
|
|
1190
|
+
> <Array(<GetAiAnswersKnowledge200Response>, Integer, Hash)> get_ai_answers_knowledge_with_http_info(id, opts)
|
|
1016
1191
|
|
|
1017
1192
|
```ruby
|
|
1018
1193
|
begin
|
|
1019
1194
|
# See the documents a widget's AI answers from
|
|
1020
|
-
data, status_code, headers = api_instance.
|
|
1195
|
+
data, status_code, headers = api_instance.get_ai_answers_knowledge_with_http_info(id, opts)
|
|
1021
1196
|
p status_code # => 2xx
|
|
1022
1197
|
p headers # => { ... }
|
|
1023
1198
|
p data # => <GetAiAnswersKnowledge200Response>
|
|
1024
1199
|
rescue ApiSdkRb::ApiError => e
|
|
1025
|
-
puts "Error when calling CompositionsApi->
|
|
1200
|
+
puts "Error when calling CompositionsApi->get_ai_answers_knowledge_with_http_info: #{e}"
|
|
1026
1201
|
end
|
|
1027
1202
|
```
|
|
1028
1203
|
|
|
@@ -1048,9 +1223,9 @@ end
|
|
|
1048
1223
|
- **Accept**: application/json
|
|
1049
1224
|
|
|
1050
1225
|
|
|
1051
|
-
##
|
|
1226
|
+
## get_all_compositions
|
|
1052
1227
|
|
|
1053
|
-
> <GetAllCompositions200Response>
|
|
1228
|
+
> <GetAllCompositions200Response> get_all_compositions(opts)
|
|
1054
1229
|
|
|
1055
1230
|
Get All Compositions
|
|
1056
1231
|
|
|
@@ -1084,28 +1259,28 @@ opts = {
|
|
|
1084
1259
|
|
|
1085
1260
|
begin
|
|
1086
1261
|
# Get All Compositions
|
|
1087
|
-
result = api_instance.
|
|
1262
|
+
result = api_instance.get_all_compositions(opts)
|
|
1088
1263
|
p result
|
|
1089
1264
|
rescue ApiSdkRb::ApiError => e
|
|
1090
|
-
puts "Error when calling CompositionsApi->
|
|
1265
|
+
puts "Error when calling CompositionsApi->get_all_compositions: #{e}"
|
|
1091
1266
|
end
|
|
1092
1267
|
```
|
|
1093
1268
|
|
|
1094
|
-
#### Using the
|
|
1269
|
+
#### Using the get_all_compositions_with_http_info variant
|
|
1095
1270
|
|
|
1096
1271
|
This returns an Array which contains the response data, status code and headers.
|
|
1097
1272
|
|
|
1098
|
-
> <Array(<GetAllCompositions200Response>, Integer, Hash)>
|
|
1273
|
+
> <Array(<GetAllCompositions200Response>, Integer, Hash)> get_all_compositions_with_http_info(opts)
|
|
1099
1274
|
|
|
1100
1275
|
```ruby
|
|
1101
1276
|
begin
|
|
1102
1277
|
# Get All Compositions
|
|
1103
|
-
data, status_code, headers = api_instance.
|
|
1278
|
+
data, status_code, headers = api_instance.get_all_compositions_with_http_info(opts)
|
|
1104
1279
|
p status_code # => 2xx
|
|
1105
1280
|
p headers # => { ... }
|
|
1106
1281
|
p data # => <GetAllCompositions200Response>
|
|
1107
1282
|
rescue ApiSdkRb::ApiError => e
|
|
1108
|
-
puts "Error when calling CompositionsApi->
|
|
1283
|
+
puts "Error when calling CompositionsApi->get_all_compositions_with_http_info: #{e}"
|
|
1109
1284
|
end
|
|
1110
1285
|
```
|
|
1111
1286
|
|
|
@@ -1139,9 +1314,9 @@ end
|
|
|
1139
1314
|
- **Accept**: application/json
|
|
1140
1315
|
|
|
1141
1316
|
|
|
1142
|
-
##
|
|
1317
|
+
## get_composition_by_id
|
|
1143
1318
|
|
|
1144
|
-
> <
|
|
1319
|
+
> <CompositionResponse> get_composition_by_id(id, opts)
|
|
1145
1320
|
|
|
1146
1321
|
Get Composition
|
|
1147
1322
|
|
|
@@ -1167,28 +1342,28 @@ opts = {
|
|
|
1167
1342
|
|
|
1168
1343
|
begin
|
|
1169
1344
|
# Get Composition
|
|
1170
|
-
result = api_instance.
|
|
1345
|
+
result = api_instance.get_composition_by_id(id, opts)
|
|
1171
1346
|
p result
|
|
1172
1347
|
rescue ApiSdkRb::ApiError => e
|
|
1173
|
-
puts "Error when calling CompositionsApi->
|
|
1348
|
+
puts "Error when calling CompositionsApi->get_composition_by_id: #{e}"
|
|
1174
1349
|
end
|
|
1175
1350
|
```
|
|
1176
1351
|
|
|
1177
|
-
#### Using the
|
|
1352
|
+
#### Using the get_composition_by_id_with_http_info variant
|
|
1178
1353
|
|
|
1179
1354
|
This returns an Array which contains the response data, status code and headers.
|
|
1180
1355
|
|
|
1181
|
-
> <Array(<
|
|
1356
|
+
> <Array(<CompositionResponse>, Integer, Hash)> get_composition_by_id_with_http_info(id, opts)
|
|
1182
1357
|
|
|
1183
1358
|
```ruby
|
|
1184
1359
|
begin
|
|
1185
1360
|
# Get Composition
|
|
1186
|
-
data, status_code, headers = api_instance.
|
|
1361
|
+
data, status_code, headers = api_instance.get_composition_by_id_with_http_info(id, opts)
|
|
1187
1362
|
p status_code # => 2xx
|
|
1188
1363
|
p headers # => { ... }
|
|
1189
|
-
p data # => <
|
|
1364
|
+
p data # => <CompositionResponse>
|
|
1190
1365
|
rescue ApiSdkRb::ApiError => e
|
|
1191
|
-
puts "Error when calling CompositionsApi->
|
|
1366
|
+
puts "Error when calling CompositionsApi->get_composition_by_id_with_http_info: #{e}"
|
|
1192
1367
|
end
|
|
1193
1368
|
```
|
|
1194
1369
|
|
|
@@ -1202,7 +1377,7 @@ end
|
|
|
1202
1377
|
|
|
1203
1378
|
### Return type
|
|
1204
1379
|
|
|
1205
|
-
[**
|
|
1380
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
1206
1381
|
|
|
1207
1382
|
### Authorization
|
|
1208
1383
|
|
|
@@ -1214,9 +1389,9 @@ end
|
|
|
1214
1389
|
- **Accept**: application/json
|
|
1215
1390
|
|
|
1216
1391
|
|
|
1217
|
-
##
|
|
1392
|
+
## get_composition_content
|
|
1218
1393
|
|
|
1219
|
-
> <GetCompositionContentResponse>
|
|
1394
|
+
> <GetCompositionContentResponse> get_composition_content(id, opts)
|
|
1220
1395
|
|
|
1221
1396
|
Get Current Content
|
|
1222
1397
|
|
|
@@ -1242,28 +1417,28 @@ opts = {
|
|
|
1242
1417
|
|
|
1243
1418
|
begin
|
|
1244
1419
|
# Get Current Content
|
|
1245
|
-
result = api_instance.
|
|
1420
|
+
result = api_instance.get_composition_content(id, opts)
|
|
1246
1421
|
p result
|
|
1247
1422
|
rescue ApiSdkRb::ApiError => e
|
|
1248
|
-
puts "Error when calling CompositionsApi->
|
|
1423
|
+
puts "Error when calling CompositionsApi->get_composition_content: #{e}"
|
|
1249
1424
|
end
|
|
1250
1425
|
```
|
|
1251
1426
|
|
|
1252
|
-
#### Using the
|
|
1427
|
+
#### Using the get_composition_content_with_http_info variant
|
|
1253
1428
|
|
|
1254
1429
|
This returns an Array which contains the response data, status code and headers.
|
|
1255
1430
|
|
|
1256
|
-
> <Array(<GetCompositionContentResponse>, Integer, Hash)>
|
|
1431
|
+
> <Array(<GetCompositionContentResponse>, Integer, Hash)> get_composition_content_with_http_info(id, opts)
|
|
1257
1432
|
|
|
1258
1433
|
```ruby
|
|
1259
1434
|
begin
|
|
1260
1435
|
# Get Current Content
|
|
1261
|
-
data, status_code, headers = api_instance.
|
|
1436
|
+
data, status_code, headers = api_instance.get_composition_content_with_http_info(id, opts)
|
|
1262
1437
|
p status_code # => 2xx
|
|
1263
1438
|
p headers # => { ... }
|
|
1264
1439
|
p data # => <GetCompositionContentResponse>
|
|
1265
1440
|
rescue ApiSdkRb::ApiError => e
|
|
1266
|
-
puts "Error when calling CompositionsApi->
|
|
1441
|
+
puts "Error when calling CompositionsApi->get_composition_content_with_http_info: #{e}"
|
|
1267
1442
|
end
|
|
1268
1443
|
```
|
|
1269
1444
|
|
|
@@ -1289,9 +1464,9 @@ end
|
|
|
1289
1464
|
- **Accept**: application/json
|
|
1290
1465
|
|
|
1291
1466
|
|
|
1292
|
-
##
|
|
1467
|
+
## get_composition_content_schema
|
|
1293
1468
|
|
|
1294
|
-
> <GetCompositionContentSchemaResponse>
|
|
1469
|
+
> <GetCompositionContentSchemaResponse> get_composition_content_schema(id, opts)
|
|
1295
1470
|
|
|
1296
1471
|
Get Content Schema
|
|
1297
1472
|
|
|
@@ -1317,28 +1492,28 @@ opts = {
|
|
|
1317
1492
|
|
|
1318
1493
|
begin
|
|
1319
1494
|
# Get Content Schema
|
|
1320
|
-
result = api_instance.
|
|
1495
|
+
result = api_instance.get_composition_content_schema(id, opts)
|
|
1321
1496
|
p result
|
|
1322
1497
|
rescue ApiSdkRb::ApiError => e
|
|
1323
|
-
puts "Error when calling CompositionsApi->
|
|
1498
|
+
puts "Error when calling CompositionsApi->get_composition_content_schema: #{e}"
|
|
1324
1499
|
end
|
|
1325
1500
|
```
|
|
1326
1501
|
|
|
1327
|
-
#### Using the
|
|
1502
|
+
#### Using the get_composition_content_schema_with_http_info variant
|
|
1328
1503
|
|
|
1329
1504
|
This returns an Array which contains the response data, status code and headers.
|
|
1330
1505
|
|
|
1331
|
-
> <Array(<GetCompositionContentSchemaResponse>, Integer, Hash)>
|
|
1506
|
+
> <Array(<GetCompositionContentSchemaResponse>, Integer, Hash)> get_composition_content_schema_with_http_info(id, opts)
|
|
1332
1507
|
|
|
1333
1508
|
```ruby
|
|
1334
1509
|
begin
|
|
1335
1510
|
# Get Content Schema
|
|
1336
|
-
data, status_code, headers = api_instance.
|
|
1511
|
+
data, status_code, headers = api_instance.get_composition_content_schema_with_http_info(id, opts)
|
|
1337
1512
|
p status_code # => 2xx
|
|
1338
1513
|
p headers # => { ... }
|
|
1339
1514
|
p data # => <GetCompositionContentSchemaResponse>
|
|
1340
1515
|
rescue ApiSdkRb::ApiError => e
|
|
1341
|
-
puts "Error when calling CompositionsApi->
|
|
1516
|
+
puts "Error when calling CompositionsApi->get_composition_content_schema_with_http_info: #{e}"
|
|
1342
1517
|
end
|
|
1343
1518
|
```
|
|
1344
1519
|
|
|
@@ -1364,9 +1539,9 @@ end
|
|
|
1364
1539
|
- **Accept**: application/json
|
|
1365
1540
|
|
|
1366
1541
|
|
|
1367
|
-
##
|
|
1542
|
+
## get_composition_data_source
|
|
1368
1543
|
|
|
1369
|
-
> <GetCompositionDataSourceResponse>
|
|
1544
|
+
> <GetCompositionDataSourceResponse> get_composition_data_source(id, opts)
|
|
1370
1545
|
|
|
1371
1546
|
Read the composition data source binding
|
|
1372
1547
|
|
|
@@ -1392,28 +1567,28 @@ opts = {
|
|
|
1392
1567
|
|
|
1393
1568
|
begin
|
|
1394
1569
|
# Read the composition data source binding
|
|
1395
|
-
result = api_instance.
|
|
1570
|
+
result = api_instance.get_composition_data_source(id, opts)
|
|
1396
1571
|
p result
|
|
1397
1572
|
rescue ApiSdkRb::ApiError => e
|
|
1398
|
-
puts "Error when calling CompositionsApi->
|
|
1573
|
+
puts "Error when calling CompositionsApi->get_composition_data_source: #{e}"
|
|
1399
1574
|
end
|
|
1400
1575
|
```
|
|
1401
1576
|
|
|
1402
|
-
#### Using the
|
|
1577
|
+
#### Using the get_composition_data_source_with_http_info variant
|
|
1403
1578
|
|
|
1404
1579
|
This returns an Array which contains the response data, status code and headers.
|
|
1405
1580
|
|
|
1406
|
-
> <Array(<GetCompositionDataSourceResponse>, Integer, Hash)>
|
|
1581
|
+
> <Array(<GetCompositionDataSourceResponse>, Integer, Hash)> get_composition_data_source_with_http_info(id, opts)
|
|
1407
1582
|
|
|
1408
1583
|
```ruby
|
|
1409
1584
|
begin
|
|
1410
1585
|
# Read the composition data source binding
|
|
1411
|
-
data, status_code, headers = api_instance.
|
|
1586
|
+
data, status_code, headers = api_instance.get_composition_data_source_with_http_info(id, opts)
|
|
1412
1587
|
p status_code # => 2xx
|
|
1413
1588
|
p headers # => { ... }
|
|
1414
1589
|
p data # => <GetCompositionDataSourceResponse>
|
|
1415
1590
|
rescue ApiSdkRb::ApiError => e
|
|
1416
|
-
puts "Error when calling CompositionsApi->
|
|
1591
|
+
puts "Error when calling CompositionsApi->get_composition_data_source_with_http_info: #{e}"
|
|
1417
1592
|
end
|
|
1418
1593
|
```
|
|
1419
1594
|
|
|
@@ -1439,9 +1614,9 @@ end
|
|
|
1439
1614
|
- **Accept**: application/json
|
|
1440
1615
|
|
|
1441
1616
|
|
|
1442
|
-
##
|
|
1617
|
+
## get_composition_database_record
|
|
1443
1618
|
|
|
1444
|
-
> <
|
|
1619
|
+
> <CompositionDatabaseRecordResponse> get_composition_database_record(id, table, record_id, opts)
|
|
1445
1620
|
|
|
1446
1621
|
Get Record From Composition Database
|
|
1447
1622
|
|
|
@@ -1469,28 +1644,28 @@ opts = {
|
|
|
1469
1644
|
|
|
1470
1645
|
begin
|
|
1471
1646
|
# Get Record From Composition Database
|
|
1472
|
-
result = api_instance.
|
|
1647
|
+
result = api_instance.get_composition_database_record(id, table, record_id, opts)
|
|
1473
1648
|
p result
|
|
1474
1649
|
rescue ApiSdkRb::ApiError => e
|
|
1475
|
-
puts "Error when calling CompositionsApi->
|
|
1650
|
+
puts "Error when calling CompositionsApi->get_composition_database_record: #{e}"
|
|
1476
1651
|
end
|
|
1477
1652
|
```
|
|
1478
1653
|
|
|
1479
|
-
#### Using the
|
|
1654
|
+
#### Using the get_composition_database_record_with_http_info variant
|
|
1480
1655
|
|
|
1481
1656
|
This returns an Array which contains the response data, status code and headers.
|
|
1482
1657
|
|
|
1483
|
-
> <Array(<
|
|
1658
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> get_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
1484
1659
|
|
|
1485
1660
|
```ruby
|
|
1486
1661
|
begin
|
|
1487
1662
|
# Get Record From Composition Database
|
|
1488
|
-
data, status_code, headers = api_instance.
|
|
1663
|
+
data, status_code, headers = api_instance.get_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
1489
1664
|
p status_code # => 2xx
|
|
1490
1665
|
p headers # => { ... }
|
|
1491
|
-
p data # => <
|
|
1666
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
1492
1667
|
rescue ApiSdkRb::ApiError => e
|
|
1493
|
-
puts "Error when calling CompositionsApi->
|
|
1668
|
+
puts "Error when calling CompositionsApi->get_composition_database_record_with_http_info: #{e}"
|
|
1494
1669
|
end
|
|
1495
1670
|
```
|
|
1496
1671
|
|
|
@@ -1506,7 +1681,7 @@ end
|
|
|
1506
1681
|
|
|
1507
1682
|
### Return type
|
|
1508
1683
|
|
|
1509
|
-
[**
|
|
1684
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
1510
1685
|
|
|
1511
1686
|
### Authorization
|
|
1512
1687
|
|
|
@@ -1518,9 +1693,9 @@ end
|
|
|
1518
1693
|
- **Accept**: application/json
|
|
1519
1694
|
|
|
1520
1695
|
|
|
1521
|
-
##
|
|
1696
|
+
## get_composition_database_records
|
|
1522
1697
|
|
|
1523
|
-
> <GetCompositionDatabaseRecords200Response>
|
|
1698
|
+
> <GetCompositionDatabaseRecords200Response> get_composition_database_records(id, table, opts)
|
|
1524
1699
|
|
|
1525
1700
|
Get All Records From Composition Database Table
|
|
1526
1701
|
|
|
@@ -1547,28 +1722,28 @@ opts = {
|
|
|
1547
1722
|
|
|
1548
1723
|
begin
|
|
1549
1724
|
# Get All Records From Composition Database Table
|
|
1550
|
-
result = api_instance.
|
|
1725
|
+
result = api_instance.get_composition_database_records(id, table, opts)
|
|
1551
1726
|
p result
|
|
1552
1727
|
rescue ApiSdkRb::ApiError => e
|
|
1553
|
-
puts "Error when calling CompositionsApi->
|
|
1728
|
+
puts "Error when calling CompositionsApi->get_composition_database_records: #{e}"
|
|
1554
1729
|
end
|
|
1555
1730
|
```
|
|
1556
1731
|
|
|
1557
|
-
#### Using the
|
|
1732
|
+
#### Using the get_composition_database_records_with_http_info variant
|
|
1558
1733
|
|
|
1559
1734
|
This returns an Array which contains the response data, status code and headers.
|
|
1560
1735
|
|
|
1561
|
-
> <Array(<GetCompositionDatabaseRecords200Response>, Integer, Hash)>
|
|
1736
|
+
> <Array(<GetCompositionDatabaseRecords200Response>, Integer, Hash)> get_composition_database_records_with_http_info(id, table, opts)
|
|
1562
1737
|
|
|
1563
1738
|
```ruby
|
|
1564
1739
|
begin
|
|
1565
1740
|
# Get All Records From Composition Database Table
|
|
1566
|
-
data, status_code, headers = api_instance.
|
|
1741
|
+
data, status_code, headers = api_instance.get_composition_database_records_with_http_info(id, table, opts)
|
|
1567
1742
|
p status_code # => 2xx
|
|
1568
1743
|
p headers # => { ... }
|
|
1569
1744
|
p data # => <GetCompositionDatabaseRecords200Response>
|
|
1570
1745
|
rescue ApiSdkRb::ApiError => e
|
|
1571
|
-
puts "Error when calling CompositionsApi->
|
|
1746
|
+
puts "Error when calling CompositionsApi->get_composition_database_records_with_http_info: #{e}"
|
|
1572
1747
|
end
|
|
1573
1748
|
```
|
|
1574
1749
|
|
|
@@ -1595,9 +1770,9 @@ end
|
|
|
1595
1770
|
- **Accept**: application/json
|
|
1596
1771
|
|
|
1597
1772
|
|
|
1598
|
-
##
|
|
1773
|
+
## get_composition_design
|
|
1599
1774
|
|
|
1600
|
-
> <GetCompositionDesignResponse>
|
|
1775
|
+
> <GetCompositionDesignResponse> get_composition_design(id, opts)
|
|
1601
1776
|
|
|
1602
1777
|
Get Composition Design
|
|
1603
1778
|
|
|
@@ -1623,28 +1798,28 @@ opts = {
|
|
|
1623
1798
|
|
|
1624
1799
|
begin
|
|
1625
1800
|
# Get Composition Design
|
|
1626
|
-
result = api_instance.
|
|
1801
|
+
result = api_instance.get_composition_design(id, opts)
|
|
1627
1802
|
p result
|
|
1628
1803
|
rescue ApiSdkRb::ApiError => e
|
|
1629
|
-
puts "Error when calling CompositionsApi->
|
|
1804
|
+
puts "Error when calling CompositionsApi->get_composition_design: #{e}"
|
|
1630
1805
|
end
|
|
1631
1806
|
```
|
|
1632
1807
|
|
|
1633
|
-
#### Using the
|
|
1808
|
+
#### Using the get_composition_design_with_http_info variant
|
|
1634
1809
|
|
|
1635
1810
|
This returns an Array which contains the response data, status code and headers.
|
|
1636
1811
|
|
|
1637
|
-
> <Array(<GetCompositionDesignResponse>, Integer, Hash)>
|
|
1812
|
+
> <Array(<GetCompositionDesignResponse>, Integer, Hash)> get_composition_design_with_http_info(id, opts)
|
|
1638
1813
|
|
|
1639
1814
|
```ruby
|
|
1640
1815
|
begin
|
|
1641
1816
|
# Get Composition Design
|
|
1642
|
-
data, status_code, headers = api_instance.
|
|
1817
|
+
data, status_code, headers = api_instance.get_composition_design_with_http_info(id, opts)
|
|
1643
1818
|
p status_code # => 2xx
|
|
1644
1819
|
p headers # => { ... }
|
|
1645
1820
|
p data # => <GetCompositionDesignResponse>
|
|
1646
1821
|
rescue ApiSdkRb::ApiError => e
|
|
1647
|
-
puts "Error when calling CompositionsApi->
|
|
1822
|
+
puts "Error when calling CompositionsApi->get_composition_design_with_http_info: #{e}"
|
|
1648
1823
|
end
|
|
1649
1824
|
```
|
|
1650
1825
|
|
|
@@ -1670,9 +1845,9 @@ end
|
|
|
1670
1845
|
- **Accept**: application/json
|
|
1671
1846
|
|
|
1672
1847
|
|
|
1673
|
-
##
|
|
1848
|
+
## get_composition_design_schema
|
|
1674
1849
|
|
|
1675
|
-
> <GetCompositionDesignSchemaResponse>
|
|
1850
|
+
> <GetCompositionDesignSchemaResponse> get_composition_design_schema(id, opts)
|
|
1676
1851
|
|
|
1677
1852
|
Get Design Schema
|
|
1678
1853
|
|
|
@@ -1698,28 +1873,28 @@ opts = {
|
|
|
1698
1873
|
|
|
1699
1874
|
begin
|
|
1700
1875
|
# Get Design Schema
|
|
1701
|
-
result = api_instance.
|
|
1876
|
+
result = api_instance.get_composition_design_schema(id, opts)
|
|
1702
1877
|
p result
|
|
1703
1878
|
rescue ApiSdkRb::ApiError => e
|
|
1704
|
-
puts "Error when calling CompositionsApi->
|
|
1879
|
+
puts "Error when calling CompositionsApi->get_composition_design_schema: #{e}"
|
|
1705
1880
|
end
|
|
1706
1881
|
```
|
|
1707
1882
|
|
|
1708
|
-
#### Using the
|
|
1883
|
+
#### Using the get_composition_design_schema_with_http_info variant
|
|
1709
1884
|
|
|
1710
1885
|
This returns an Array which contains the response data, status code and headers.
|
|
1711
1886
|
|
|
1712
|
-
> <Array(<GetCompositionDesignSchemaResponse>, Integer, Hash)>
|
|
1887
|
+
> <Array(<GetCompositionDesignSchemaResponse>, Integer, Hash)> get_composition_design_schema_with_http_info(id, opts)
|
|
1713
1888
|
|
|
1714
1889
|
```ruby
|
|
1715
1890
|
begin
|
|
1716
1891
|
# Get Design Schema
|
|
1717
|
-
data, status_code, headers = api_instance.
|
|
1892
|
+
data, status_code, headers = api_instance.get_composition_design_schema_with_http_info(id, opts)
|
|
1718
1893
|
p status_code # => 2xx
|
|
1719
1894
|
p headers # => { ... }
|
|
1720
1895
|
p data # => <GetCompositionDesignSchemaResponse>
|
|
1721
1896
|
rescue ApiSdkRb::ApiError => e
|
|
1722
|
-
puts "Error when calling CompositionsApi->
|
|
1897
|
+
puts "Error when calling CompositionsApi->get_composition_design_schema_with_http_info: #{e}"
|
|
1723
1898
|
end
|
|
1724
1899
|
```
|
|
1725
1900
|
|
|
@@ -1745,9 +1920,9 @@ end
|
|
|
1745
1920
|
- **Accept**: application/json
|
|
1746
1921
|
|
|
1747
1922
|
|
|
1748
|
-
##
|
|
1923
|
+
## get_composition_embed_schema
|
|
1749
1924
|
|
|
1750
|
-
> <GetCompositionEmbedSchemaResponse>
|
|
1925
|
+
> <GetCompositionEmbedSchemaResponse> get_composition_embed_schema(id, opts)
|
|
1751
1926
|
|
|
1752
1927
|
Get Embed Schema
|
|
1753
1928
|
|
|
@@ -1773,28 +1948,28 @@ opts = {
|
|
|
1773
1948
|
|
|
1774
1949
|
begin
|
|
1775
1950
|
# Get Embed Schema
|
|
1776
|
-
result = api_instance.
|
|
1951
|
+
result = api_instance.get_composition_embed_schema(id, opts)
|
|
1777
1952
|
p result
|
|
1778
1953
|
rescue ApiSdkRb::ApiError => e
|
|
1779
|
-
puts "Error when calling CompositionsApi->
|
|
1954
|
+
puts "Error when calling CompositionsApi->get_composition_embed_schema: #{e}"
|
|
1780
1955
|
end
|
|
1781
1956
|
```
|
|
1782
1957
|
|
|
1783
|
-
#### Using the
|
|
1958
|
+
#### Using the get_composition_embed_schema_with_http_info variant
|
|
1784
1959
|
|
|
1785
1960
|
This returns an Array which contains the response data, status code and headers.
|
|
1786
1961
|
|
|
1787
|
-
> <Array(<GetCompositionEmbedSchemaResponse>, Integer, Hash)>
|
|
1962
|
+
> <Array(<GetCompositionEmbedSchemaResponse>, Integer, Hash)> get_composition_embed_schema_with_http_info(id, opts)
|
|
1788
1963
|
|
|
1789
1964
|
```ruby
|
|
1790
1965
|
begin
|
|
1791
1966
|
# Get Embed Schema
|
|
1792
|
-
data, status_code, headers = api_instance.
|
|
1967
|
+
data, status_code, headers = api_instance.get_composition_embed_schema_with_http_info(id, opts)
|
|
1793
1968
|
p status_code # => 2xx
|
|
1794
1969
|
p headers # => { ... }
|
|
1795
1970
|
p data # => <GetCompositionEmbedSchemaResponse>
|
|
1796
1971
|
rescue ApiSdkRb::ApiError => e
|
|
1797
|
-
puts "Error when calling CompositionsApi->
|
|
1972
|
+
puts "Error when calling CompositionsApi->get_composition_embed_schema_with_http_info: #{e}"
|
|
1798
1973
|
end
|
|
1799
1974
|
```
|
|
1800
1975
|
|
|
@@ -1820,9 +1995,9 @@ end
|
|
|
1820
1995
|
- **Accept**: application/json
|
|
1821
1996
|
|
|
1822
1997
|
|
|
1823
|
-
##
|
|
1998
|
+
## get_composition_embed_settings
|
|
1824
1999
|
|
|
1825
|
-
> <GetCompositionEmbedSettingsResponse>
|
|
2000
|
+
> <GetCompositionEmbedSettingsResponse> get_composition_embed_settings(id, opts)
|
|
1826
2001
|
|
|
1827
2002
|
Get Composition Embed Settings
|
|
1828
2003
|
|
|
@@ -1848,28 +2023,28 @@ opts = {
|
|
|
1848
2023
|
|
|
1849
2024
|
begin
|
|
1850
2025
|
# Get Composition Embed Settings
|
|
1851
|
-
result = api_instance.
|
|
2026
|
+
result = api_instance.get_composition_embed_settings(id, opts)
|
|
1852
2027
|
p result
|
|
1853
2028
|
rescue ApiSdkRb::ApiError => e
|
|
1854
|
-
puts "Error when calling CompositionsApi->
|
|
2029
|
+
puts "Error when calling CompositionsApi->get_composition_embed_settings: #{e}"
|
|
1855
2030
|
end
|
|
1856
2031
|
```
|
|
1857
2032
|
|
|
1858
|
-
#### Using the
|
|
2033
|
+
#### Using the get_composition_embed_settings_with_http_info variant
|
|
1859
2034
|
|
|
1860
2035
|
This returns an Array which contains the response data, status code and headers.
|
|
1861
2036
|
|
|
1862
|
-
> <Array(<GetCompositionEmbedSettingsResponse>, Integer, Hash)>
|
|
2037
|
+
> <Array(<GetCompositionEmbedSettingsResponse>, Integer, Hash)> get_composition_embed_settings_with_http_info(id, opts)
|
|
1863
2038
|
|
|
1864
2039
|
```ruby
|
|
1865
2040
|
begin
|
|
1866
2041
|
# Get Composition Embed Settings
|
|
1867
|
-
data, status_code, headers = api_instance.
|
|
2042
|
+
data, status_code, headers = api_instance.get_composition_embed_settings_with_http_info(id, opts)
|
|
1868
2043
|
p status_code # => 2xx
|
|
1869
2044
|
p headers # => { ... }
|
|
1870
2045
|
p data # => <GetCompositionEmbedSettingsResponse>
|
|
1871
2046
|
rescue ApiSdkRb::ApiError => e
|
|
1872
|
-
puts "Error when calling CompositionsApi->
|
|
2047
|
+
puts "Error when calling CompositionsApi->get_composition_embed_settings_with_http_info: #{e}"
|
|
1873
2048
|
end
|
|
1874
2049
|
```
|
|
1875
2050
|
|
|
@@ -1895,9 +2070,9 @@ end
|
|
|
1895
2070
|
- **Accept**: application/json
|
|
1896
2071
|
|
|
1897
2072
|
|
|
1898
|
-
##
|
|
2073
|
+
## get_composition_preview
|
|
1899
2074
|
|
|
1900
|
-
> <GetCompositionPreviewResponse>
|
|
2075
|
+
> <GetCompositionPreviewResponse> get_composition_preview(id, opts)
|
|
1901
2076
|
|
|
1902
2077
|
Get Composition Preview
|
|
1903
2078
|
|
|
@@ -1923,28 +2098,28 @@ opts = {
|
|
|
1923
2098
|
|
|
1924
2099
|
begin
|
|
1925
2100
|
# Get Composition Preview
|
|
1926
|
-
result = api_instance.
|
|
2101
|
+
result = api_instance.get_composition_preview(id, opts)
|
|
1927
2102
|
p result
|
|
1928
2103
|
rescue ApiSdkRb::ApiError => e
|
|
1929
|
-
puts "Error when calling CompositionsApi->
|
|
2104
|
+
puts "Error when calling CompositionsApi->get_composition_preview: #{e}"
|
|
1930
2105
|
end
|
|
1931
2106
|
```
|
|
1932
2107
|
|
|
1933
|
-
#### Using the
|
|
2108
|
+
#### Using the get_composition_preview_with_http_info variant
|
|
1934
2109
|
|
|
1935
2110
|
This returns an Array which contains the response data, status code and headers.
|
|
1936
2111
|
|
|
1937
|
-
> <Array(<GetCompositionPreviewResponse>, Integer, Hash)>
|
|
2112
|
+
> <Array(<GetCompositionPreviewResponse>, Integer, Hash)> get_composition_preview_with_http_info(id, opts)
|
|
1938
2113
|
|
|
1939
2114
|
```ruby
|
|
1940
2115
|
begin
|
|
1941
2116
|
# Get Composition Preview
|
|
1942
|
-
data, status_code, headers = api_instance.
|
|
2117
|
+
data, status_code, headers = api_instance.get_composition_preview_with_http_info(id, opts)
|
|
1943
2118
|
p status_code # => 2xx
|
|
1944
2119
|
p headers # => { ... }
|
|
1945
2120
|
p data # => <GetCompositionPreviewResponse>
|
|
1946
2121
|
rescue ApiSdkRb::ApiError => e
|
|
1947
|
-
puts "Error when calling CompositionsApi->
|
|
2122
|
+
puts "Error when calling CompositionsApi->get_composition_preview_with_http_info: #{e}"
|
|
1948
2123
|
end
|
|
1949
2124
|
```
|
|
1950
2125
|
|
|
@@ -1970,9 +2145,9 @@ end
|
|
|
1970
2145
|
- **Accept**: application/json
|
|
1971
2146
|
|
|
1972
2147
|
|
|
1973
|
-
##
|
|
2148
|
+
## get_composition_versions
|
|
1974
2149
|
|
|
1975
|
-
> <GetCompositionVersions200Response>
|
|
2150
|
+
> <GetCompositionVersions200Response> get_composition_versions(id, opts)
|
|
1976
2151
|
|
|
1977
2152
|
Get Composition Versions
|
|
1978
2153
|
|
|
@@ -1998,28 +2173,28 @@ opts = {
|
|
|
1998
2173
|
|
|
1999
2174
|
begin
|
|
2000
2175
|
# Get Composition Versions
|
|
2001
|
-
result = api_instance.
|
|
2176
|
+
result = api_instance.get_composition_versions(id, opts)
|
|
2002
2177
|
p result
|
|
2003
2178
|
rescue ApiSdkRb::ApiError => e
|
|
2004
|
-
puts "Error when calling CompositionsApi->
|
|
2179
|
+
puts "Error when calling CompositionsApi->get_composition_versions: #{e}"
|
|
2005
2180
|
end
|
|
2006
2181
|
```
|
|
2007
2182
|
|
|
2008
|
-
#### Using the
|
|
2183
|
+
#### Using the get_composition_versions_with_http_info variant
|
|
2009
2184
|
|
|
2010
2185
|
This returns an Array which contains the response data, status code and headers.
|
|
2011
2186
|
|
|
2012
|
-
> <Array(<GetCompositionVersions200Response>, Integer, Hash)>
|
|
2187
|
+
> <Array(<GetCompositionVersions200Response>, Integer, Hash)> get_composition_versions_with_http_info(id, opts)
|
|
2013
2188
|
|
|
2014
2189
|
```ruby
|
|
2015
2190
|
begin
|
|
2016
2191
|
# Get Composition Versions
|
|
2017
|
-
data, status_code, headers = api_instance.
|
|
2192
|
+
data, status_code, headers = api_instance.get_composition_versions_with_http_info(id, opts)
|
|
2018
2193
|
p status_code # => 2xx
|
|
2019
2194
|
p headers # => { ... }
|
|
2020
2195
|
p data # => <GetCompositionVersions200Response>
|
|
2021
2196
|
rescue ApiSdkRb::ApiError => e
|
|
2022
|
-
puts "Error when calling CompositionsApi->
|
|
2197
|
+
puts "Error when calling CompositionsApi->get_composition_versions_with_http_info: #{e}"
|
|
2023
2198
|
end
|
|
2024
2199
|
```
|
|
2025
2200
|
|
|
@@ -2045,9 +2220,9 @@ end
|
|
|
2045
2220
|
- **Accept**: application/json
|
|
2046
2221
|
|
|
2047
2222
|
|
|
2048
|
-
##
|
|
2223
|
+
## get_compositions_batch
|
|
2049
2224
|
|
|
2050
|
-
> <GetCompositionsBatchResponse>
|
|
2225
|
+
> <GetCompositionsBatchResponse> get_compositions_batch(get_compositions_batch_request)
|
|
2051
2226
|
|
|
2052
2227
|
Get Compositions Batch
|
|
2053
2228
|
|
|
@@ -2069,28 +2244,28 @@ get_compositions_batch_request = ApiSdkRb::GetCompositionsBatchRequest.new({comp
|
|
|
2069
2244
|
|
|
2070
2245
|
begin
|
|
2071
2246
|
# Get Compositions Batch
|
|
2072
|
-
result = api_instance.
|
|
2247
|
+
result = api_instance.get_compositions_batch(get_compositions_batch_request)
|
|
2073
2248
|
p result
|
|
2074
2249
|
rescue ApiSdkRb::ApiError => e
|
|
2075
|
-
puts "Error when calling CompositionsApi->
|
|
2250
|
+
puts "Error when calling CompositionsApi->get_compositions_batch: #{e}"
|
|
2076
2251
|
end
|
|
2077
2252
|
```
|
|
2078
2253
|
|
|
2079
|
-
#### Using the
|
|
2254
|
+
#### Using the get_compositions_batch_with_http_info variant
|
|
2080
2255
|
|
|
2081
2256
|
This returns an Array which contains the response data, status code and headers.
|
|
2082
2257
|
|
|
2083
|
-
> <Array(<GetCompositionsBatchResponse>, Integer, Hash)>
|
|
2258
|
+
> <Array(<GetCompositionsBatchResponse>, Integer, Hash)> get_compositions_batch_with_http_info(get_compositions_batch_request)
|
|
2084
2259
|
|
|
2085
2260
|
```ruby
|
|
2086
2261
|
begin
|
|
2087
2262
|
# Get Compositions Batch
|
|
2088
|
-
data, status_code, headers = api_instance.
|
|
2263
|
+
data, status_code, headers = api_instance.get_compositions_batch_with_http_info(get_compositions_batch_request)
|
|
2089
2264
|
p status_code # => 2xx
|
|
2090
2265
|
p headers # => { ... }
|
|
2091
2266
|
p data # => <GetCompositionsBatchResponse>
|
|
2092
2267
|
rescue ApiSdkRb::ApiError => e
|
|
2093
|
-
puts "Error when calling CompositionsApi->
|
|
2268
|
+
puts "Error when calling CompositionsApi->get_compositions_batch_with_http_info: #{e}"
|
|
2094
2269
|
end
|
|
2095
2270
|
```
|
|
2096
2271
|
|
|
@@ -2114,9 +2289,100 @@ end
|
|
|
2114
2289
|
- **Accept**: application/json
|
|
2115
2290
|
|
|
2116
2291
|
|
|
2117
|
-
##
|
|
2292
|
+
## list_composition_entry_items
|
|
2293
|
+
|
|
2294
|
+
> <CompositionEntryItemsPageSuccess> list_composition_entry_items(id, table, opts)
|
|
2295
|
+
|
|
2296
|
+
List composition entry items with paging and filters
|
|
2297
|
+
|
|
2298
|
+
Reads one widget table with cursor paging (time then id in byte order), optional since/until on the time column, and up to five context filters plus ten column filters. Rate limit 120 requests per minute. Each read batch uses a 5 s statement timeout.
|
|
2299
|
+
|
|
2300
|
+
### Examples
|
|
2301
|
+
|
|
2302
|
+
```ruby
|
|
2303
|
+
require 'time'
|
|
2304
|
+
require 'api-sdk-rb'
|
|
2305
|
+
# setup authorization
|
|
2306
|
+
ApiSdkRb.configure do |config|
|
|
2307
|
+
# Configure Bearer authorization (JWT): apiKeyAuth
|
|
2308
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
2309
|
+
end
|
|
2310
|
+
|
|
2311
|
+
api_instance = ApiSdkRb::CompositionsApi.new
|
|
2312
|
+
id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String |
|
|
2313
|
+
table = 'table_example' # String |
|
|
2314
|
+
opts = {
|
|
2315
|
+
limit: 56, # Integer |
|
|
2316
|
+
order: 'asc', # String | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id.
|
|
2317
|
+
since: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`.
|
|
2318
|
+
_until: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`).
|
|
2319
|
+
cursor: 'cursor_example', # String |
|
|
2320
|
+
context: { key: { key: 'inner_example'}}, # Hash<String, String> | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters.
|
|
2321
|
+
filter: { key: { key: 'inner_example'}}, # Hash<String, String> | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`.
|
|
2322
|
+
x_managed_user_id: '3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90', # String | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2323
|
+
x_managed_user_external_id: 'customer-1042' # String | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user.
|
|
2324
|
+
}
|
|
2325
|
+
|
|
2326
|
+
begin
|
|
2327
|
+
# List composition entry items with paging and filters
|
|
2328
|
+
result = api_instance.list_composition_entry_items(id, table, opts)
|
|
2329
|
+
p result
|
|
2330
|
+
rescue ApiSdkRb::ApiError => e
|
|
2331
|
+
puts "Error when calling CompositionsApi->list_composition_entry_items: #{e}"
|
|
2332
|
+
end
|
|
2333
|
+
```
|
|
2334
|
+
|
|
2335
|
+
#### Using the list_composition_entry_items_with_http_info variant
|
|
2336
|
+
|
|
2337
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2338
|
+
|
|
2339
|
+
> <Array(<CompositionEntryItemsPageSuccess>, Integer, Hash)> list_composition_entry_items_with_http_info(id, table, opts)
|
|
2340
|
+
|
|
2341
|
+
```ruby
|
|
2342
|
+
begin
|
|
2343
|
+
# List composition entry items with paging and filters
|
|
2344
|
+
data, status_code, headers = api_instance.list_composition_entry_items_with_http_info(id, table, opts)
|
|
2345
|
+
p status_code # => 2xx
|
|
2346
|
+
p headers # => { ... }
|
|
2347
|
+
p data # => <CompositionEntryItemsPageSuccess>
|
|
2348
|
+
rescue ApiSdkRb::ApiError => e
|
|
2349
|
+
puts "Error when calling CompositionsApi->list_composition_entry_items_with_http_info: #{e}"
|
|
2350
|
+
end
|
|
2351
|
+
```
|
|
2352
|
+
|
|
2353
|
+
### Parameters
|
|
2354
|
+
|
|
2355
|
+
| Name | Type | Description | Notes |
|
|
2356
|
+
| ---- | ---- | ----------- | ----- |
|
|
2357
|
+
| **id** | **String** | | |
|
|
2358
|
+
| **table** | **String** | | |
|
|
2359
|
+
| **limit** | **Integer** | | [optional][default to 25] |
|
|
2360
|
+
| **order** | **String** | `desc` (the default) lists the newest entry first, `asc` the oldest. Entries are sorted by their time, then by their id (compared as text, byte by byte) in the same direction, so the order of two entries made at the same instant is always the same; an entry with no time counts as the oldest. A table with no time column is sorted by its id. The managed-user feed sorts by time, then by composition id, table and id. | [optional][default to 'desc'] |
|
|
2361
|
+
| **since** | **Time** | Only entries made at this time or later: `since` is INCLUSIVE (an entry made at exactly `since` is returned). A date and time with an offset, such as `2026-10-01T00:00:00Z`; anything else answers 400 `INVALID_SINCE`. An entry with no time never matches, and a table with no time column answers 400 `ENTRY_TABLE_HAS_NO_TIME`. | [optional] |
|
|
2362
|
+
| **_until** | **Time** | Only entries made before this time: `until` is EXCLUSIVE (an entry made at exactly `until` is NOT returned), so `since=A&until=B` followed by `since=B&until=C` counts every entry once. Same form and same refusals as `since` (400 `INVALID_UNTIL`). | [optional] |
|
|
2363
|
+
| **cursor** | **String** | | [optional] |
|
|
2364
|
+
| **context** | [**Hash<String, String>**](String.md) | Host context filters as `context[key]=value` (max 5 keys, counting dotted `context.key` too). Use `column.<name>=value` for columns whose names collide with reserved parameters. | [optional] |
|
|
2365
|
+
| **filter** | [**Hash<String, String>**](String.md) | Column filters as `filter[columnName]=value` (same meaning as bare `columnName=value` or `column.columnName=value`; max 10 column filters counting all spellings). A plain `filter=value` still filters a column named `filter`. | [optional] |
|
|
2366
|
+
| **x_managed_user_id** | **String** | The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2367
|
+
| **x_managed_user_external_id** | **String** | Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. | [optional] |
|
|
2368
|
+
|
|
2369
|
+
### Return type
|
|
2370
|
+
|
|
2371
|
+
[**CompositionEntryItemsPageSuccess**](CompositionEntryItemsPageSuccess.md)
|
|
2372
|
+
|
|
2373
|
+
### Authorization
|
|
2374
|
+
|
|
2375
|
+
[apiKeyAuth](../README.md#apiKeyAuth)
|
|
2376
|
+
|
|
2377
|
+
### HTTP request headers
|
|
2378
|
+
|
|
2379
|
+
- **Content-Type**: Not defined
|
|
2380
|
+
- **Accept**: application/json
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
## patch_composition_content_item
|
|
2118
2384
|
|
|
2119
|
-
> <
|
|
2385
|
+
> <ContentItemWriteResultResponse> patch_composition_content_item(id, list, item_id, idempotency_key, request_body, opts)
|
|
2120
2386
|
|
|
2121
2387
|
Update a content list item
|
|
2122
2388
|
|
|
@@ -2145,28 +2411,28 @@ opts = {
|
|
|
2145
2411
|
|
|
2146
2412
|
begin
|
|
2147
2413
|
# Update a content list item
|
|
2148
|
-
result = api_instance.
|
|
2414
|
+
result = api_instance.patch_composition_content_item(id, list, item_id, idempotency_key, request_body, opts)
|
|
2149
2415
|
p result
|
|
2150
2416
|
rescue ApiSdkRb::ApiError => e
|
|
2151
|
-
puts "Error when calling CompositionsApi->
|
|
2417
|
+
puts "Error when calling CompositionsApi->patch_composition_content_item: #{e}"
|
|
2152
2418
|
end
|
|
2153
2419
|
```
|
|
2154
2420
|
|
|
2155
|
-
#### Using the
|
|
2421
|
+
#### Using the patch_composition_content_item_with_http_info variant
|
|
2156
2422
|
|
|
2157
2423
|
This returns an Array which contains the response data, status code and headers.
|
|
2158
2424
|
|
|
2159
|
-
> <Array(<
|
|
2425
|
+
> <Array(<ContentItemWriteResultResponse>, Integer, Hash)> patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts)
|
|
2160
2426
|
|
|
2161
2427
|
```ruby
|
|
2162
2428
|
begin
|
|
2163
2429
|
# Update a content list item
|
|
2164
|
-
data, status_code, headers = api_instance.
|
|
2430
|
+
data, status_code, headers = api_instance.patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts)
|
|
2165
2431
|
p status_code # => 2xx
|
|
2166
2432
|
p headers # => { ... }
|
|
2167
|
-
p data # => <
|
|
2433
|
+
p data # => <ContentItemWriteResultResponse>
|
|
2168
2434
|
rescue ApiSdkRb::ApiError => e
|
|
2169
|
-
puts "Error when calling CompositionsApi->
|
|
2435
|
+
puts "Error when calling CompositionsApi->patch_composition_content_item_with_http_info: #{e}"
|
|
2170
2436
|
end
|
|
2171
2437
|
```
|
|
2172
2438
|
|
|
@@ -2185,7 +2451,7 @@ end
|
|
|
2185
2451
|
|
|
2186
2452
|
### Return type
|
|
2187
2453
|
|
|
2188
|
-
[**
|
|
2454
|
+
[**ContentItemWriteResultResponse**](ContentItemWriteResultResponse.md)
|
|
2189
2455
|
|
|
2190
2456
|
### Authorization
|
|
2191
2457
|
|
|
@@ -2197,9 +2463,9 @@ end
|
|
|
2197
2463
|
- **Accept**: application/json
|
|
2198
2464
|
|
|
2199
2465
|
|
|
2200
|
-
##
|
|
2466
|
+
## read_composition_entries
|
|
2201
2467
|
|
|
2202
|
-
> <CompositionEntriesReadingResponse>
|
|
2468
|
+
> <CompositionEntriesReadingResponse> read_composition_entries(id, table, opts)
|
|
2203
2469
|
|
|
2204
2470
|
Read the Entries of a Composition's Table
|
|
2205
2471
|
|
|
@@ -2234,28 +2500,28 @@ opts = {
|
|
|
2234
2500
|
|
|
2235
2501
|
begin
|
|
2236
2502
|
# Read the Entries of a Composition's Table
|
|
2237
|
-
result = api_instance.
|
|
2503
|
+
result = api_instance.read_composition_entries(id, table, opts)
|
|
2238
2504
|
p result
|
|
2239
2505
|
rescue ApiSdkRb::ApiError => e
|
|
2240
|
-
puts "Error when calling CompositionsApi->
|
|
2506
|
+
puts "Error when calling CompositionsApi->read_composition_entries: #{e}"
|
|
2241
2507
|
end
|
|
2242
2508
|
```
|
|
2243
2509
|
|
|
2244
|
-
#### Using the
|
|
2510
|
+
#### Using the read_composition_entries_with_http_info variant
|
|
2245
2511
|
|
|
2246
2512
|
This returns an Array which contains the response data, status code and headers.
|
|
2247
2513
|
|
|
2248
|
-
> <Array(<CompositionEntriesReadingResponse>, Integer, Hash)>
|
|
2514
|
+
> <Array(<CompositionEntriesReadingResponse>, Integer, Hash)> read_composition_entries_with_http_info(id, table, opts)
|
|
2249
2515
|
|
|
2250
2516
|
```ruby
|
|
2251
2517
|
begin
|
|
2252
2518
|
# Read the Entries of a Composition's Table
|
|
2253
|
-
data, status_code, headers = api_instance.
|
|
2519
|
+
data, status_code, headers = api_instance.read_composition_entries_with_http_info(id, table, opts)
|
|
2254
2520
|
p status_code # => 2xx
|
|
2255
2521
|
p headers # => { ... }
|
|
2256
2522
|
p data # => <CompositionEntriesReadingResponse>
|
|
2257
2523
|
rescue ApiSdkRb::ApiError => e
|
|
2258
|
-
puts "Error when calling CompositionsApi->
|
|
2524
|
+
puts "Error when calling CompositionsApi->read_composition_entries_with_http_info: #{e}"
|
|
2259
2525
|
end
|
|
2260
2526
|
```
|
|
2261
2527
|
|
|
@@ -2290,9 +2556,9 @@ end
|
|
|
2290
2556
|
- **Accept**: application/json
|
|
2291
2557
|
|
|
2292
2558
|
|
|
2293
|
-
##
|
|
2559
|
+
## remove_ai_answers_knowledge_document
|
|
2294
2560
|
|
|
2295
|
-
> <RemoveAiAnswersKnowledgeDocument200Response>
|
|
2561
|
+
> <RemoveAiAnswersKnowledgeDocument200Response> remove_ai_answers_knowledge_document(id, document_id, opts)
|
|
2296
2562
|
|
|
2297
2563
|
Remove a document from a widget's knowledge base
|
|
2298
2564
|
|
|
@@ -2319,28 +2585,28 @@ opts = {
|
|
|
2319
2585
|
|
|
2320
2586
|
begin
|
|
2321
2587
|
# Remove a document from a widget's knowledge base
|
|
2322
|
-
result = api_instance.
|
|
2588
|
+
result = api_instance.remove_ai_answers_knowledge_document(id, document_id, opts)
|
|
2323
2589
|
p result
|
|
2324
2590
|
rescue ApiSdkRb::ApiError => e
|
|
2325
|
-
puts "Error when calling CompositionsApi->
|
|
2591
|
+
puts "Error when calling CompositionsApi->remove_ai_answers_knowledge_document: #{e}"
|
|
2326
2592
|
end
|
|
2327
2593
|
```
|
|
2328
2594
|
|
|
2329
|
-
#### Using the
|
|
2595
|
+
#### Using the remove_ai_answers_knowledge_document_with_http_info variant
|
|
2330
2596
|
|
|
2331
2597
|
This returns an Array which contains the response data, status code and headers.
|
|
2332
2598
|
|
|
2333
|
-
> <Array(<RemoveAiAnswersKnowledgeDocument200Response>, Integer, Hash)>
|
|
2599
|
+
> <Array(<RemoveAiAnswersKnowledgeDocument200Response>, Integer, Hash)> remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts)
|
|
2334
2600
|
|
|
2335
2601
|
```ruby
|
|
2336
2602
|
begin
|
|
2337
2603
|
# Remove a document from a widget's knowledge base
|
|
2338
|
-
data, status_code, headers = api_instance.
|
|
2604
|
+
data, status_code, headers = api_instance.remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts)
|
|
2339
2605
|
p status_code # => 2xx
|
|
2340
2606
|
p headers # => { ... }
|
|
2341
2607
|
p data # => <RemoveAiAnswersKnowledgeDocument200Response>
|
|
2342
2608
|
rescue ApiSdkRb::ApiError => e
|
|
2343
|
-
puts "Error when calling CompositionsApi->
|
|
2609
|
+
puts "Error when calling CompositionsApi->remove_ai_answers_knowledge_document_with_http_info: #{e}"
|
|
2344
2610
|
end
|
|
2345
2611
|
```
|
|
2346
2612
|
|
|
@@ -2367,9 +2633,9 @@ end
|
|
|
2367
2633
|
- **Accept**: application/json
|
|
2368
2634
|
|
|
2369
2635
|
|
|
2370
|
-
##
|
|
2636
|
+
## set_composition_data_source
|
|
2371
2637
|
|
|
2372
|
-
> <CompositionDataSourceResponse>
|
|
2638
|
+
> <CompositionDataSourceResponse> set_composition_data_source(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2373
2639
|
|
|
2374
2640
|
Bind a public JSON data source for embed refresh
|
|
2375
2641
|
|
|
@@ -2397,28 +2663,28 @@ opts = {
|
|
|
2397
2663
|
|
|
2398
2664
|
begin
|
|
2399
2665
|
# Bind a public JSON data source for embed refresh
|
|
2400
|
-
result = api_instance.
|
|
2666
|
+
result = api_instance.set_composition_data_source(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2401
2667
|
p result
|
|
2402
2668
|
rescue ApiSdkRb::ApiError => e
|
|
2403
|
-
puts "Error when calling CompositionsApi->
|
|
2669
|
+
puts "Error when calling CompositionsApi->set_composition_data_source: #{e}"
|
|
2404
2670
|
end
|
|
2405
2671
|
```
|
|
2406
2672
|
|
|
2407
|
-
#### Using the
|
|
2673
|
+
#### Using the set_composition_data_source_with_http_info variant
|
|
2408
2674
|
|
|
2409
2675
|
This returns an Array which contains the response data, status code and headers.
|
|
2410
2676
|
|
|
2411
|
-
> <Array(<CompositionDataSourceResponse>, Integer, Hash)>
|
|
2677
|
+
> <Array(<CompositionDataSourceResponse>, Integer, Hash)> set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2412
2678
|
|
|
2413
2679
|
```ruby
|
|
2414
2680
|
begin
|
|
2415
2681
|
# Bind a public JSON data source for embed refresh
|
|
2416
|
-
data, status_code, headers = api_instance.
|
|
2682
|
+
data, status_code, headers = api_instance.set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2417
2683
|
p status_code # => 2xx
|
|
2418
2684
|
p headers # => { ... }
|
|
2419
2685
|
p data # => <CompositionDataSourceResponse>
|
|
2420
2686
|
rescue ApiSdkRb::ApiError => e
|
|
2421
|
-
puts "Error when calling CompositionsApi->
|
|
2687
|
+
puts "Error when calling CompositionsApi->set_composition_data_source_with_http_info: #{e}"
|
|
2422
2688
|
end
|
|
2423
2689
|
```
|
|
2424
2690
|
|
|
@@ -2446,9 +2712,9 @@ end
|
|
|
2446
2712
|
- **Accept**: application/json
|
|
2447
2713
|
|
|
2448
2714
|
|
|
2449
|
-
##
|
|
2715
|
+
## set_dynamic_content
|
|
2450
2716
|
|
|
2451
|
-
> <SetDynamicContentResponse>
|
|
2717
|
+
> <SetDynamicContentResponse> set_dynamic_content(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2452
2718
|
|
|
2453
2719
|
Set Dynamic Content
|
|
2454
2720
|
|
|
@@ -2477,28 +2743,28 @@ opts = {
|
|
|
2477
2743
|
|
|
2478
2744
|
begin
|
|
2479
2745
|
# Set Dynamic Content
|
|
2480
|
-
result = api_instance.
|
|
2746
|
+
result = api_instance.set_dynamic_content(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2481
2747
|
p result
|
|
2482
2748
|
rescue ApiSdkRb::ApiError => e
|
|
2483
|
-
puts "Error when calling CompositionsApi->
|
|
2749
|
+
puts "Error when calling CompositionsApi->set_dynamic_content: #{e}"
|
|
2484
2750
|
end
|
|
2485
2751
|
```
|
|
2486
2752
|
|
|
2487
|
-
#### Using the
|
|
2753
|
+
#### Using the set_dynamic_content_with_http_info variant
|
|
2488
2754
|
|
|
2489
2755
|
This returns an Array which contains the response data, status code and headers.
|
|
2490
2756
|
|
|
2491
|
-
> <Array(<SetDynamicContentResponse>, Integer, Hash)>
|
|
2757
|
+
> <Array(<SetDynamicContentResponse>, Integer, Hash)> set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2492
2758
|
|
|
2493
2759
|
```ruby
|
|
2494
2760
|
begin
|
|
2495
2761
|
# Set Dynamic Content
|
|
2496
|
-
data, status_code, headers = api_instance.
|
|
2762
|
+
data, status_code, headers = api_instance.set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2497
2763
|
p status_code # => 2xx
|
|
2498
2764
|
p headers # => { ... }
|
|
2499
2765
|
p data # => <SetDynamicContentResponse>
|
|
2500
2766
|
rescue ApiSdkRb::ApiError => e
|
|
2501
|
-
puts "Error when calling CompositionsApi->
|
|
2767
|
+
puts "Error when calling CompositionsApi->set_dynamic_content_with_http_info: #{e}"
|
|
2502
2768
|
end
|
|
2503
2769
|
```
|
|
2504
2770
|
|
|
@@ -2527,9 +2793,9 @@ end
|
|
|
2527
2793
|
- **Accept**: application/json
|
|
2528
2794
|
|
|
2529
2795
|
|
|
2530
|
-
##
|
|
2796
|
+
## update_composition
|
|
2531
2797
|
|
|
2532
|
-
> <
|
|
2798
|
+
> <CompositionResponse> update_composition(id, idempotency_key, update_composition, opts)
|
|
2533
2799
|
|
|
2534
2800
|
Update Composition
|
|
2535
2801
|
|
|
@@ -2558,28 +2824,28 @@ opts = {
|
|
|
2558
2824
|
|
|
2559
2825
|
begin
|
|
2560
2826
|
# Update Composition
|
|
2561
|
-
result = api_instance.
|
|
2827
|
+
result = api_instance.update_composition(id, idempotency_key, update_composition, opts)
|
|
2562
2828
|
p result
|
|
2563
2829
|
rescue ApiSdkRb::ApiError => e
|
|
2564
|
-
puts "Error when calling CompositionsApi->
|
|
2830
|
+
puts "Error when calling CompositionsApi->update_composition: #{e}"
|
|
2565
2831
|
end
|
|
2566
2832
|
```
|
|
2567
2833
|
|
|
2568
|
-
#### Using the
|
|
2834
|
+
#### Using the update_composition_with_http_info variant
|
|
2569
2835
|
|
|
2570
2836
|
This returns an Array which contains the response data, status code and headers.
|
|
2571
2837
|
|
|
2572
|
-
> <Array(<
|
|
2838
|
+
> <Array(<CompositionResponse>, Integer, Hash)> update_composition_with_http_info(id, idempotency_key, update_composition, opts)
|
|
2573
2839
|
|
|
2574
2840
|
```ruby
|
|
2575
2841
|
begin
|
|
2576
2842
|
# Update Composition
|
|
2577
|
-
data, status_code, headers = api_instance.
|
|
2843
|
+
data, status_code, headers = api_instance.update_composition_with_http_info(id, idempotency_key, update_composition, opts)
|
|
2578
2844
|
p status_code # => 2xx
|
|
2579
2845
|
p headers # => { ... }
|
|
2580
|
-
p data # => <
|
|
2846
|
+
p data # => <CompositionResponse>
|
|
2581
2847
|
rescue ApiSdkRb::ApiError => e
|
|
2582
|
-
puts "Error when calling CompositionsApi->
|
|
2848
|
+
puts "Error when calling CompositionsApi->update_composition_with_http_info: #{e}"
|
|
2583
2849
|
end
|
|
2584
2850
|
```
|
|
2585
2851
|
|
|
@@ -2596,7 +2862,7 @@ end
|
|
|
2596
2862
|
|
|
2597
2863
|
### Return type
|
|
2598
2864
|
|
|
2599
|
-
[**
|
|
2865
|
+
[**CompositionResponse**](CompositionResponse.md)
|
|
2600
2866
|
|
|
2601
2867
|
### Authorization
|
|
2602
2868
|
|
|
@@ -2608,9 +2874,9 @@ end
|
|
|
2608
2874
|
- **Accept**: application/json
|
|
2609
2875
|
|
|
2610
2876
|
|
|
2611
|
-
##
|
|
2877
|
+
## update_composition_database_record
|
|
2612
2878
|
|
|
2613
|
-
> <
|
|
2879
|
+
> <CompositionDatabaseRecordResponse> update_composition_database_record(id, table, record_id, idempotency_key, body, opts)
|
|
2614
2880
|
|
|
2615
2881
|
Update Record In Composition Database
|
|
2616
2882
|
|
|
@@ -2640,28 +2906,28 @@ opts = {
|
|
|
2640
2906
|
|
|
2641
2907
|
begin
|
|
2642
2908
|
# Update Record In Composition Database
|
|
2643
|
-
result = api_instance.
|
|
2909
|
+
result = api_instance.update_composition_database_record(id, table, record_id, idempotency_key, body, opts)
|
|
2644
2910
|
p result
|
|
2645
2911
|
rescue ApiSdkRb::ApiError => e
|
|
2646
|
-
puts "Error when calling CompositionsApi->
|
|
2912
|
+
puts "Error when calling CompositionsApi->update_composition_database_record: #{e}"
|
|
2647
2913
|
end
|
|
2648
2914
|
```
|
|
2649
2915
|
|
|
2650
|
-
#### Using the
|
|
2916
|
+
#### Using the update_composition_database_record_with_http_info variant
|
|
2651
2917
|
|
|
2652
2918
|
This returns an Array which contains the response data, status code and headers.
|
|
2653
2919
|
|
|
2654
|
-
> <Array(<
|
|
2920
|
+
> <Array(<CompositionDatabaseRecordResponse>, Integer, Hash)> update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts)
|
|
2655
2921
|
|
|
2656
2922
|
```ruby
|
|
2657
2923
|
begin
|
|
2658
2924
|
# Update Record In Composition Database
|
|
2659
|
-
data, status_code, headers = api_instance.
|
|
2925
|
+
data, status_code, headers = api_instance.update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts)
|
|
2660
2926
|
p status_code # => 2xx
|
|
2661
2927
|
p headers # => { ... }
|
|
2662
|
-
p data # => <
|
|
2928
|
+
p data # => <CompositionDatabaseRecordResponse>
|
|
2663
2929
|
rescue ApiSdkRb::ApiError => e
|
|
2664
|
-
puts "Error when calling CompositionsApi->
|
|
2930
|
+
puts "Error when calling CompositionsApi->update_composition_database_record_with_http_info: #{e}"
|
|
2665
2931
|
end
|
|
2666
2932
|
```
|
|
2667
2933
|
|
|
@@ -2679,7 +2945,7 @@ end
|
|
|
2679
2945
|
|
|
2680
2946
|
### Return type
|
|
2681
2947
|
|
|
2682
|
-
[**
|
|
2948
|
+
[**CompositionDatabaseRecordResponse**](CompositionDatabaseRecordResponse.md)
|
|
2683
2949
|
|
|
2684
2950
|
### Authorization
|
|
2685
2951
|
|
|
@@ -2691,9 +2957,9 @@ end
|
|
|
2691
2957
|
- **Accept**: application/json
|
|
2692
2958
|
|
|
2693
2959
|
|
|
2694
|
-
##
|
|
2960
|
+
## update_composition_status
|
|
2695
2961
|
|
|
2696
|
-
> <CompositionResponse>
|
|
2962
|
+
> <CompositionResponse> update_composition_status(id, idempotency_key, update_composition_status_request, opts)
|
|
2697
2963
|
|
|
2698
2964
|
Update Composition Status
|
|
2699
2965
|
|
|
@@ -2721,28 +2987,28 @@ opts = {
|
|
|
2721
2987
|
|
|
2722
2988
|
begin
|
|
2723
2989
|
# Update Composition Status
|
|
2724
|
-
result = api_instance.
|
|
2990
|
+
result = api_instance.update_composition_status(id, idempotency_key, update_composition_status_request, opts)
|
|
2725
2991
|
p result
|
|
2726
2992
|
rescue ApiSdkRb::ApiError => e
|
|
2727
|
-
puts "Error when calling CompositionsApi->
|
|
2993
|
+
puts "Error when calling CompositionsApi->update_composition_status: #{e}"
|
|
2728
2994
|
end
|
|
2729
2995
|
```
|
|
2730
2996
|
|
|
2731
|
-
#### Using the
|
|
2997
|
+
#### Using the update_composition_status_with_http_info variant
|
|
2732
2998
|
|
|
2733
2999
|
This returns an Array which contains the response data, status code and headers.
|
|
2734
3000
|
|
|
2735
|
-
> <Array(<CompositionResponse>, Integer, Hash)>
|
|
3001
|
+
> <Array(<CompositionResponse>, Integer, Hash)> update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts)
|
|
2736
3002
|
|
|
2737
3003
|
```ruby
|
|
2738
3004
|
begin
|
|
2739
3005
|
# Update Composition Status
|
|
2740
|
-
data, status_code, headers = api_instance.
|
|
3006
|
+
data, status_code, headers = api_instance.update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts)
|
|
2741
3007
|
p status_code # => 2xx
|
|
2742
3008
|
p headers # => { ... }
|
|
2743
3009
|
p data # => <CompositionResponse>
|
|
2744
3010
|
rescue ApiSdkRb::ApiError => e
|
|
2745
|
-
puts "Error when calling CompositionsApi->
|
|
3011
|
+
puts "Error when calling CompositionsApi->update_composition_status_with_http_info: #{e}"
|
|
2746
3012
|
end
|
|
2747
3013
|
```
|
|
2748
3014
|
|
|
@@ -2770,9 +3036,9 @@ end
|
|
|
2770
3036
|
- **Accept**: application/json
|
|
2771
3037
|
|
|
2772
3038
|
|
|
2773
|
-
##
|
|
3039
|
+
## validate_composition_content
|
|
2774
3040
|
|
|
2775
|
-
> <ValidateCompositionContentResponse>
|
|
3041
|
+
> <ValidateCompositionContentResponse> validate_composition_content(id, idempotency_key, request_body, opts)
|
|
2776
3042
|
|
|
2777
3043
|
Validate Content
|
|
2778
3044
|
|
|
@@ -2800,28 +3066,28 @@ opts = {
|
|
|
2800
3066
|
|
|
2801
3067
|
begin
|
|
2802
3068
|
# Validate Content
|
|
2803
|
-
result = api_instance.
|
|
3069
|
+
result = api_instance.validate_composition_content(id, idempotency_key, request_body, opts)
|
|
2804
3070
|
p result
|
|
2805
3071
|
rescue ApiSdkRb::ApiError => e
|
|
2806
|
-
puts "Error when calling CompositionsApi->
|
|
3072
|
+
puts "Error when calling CompositionsApi->validate_composition_content: #{e}"
|
|
2807
3073
|
end
|
|
2808
3074
|
```
|
|
2809
3075
|
|
|
2810
|
-
#### Using the
|
|
3076
|
+
#### Using the validate_composition_content_with_http_info variant
|
|
2811
3077
|
|
|
2812
3078
|
This returns an Array which contains the response data, status code and headers.
|
|
2813
3079
|
|
|
2814
|
-
> <Array(<ValidateCompositionContentResponse>, Integer, Hash)>
|
|
3080
|
+
> <Array(<ValidateCompositionContentResponse>, Integer, Hash)> validate_composition_content_with_http_info(id, idempotency_key, request_body, opts)
|
|
2815
3081
|
|
|
2816
3082
|
```ruby
|
|
2817
3083
|
begin
|
|
2818
3084
|
# Validate Content
|
|
2819
|
-
data, status_code, headers = api_instance.
|
|
3085
|
+
data, status_code, headers = api_instance.validate_composition_content_with_http_info(id, idempotency_key, request_body, opts)
|
|
2820
3086
|
p status_code # => 2xx
|
|
2821
3087
|
p headers # => { ... }
|
|
2822
3088
|
p data # => <ValidateCompositionContentResponse>
|
|
2823
3089
|
rescue ApiSdkRb::ApiError => e
|
|
2824
|
-
puts "Error when calling CompositionsApi->
|
|
3090
|
+
puts "Error when calling CompositionsApi->validate_composition_content_with_http_info: #{e}"
|
|
2825
3091
|
end
|
|
2826
3092
|
```
|
|
2827
3093
|
|