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
|
@@ -26,9 +26,9 @@ module ApiSdkRb
|
|
|
26
26
|
# @param [Hash] opts the optional parameters
|
|
27
27
|
# @option opts [String] :x_managed_user_id 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.
|
|
28
28
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
29
|
-
# @return [
|
|
30
|
-
def
|
|
31
|
-
data, _status_code, _headers =
|
|
29
|
+
# @return [AiAnswersKnowledgeDocumentResponse]
|
|
30
|
+
def add_ai_answers_knowledge_document(id, add_ai_answers_knowledge_document_request, opts = {})
|
|
31
|
+
data, _status_code, _headers = add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts)
|
|
32
32
|
data
|
|
33
33
|
end
|
|
34
34
|
|
|
@@ -39,25 +39,25 @@ module ApiSdkRb
|
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @option opts [String] :x_managed_user_id 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.
|
|
41
41
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
42
|
-
# @return [Array<(
|
|
43
|
-
def
|
|
42
|
+
# @return [Array<(AiAnswersKnowledgeDocumentResponse, Integer, Hash)>] AiAnswersKnowledgeDocumentResponse data, response status code and response headers
|
|
43
|
+
def add_ai_answers_knowledge_document_with_http_info(id, add_ai_answers_knowledge_document_request, opts = {})
|
|
44
44
|
if @api_client.config.debugging
|
|
45
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
45
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.add_ai_answers_knowledge_document ...'
|
|
46
46
|
end
|
|
47
47
|
# verify the required parameter 'id' is set
|
|
48
48
|
if @api_client.config.client_side_validation && id.nil?
|
|
49
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.add_ai_answers_knowledge_document"
|
|
50
50
|
end
|
|
51
51
|
# verify the required parameter 'add_ai_answers_knowledge_document_request' is set
|
|
52
52
|
if @api_client.config.client_side_validation && add_ai_answers_knowledge_document_request.nil?
|
|
53
|
-
fail ArgumentError, "Missing the required parameter 'add_ai_answers_knowledge_document_request' when calling CompositionsApi.
|
|
53
|
+
fail ArgumentError, "Missing the required parameter 'add_ai_answers_knowledge_document_request' when calling CompositionsApi.add_ai_answers_knowledge_document"
|
|
54
54
|
end
|
|
55
55
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
56
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
56
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_document, the character length must be smaller than or equal to 255.'
|
|
57
57
|
end
|
|
58
58
|
|
|
59
59
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
60
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
60
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_document, the character length must be great than or equal to 1.'
|
|
61
61
|
end
|
|
62
62
|
|
|
63
63
|
# resource path
|
|
@@ -85,13 +85,13 @@ module ApiSdkRb
|
|
|
85
85
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(add_ai_answers_knowledge_document_request)
|
|
86
86
|
|
|
87
87
|
# return_type
|
|
88
|
-
return_type = opts[:debug_return_type] || '
|
|
88
|
+
return_type = opts[:debug_return_type] || 'AiAnswersKnowledgeDocumentResponse'
|
|
89
89
|
|
|
90
90
|
# auth_names
|
|
91
91
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
92
92
|
|
|
93
93
|
new_options = opts.merge(
|
|
94
|
-
:operation => :"CompositionsApi.
|
|
94
|
+
:operation => :"CompositionsApi.add_ai_answers_knowledge_document",
|
|
95
95
|
:header_params => header_params,
|
|
96
96
|
:query_params => query_params,
|
|
97
97
|
:form_params => form_params,
|
|
@@ -102,7 +102,7 @@ module ApiSdkRb
|
|
|
102
102
|
|
|
103
103
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
104
104
|
if @api_client.config.debugging
|
|
105
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
105
|
+
@api_client.config.logger.debug "API called: CompositionsApi#add_ai_answers_knowledge_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
106
106
|
end
|
|
107
107
|
return data, status_code, headers
|
|
108
108
|
end
|
|
@@ -115,9 +115,9 @@ module ApiSdkRb
|
|
|
115
115
|
# @option opts [String] :x_managed_user_id 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.
|
|
116
116
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
117
117
|
# @option opts [String] :title What the document is called, on one line. Visitors see it as the source of an answer. Left out, the name of the file stands in for it
|
|
118
|
-
# @return [
|
|
119
|
-
def
|
|
120
|
-
data, _status_code, _headers =
|
|
118
|
+
# @return [AiAnswersKnowledgeDocumentResponse]
|
|
119
|
+
def add_ai_answers_knowledge_file(id, file, opts = {})
|
|
120
|
+
data, _status_code, _headers = add_ai_answers_knowledge_file_with_http_info(id, file, opts)
|
|
121
121
|
data
|
|
122
122
|
end
|
|
123
123
|
|
|
@@ -129,29 +129,29 @@ module ApiSdkRb
|
|
|
129
129
|
# @option opts [String] :x_managed_user_id 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.
|
|
130
130
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
131
131
|
# @option opts [String] :title What the document is called, on one line. Visitors see it as the source of an answer. Left out, the name of the file stands in for it
|
|
132
|
-
# @return [Array<(
|
|
133
|
-
def
|
|
132
|
+
# @return [Array<(AiAnswersKnowledgeDocumentResponse, Integer, Hash)>] AiAnswersKnowledgeDocumentResponse data, response status code and response headers
|
|
133
|
+
def add_ai_answers_knowledge_file_with_http_info(id, file, opts = {})
|
|
134
134
|
if @api_client.config.debugging
|
|
135
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
135
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.add_ai_answers_knowledge_file ...'
|
|
136
136
|
end
|
|
137
137
|
# verify the required parameter 'id' is set
|
|
138
138
|
if @api_client.config.client_side_validation && id.nil?
|
|
139
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
139
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.add_ai_answers_knowledge_file"
|
|
140
140
|
end
|
|
141
141
|
# verify the required parameter 'file' is set
|
|
142
142
|
if @api_client.config.client_side_validation && file.nil?
|
|
143
|
-
fail ArgumentError, "Missing the required parameter 'file' when calling CompositionsApi.
|
|
143
|
+
fail ArgumentError, "Missing the required parameter 'file' when calling CompositionsApi.add_ai_answers_knowledge_file"
|
|
144
144
|
end
|
|
145
145
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
146
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
146
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_file, the character length must be smaller than or equal to 255.'
|
|
147
147
|
end
|
|
148
148
|
|
|
149
149
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
150
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
150
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.add_ai_answers_knowledge_file, the character length must be great than or equal to 1.'
|
|
151
151
|
end
|
|
152
152
|
|
|
153
153
|
if @api_client.config.client_side_validation && !opts[:'title'].nil? && opts[:'title'].to_s.length > 120
|
|
154
|
-
fail ArgumentError, 'invalid value for "opts[:"title"]" when calling CompositionsApi.
|
|
154
|
+
fail ArgumentError, 'invalid value for "opts[:"title"]" when calling CompositionsApi.add_ai_answers_knowledge_file, the character length must be smaller than or equal to 120.'
|
|
155
155
|
end
|
|
156
156
|
|
|
157
157
|
# resource path
|
|
@@ -181,13 +181,13 @@ module ApiSdkRb
|
|
|
181
181
|
post_body = opts[:debug_body]
|
|
182
182
|
|
|
183
183
|
# return_type
|
|
184
|
-
return_type = opts[:debug_return_type] || '
|
|
184
|
+
return_type = opts[:debug_return_type] || 'AiAnswersKnowledgeDocumentResponse'
|
|
185
185
|
|
|
186
186
|
# auth_names
|
|
187
187
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
188
188
|
|
|
189
189
|
new_options = opts.merge(
|
|
190
|
-
:operation => :"CompositionsApi.
|
|
190
|
+
:operation => :"CompositionsApi.add_ai_answers_knowledge_file",
|
|
191
191
|
:header_params => header_params,
|
|
192
192
|
:query_params => query_params,
|
|
193
193
|
:form_params => form_params,
|
|
@@ -198,7 +198,7 @@ module ApiSdkRb
|
|
|
198
198
|
|
|
199
199
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
200
200
|
if @api_client.config.debugging
|
|
201
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
201
|
+
@api_client.config.logger.debug "API called: CompositionsApi#add_ai_answers_knowledge_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
202
202
|
end
|
|
203
203
|
return data, status_code, headers
|
|
204
204
|
end
|
|
@@ -208,8 +208,8 @@ module ApiSdkRb
|
|
|
208
208
|
# @param id [String] Composition ID
|
|
209
209
|
# @param [Hash] opts the optional parameters
|
|
210
210
|
# @return [CheckCompositionAccessResponse]
|
|
211
|
-
def
|
|
212
|
-
data, _status_code, _headers =
|
|
211
|
+
def check_composition_access(id, opts = {})
|
|
212
|
+
data, _status_code, _headers = check_composition_access_with_http_info(id, opts)
|
|
213
213
|
data
|
|
214
214
|
end
|
|
215
215
|
|
|
@@ -218,13 +218,13 @@ module ApiSdkRb
|
|
|
218
218
|
# @param id [String] Composition ID
|
|
219
219
|
# @param [Hash] opts the optional parameters
|
|
220
220
|
# @return [Array<(CheckCompositionAccessResponse, Integer, Hash)>] CheckCompositionAccessResponse data, response status code and response headers
|
|
221
|
-
def
|
|
221
|
+
def check_composition_access_with_http_info(id, opts = {})
|
|
222
222
|
if @api_client.config.debugging
|
|
223
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
223
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.check_composition_access ...'
|
|
224
224
|
end
|
|
225
225
|
# verify the required parameter 'id' is set
|
|
226
226
|
if @api_client.config.client_side_validation && id.nil?
|
|
227
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
227
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.check_composition_access"
|
|
228
228
|
end
|
|
229
229
|
# resource path
|
|
230
230
|
local_var_path = '/compositions/{id}/access'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
@@ -250,7 +250,7 @@ module ApiSdkRb
|
|
|
250
250
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
251
251
|
|
|
252
252
|
new_options = opts.merge(
|
|
253
|
-
:operation => :"CompositionsApi.
|
|
253
|
+
:operation => :"CompositionsApi.check_composition_access",
|
|
254
254
|
:header_params => header_params,
|
|
255
255
|
:query_params => query_params,
|
|
256
256
|
:form_params => form_params,
|
|
@@ -261,7 +261,7 @@ module ApiSdkRb
|
|
|
261
261
|
|
|
262
262
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
263
263
|
if @api_client.config.debugging
|
|
264
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
264
|
+
@api_client.config.logger.debug "API called: CompositionsApi#check_composition_access\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
265
265
|
end
|
|
266
266
|
return data, status_code, headers
|
|
267
267
|
end
|
|
@@ -273,9 +273,9 @@ module ApiSdkRb
|
|
|
273
273
|
# @param [Hash] opts the optional parameters
|
|
274
274
|
# @option opts [String] :x_managed_user_id 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.
|
|
275
275
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
276
|
-
# @return [
|
|
277
|
-
def
|
|
278
|
-
data, _status_code, _headers =
|
|
276
|
+
# @return [CompositionResponse]
|
|
277
|
+
def create_composition(idempotency_key, new_composition, opts = {})
|
|
278
|
+
data, _status_code, _headers = create_composition_with_http_info(idempotency_key, new_composition, opts)
|
|
279
279
|
data
|
|
280
280
|
end
|
|
281
281
|
|
|
@@ -286,38 +286,38 @@ module ApiSdkRb
|
|
|
286
286
|
# @param [Hash] opts the optional parameters
|
|
287
287
|
# @option opts [String] :x_managed_user_id 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.
|
|
288
288
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
289
|
-
# @return [Array<(
|
|
290
|
-
def
|
|
289
|
+
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
290
|
+
def create_composition_with_http_info(idempotency_key, new_composition, opts = {})
|
|
291
291
|
if @api_client.config.debugging
|
|
292
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
292
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.create_composition ...'
|
|
293
293
|
end
|
|
294
294
|
# verify the required parameter 'idempotency_key' is set
|
|
295
295
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
296
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
296
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.create_composition"
|
|
297
297
|
end
|
|
298
298
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
299
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
299
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition, the character length must be smaller than or equal to 50.'
|
|
300
300
|
end
|
|
301
301
|
|
|
302
302
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
303
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
303
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition, the character length must be great than or equal to 8.'
|
|
304
304
|
end
|
|
305
305
|
|
|
306
306
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
307
307
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
308
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
308
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.create_composition, must conform to the pattern #{pattern}."
|
|
309
309
|
end
|
|
310
310
|
|
|
311
311
|
# verify the required parameter 'new_composition' is set
|
|
312
312
|
if @api_client.config.client_side_validation && new_composition.nil?
|
|
313
|
-
fail ArgumentError, "Missing the required parameter 'new_composition' when calling CompositionsApi.
|
|
313
|
+
fail ArgumentError, "Missing the required parameter 'new_composition' when calling CompositionsApi.create_composition"
|
|
314
314
|
end
|
|
315
315
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
316
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
316
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition, the character length must be smaller than or equal to 255.'
|
|
317
317
|
end
|
|
318
318
|
|
|
319
319
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
320
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
320
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition, the character length must be great than or equal to 1.'
|
|
321
321
|
end
|
|
322
322
|
|
|
323
323
|
# resource path
|
|
@@ -346,13 +346,13 @@ module ApiSdkRb
|
|
|
346
346
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(new_composition)
|
|
347
347
|
|
|
348
348
|
# return_type
|
|
349
|
-
return_type = opts[:debug_return_type] || '
|
|
349
|
+
return_type = opts[:debug_return_type] || 'CompositionResponse'
|
|
350
350
|
|
|
351
351
|
# auth_names
|
|
352
352
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
353
353
|
|
|
354
354
|
new_options = opts.merge(
|
|
355
|
-
:operation => :"CompositionsApi.
|
|
355
|
+
:operation => :"CompositionsApi.create_composition",
|
|
356
356
|
:header_params => header_params,
|
|
357
357
|
:query_params => query_params,
|
|
358
358
|
:form_params => form_params,
|
|
@@ -363,7 +363,7 @@ module ApiSdkRb
|
|
|
363
363
|
|
|
364
364
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
365
365
|
if @api_client.config.debugging
|
|
366
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
366
|
+
@api_client.config.logger.debug "API called: CompositionsApi#create_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
367
367
|
end
|
|
368
368
|
return data, status_code, headers
|
|
369
369
|
end
|
|
@@ -378,9 +378,9 @@ module ApiSdkRb
|
|
|
378
378
|
# @option opts [String] :if_match Optional content version from ETag
|
|
379
379
|
# @option opts [String] :x_managed_user_id 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.
|
|
380
380
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
381
|
-
# @return [
|
|
382
|
-
def
|
|
383
|
-
data, _status_code, _headers =
|
|
381
|
+
# @return [ContentItemWriteResultResponse]
|
|
382
|
+
def create_composition_content_item(id, list, idempotency_key, create_composition_content_item_request, opts = {})
|
|
383
|
+
data, _status_code, _headers = create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts)
|
|
384
384
|
data
|
|
385
385
|
end
|
|
386
386
|
|
|
@@ -394,46 +394,46 @@ module ApiSdkRb
|
|
|
394
394
|
# @option opts [String] :if_match Optional content version from ETag
|
|
395
395
|
# @option opts [String] :x_managed_user_id 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.
|
|
396
396
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
397
|
-
# @return [Array<(
|
|
398
|
-
def
|
|
397
|
+
# @return [Array<(ContentItemWriteResultResponse, Integer, Hash)>] ContentItemWriteResultResponse data, response status code and response headers
|
|
398
|
+
def create_composition_content_item_with_http_info(id, list, idempotency_key, create_composition_content_item_request, opts = {})
|
|
399
399
|
if @api_client.config.debugging
|
|
400
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
400
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.create_composition_content_item ...'
|
|
401
401
|
end
|
|
402
402
|
# verify the required parameter 'id' is set
|
|
403
403
|
if @api_client.config.client_side_validation && id.nil?
|
|
404
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
404
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.create_composition_content_item"
|
|
405
405
|
end
|
|
406
406
|
# verify the required parameter 'list' is set
|
|
407
407
|
if @api_client.config.client_side_validation && list.nil?
|
|
408
|
-
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.
|
|
408
|
+
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.create_composition_content_item"
|
|
409
409
|
end
|
|
410
410
|
# verify the required parameter 'idempotency_key' is set
|
|
411
411
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
412
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
412
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.create_composition_content_item"
|
|
413
413
|
end
|
|
414
414
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
415
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
415
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_content_item, the character length must be smaller than or equal to 50.'
|
|
416
416
|
end
|
|
417
417
|
|
|
418
418
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
419
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
419
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_content_item, the character length must be great than or equal to 8.'
|
|
420
420
|
end
|
|
421
421
|
|
|
422
422
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
423
423
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
424
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
424
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.create_composition_content_item, must conform to the pattern #{pattern}."
|
|
425
425
|
end
|
|
426
426
|
|
|
427
427
|
# verify the required parameter 'create_composition_content_item_request' is set
|
|
428
428
|
if @api_client.config.client_side_validation && create_composition_content_item_request.nil?
|
|
429
|
-
fail ArgumentError, "Missing the required parameter 'create_composition_content_item_request' when calling CompositionsApi.
|
|
429
|
+
fail ArgumentError, "Missing the required parameter 'create_composition_content_item_request' when calling CompositionsApi.create_composition_content_item"
|
|
430
430
|
end
|
|
431
431
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
432
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
432
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_content_item, the character length must be smaller than or equal to 255.'
|
|
433
433
|
end
|
|
434
434
|
|
|
435
435
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
436
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
436
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_content_item, the character length must be great than or equal to 1.'
|
|
437
437
|
end
|
|
438
438
|
|
|
439
439
|
# resource path
|
|
@@ -463,13 +463,13 @@ module ApiSdkRb
|
|
|
463
463
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_composition_content_item_request)
|
|
464
464
|
|
|
465
465
|
# return_type
|
|
466
|
-
return_type = opts[:debug_return_type] || '
|
|
466
|
+
return_type = opts[:debug_return_type] || 'ContentItemWriteResultResponse'
|
|
467
467
|
|
|
468
468
|
# auth_names
|
|
469
469
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
470
470
|
|
|
471
471
|
new_options = opts.merge(
|
|
472
|
-
:operation => :"CompositionsApi.
|
|
472
|
+
:operation => :"CompositionsApi.create_composition_content_item",
|
|
473
473
|
:header_params => header_params,
|
|
474
474
|
:query_params => query_params,
|
|
475
475
|
:form_params => form_params,
|
|
@@ -480,7 +480,7 @@ module ApiSdkRb
|
|
|
480
480
|
|
|
481
481
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
482
482
|
if @api_client.config.debugging
|
|
483
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
483
|
+
@api_client.config.logger.debug "API called: CompositionsApi#create_composition_content_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
484
484
|
end
|
|
485
485
|
return data, status_code, headers
|
|
486
486
|
end
|
|
@@ -494,9 +494,9 @@ module ApiSdkRb
|
|
|
494
494
|
# @param [Hash] opts the optional parameters
|
|
495
495
|
# @option opts [String] :x_managed_user_id 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.
|
|
496
496
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
497
|
-
# @return [
|
|
498
|
-
def
|
|
499
|
-
data, _status_code, _headers =
|
|
497
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
498
|
+
def create_composition_database_record(id, table, idempotency_key, body, opts = {})
|
|
499
|
+
data, _status_code, _headers = create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts)
|
|
500
500
|
data
|
|
501
501
|
end
|
|
502
502
|
|
|
@@ -509,46 +509,46 @@ module ApiSdkRb
|
|
|
509
509
|
# @param [Hash] opts the optional parameters
|
|
510
510
|
# @option opts [String] :x_managed_user_id 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.
|
|
511
511
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
512
|
-
# @return [Array<(
|
|
513
|
-
def
|
|
512
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
513
|
+
def create_composition_database_record_with_http_info(id, table, idempotency_key, body, opts = {})
|
|
514
514
|
if @api_client.config.debugging
|
|
515
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
515
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.create_composition_database_record ...'
|
|
516
516
|
end
|
|
517
517
|
# verify the required parameter 'id' is set
|
|
518
518
|
if @api_client.config.client_side_validation && id.nil?
|
|
519
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
519
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.create_composition_database_record"
|
|
520
520
|
end
|
|
521
521
|
# verify the required parameter 'table' is set
|
|
522
522
|
if @api_client.config.client_side_validation && table.nil?
|
|
523
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
523
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.create_composition_database_record"
|
|
524
524
|
end
|
|
525
525
|
# verify the required parameter 'idempotency_key' is set
|
|
526
526
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
527
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
527
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.create_composition_database_record"
|
|
528
528
|
end
|
|
529
529
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
530
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
530
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_database_record, the character length must be smaller than or equal to 50.'
|
|
531
531
|
end
|
|
532
532
|
|
|
533
533
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
534
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
534
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.create_composition_database_record, the character length must be great than or equal to 8.'
|
|
535
535
|
end
|
|
536
536
|
|
|
537
537
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
538
538
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
539
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
539
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.create_composition_database_record, must conform to the pattern #{pattern}."
|
|
540
540
|
end
|
|
541
541
|
|
|
542
542
|
# verify the required parameter 'body' is set
|
|
543
543
|
if @api_client.config.client_side_validation && body.nil?
|
|
544
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.
|
|
544
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.create_composition_database_record"
|
|
545
545
|
end
|
|
546
546
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
547
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
547
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
548
548
|
end
|
|
549
549
|
|
|
550
550
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
551
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
551
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.create_composition_database_record, the character length must be great than or equal to 1.'
|
|
552
552
|
end
|
|
553
553
|
|
|
554
554
|
# resource path
|
|
@@ -577,13 +577,13 @@ module ApiSdkRb
|
|
|
577
577
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
|
578
578
|
|
|
579
579
|
# return_type
|
|
580
|
-
return_type = opts[:debug_return_type] || '
|
|
580
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
581
581
|
|
|
582
582
|
# auth_names
|
|
583
583
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
584
584
|
|
|
585
585
|
new_options = opts.merge(
|
|
586
|
-
:operation => :"CompositionsApi.
|
|
586
|
+
:operation => :"CompositionsApi.create_composition_database_record",
|
|
587
587
|
:header_params => header_params,
|
|
588
588
|
:query_params => query_params,
|
|
589
589
|
:form_params => form_params,
|
|
@@ -594,7 +594,7 @@ module ApiSdkRb
|
|
|
594
594
|
|
|
595
595
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
596
596
|
if @api_client.config.debugging
|
|
597
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
597
|
+
@api_client.config.logger.debug "API called: CompositionsApi#create_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
598
598
|
end
|
|
599
599
|
return data, status_code, headers
|
|
600
600
|
end
|
|
@@ -606,8 +606,8 @@ module ApiSdkRb
|
|
|
606
606
|
# @option opts [String] :x_managed_user_id 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.
|
|
607
607
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
608
608
|
# @return [nil]
|
|
609
|
-
def
|
|
610
|
-
|
|
609
|
+
def delete_composition(id, opts = {})
|
|
610
|
+
delete_composition_with_http_info(id, opts)
|
|
611
611
|
nil
|
|
612
612
|
end
|
|
613
613
|
|
|
@@ -618,20 +618,20 @@ module ApiSdkRb
|
|
|
618
618
|
# @option opts [String] :x_managed_user_id 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.
|
|
619
619
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
620
620
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
621
|
-
def
|
|
621
|
+
def delete_composition_with_http_info(id, opts = {})
|
|
622
622
|
if @api_client.config.debugging
|
|
623
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
623
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition ...'
|
|
624
624
|
end
|
|
625
625
|
# verify the required parameter 'id' is set
|
|
626
626
|
if @api_client.config.client_side_validation && id.nil?
|
|
627
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
627
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition"
|
|
628
628
|
end
|
|
629
629
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
630
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
630
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition, the character length must be smaller than or equal to 255.'
|
|
631
631
|
end
|
|
632
632
|
|
|
633
633
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
634
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
634
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition, the character length must be great than or equal to 1.'
|
|
635
635
|
end
|
|
636
636
|
|
|
637
637
|
# resource path
|
|
@@ -660,7 +660,7 @@ module ApiSdkRb
|
|
|
660
660
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
661
661
|
|
|
662
662
|
new_options = opts.merge(
|
|
663
|
-
:operation => :"CompositionsApi.
|
|
663
|
+
:operation => :"CompositionsApi.delete_composition",
|
|
664
664
|
:header_params => header_params,
|
|
665
665
|
:query_params => query_params,
|
|
666
666
|
:form_params => form_params,
|
|
@@ -671,7 +671,7 @@ module ApiSdkRb
|
|
|
671
671
|
|
|
672
672
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
673
673
|
if @api_client.config.debugging
|
|
674
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
674
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
675
675
|
end
|
|
676
676
|
return data, status_code, headers
|
|
677
677
|
end
|
|
@@ -686,8 +686,8 @@ module ApiSdkRb
|
|
|
686
686
|
# @option opts [String] :x_managed_user_id 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.
|
|
687
687
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
688
688
|
# @return [DeleteCompositionContentItemResponse]
|
|
689
|
-
def
|
|
690
|
-
data, _status_code, _headers =
|
|
689
|
+
def delete_composition_content_item(id, list, item_id, idempotency_key, opts = {})
|
|
690
|
+
data, _status_code, _headers = delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts)
|
|
691
691
|
data
|
|
692
692
|
end
|
|
693
693
|
|
|
@@ -701,45 +701,45 @@ module ApiSdkRb
|
|
|
701
701
|
# @option opts [String] :x_managed_user_id 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.
|
|
702
702
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
703
703
|
# @return [Array<(DeleteCompositionContentItemResponse, Integer, Hash)>] DeleteCompositionContentItemResponse data, response status code and response headers
|
|
704
|
-
def
|
|
704
|
+
def delete_composition_content_item_with_http_info(id, list, item_id, idempotency_key, opts = {})
|
|
705
705
|
if @api_client.config.debugging
|
|
706
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
706
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_content_item ...'
|
|
707
707
|
end
|
|
708
708
|
# verify the required parameter 'id' is set
|
|
709
709
|
if @api_client.config.client_side_validation && id.nil?
|
|
710
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
710
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_content_item"
|
|
711
711
|
end
|
|
712
712
|
# verify the required parameter 'list' is set
|
|
713
713
|
if @api_client.config.client_side_validation && list.nil?
|
|
714
|
-
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.
|
|
714
|
+
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.delete_composition_content_item"
|
|
715
715
|
end
|
|
716
716
|
# verify the required parameter 'item_id' is set
|
|
717
717
|
if @api_client.config.client_side_validation && item_id.nil?
|
|
718
|
-
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.
|
|
718
|
+
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.delete_composition_content_item"
|
|
719
719
|
end
|
|
720
720
|
# verify the required parameter 'idempotency_key' is set
|
|
721
721
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
722
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
722
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.delete_composition_content_item"
|
|
723
723
|
end
|
|
724
724
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
725
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
725
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_content_item, the character length must be smaller than or equal to 50.'
|
|
726
726
|
end
|
|
727
727
|
|
|
728
728
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
729
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
729
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_content_item, the character length must be great than or equal to 8.'
|
|
730
730
|
end
|
|
731
731
|
|
|
732
732
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
733
733
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
734
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
734
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.delete_composition_content_item, must conform to the pattern #{pattern}."
|
|
735
735
|
end
|
|
736
736
|
|
|
737
737
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
738
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
738
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_content_item, the character length must be smaller than or equal to 255.'
|
|
739
739
|
end
|
|
740
740
|
|
|
741
741
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
742
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
742
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_content_item, the character length must be great than or equal to 1.'
|
|
743
743
|
end
|
|
744
744
|
|
|
745
745
|
# resource path
|
|
@@ -770,7 +770,7 @@ module ApiSdkRb
|
|
|
770
770
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
771
771
|
|
|
772
772
|
new_options = opts.merge(
|
|
773
|
-
:operation => :"CompositionsApi.
|
|
773
|
+
:operation => :"CompositionsApi.delete_composition_content_item",
|
|
774
774
|
:header_params => header_params,
|
|
775
775
|
:query_params => query_params,
|
|
776
776
|
:form_params => form_params,
|
|
@@ -781,7 +781,7 @@ module ApiSdkRb
|
|
|
781
781
|
|
|
782
782
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
783
783
|
if @api_client.config.debugging
|
|
784
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
784
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_content_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
785
785
|
end
|
|
786
786
|
return data, status_code, headers
|
|
787
787
|
end
|
|
@@ -794,8 +794,8 @@ module ApiSdkRb
|
|
|
794
794
|
# @option opts [String] :x_managed_user_id 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.
|
|
795
795
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
796
796
|
# @return [DeleteCompositionDataSourceResponse]
|
|
797
|
-
def
|
|
798
|
-
data, _status_code, _headers =
|
|
797
|
+
def delete_composition_data_source(id, idempotency_key, opts = {})
|
|
798
|
+
data, _status_code, _headers = delete_composition_data_source_with_http_info(id, idempotency_key, opts)
|
|
799
799
|
data
|
|
800
800
|
end
|
|
801
801
|
|
|
@@ -807,37 +807,37 @@ module ApiSdkRb
|
|
|
807
807
|
# @option opts [String] :x_managed_user_id 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.
|
|
808
808
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
809
809
|
# @return [Array<(DeleteCompositionDataSourceResponse, Integer, Hash)>] DeleteCompositionDataSourceResponse data, response status code and response headers
|
|
810
|
-
def
|
|
810
|
+
def delete_composition_data_source_with_http_info(id, idempotency_key, opts = {})
|
|
811
811
|
if @api_client.config.debugging
|
|
812
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
812
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_data_source ...'
|
|
813
813
|
end
|
|
814
814
|
# verify the required parameter 'id' is set
|
|
815
815
|
if @api_client.config.client_side_validation && id.nil?
|
|
816
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
816
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_data_source"
|
|
817
817
|
end
|
|
818
818
|
# verify the required parameter 'idempotency_key' is set
|
|
819
819
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
820
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
820
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.delete_composition_data_source"
|
|
821
821
|
end
|
|
822
822
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
823
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
823
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_data_source, the character length must be smaller than or equal to 50.'
|
|
824
824
|
end
|
|
825
825
|
|
|
826
826
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
827
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
827
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.delete_composition_data_source, the character length must be great than or equal to 8.'
|
|
828
828
|
end
|
|
829
829
|
|
|
830
830
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
831
831
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
832
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
832
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.delete_composition_data_source, must conform to the pattern #{pattern}."
|
|
833
833
|
end
|
|
834
834
|
|
|
835
835
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
836
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
836
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_data_source, the character length must be smaller than or equal to 255.'
|
|
837
837
|
end
|
|
838
838
|
|
|
839
839
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
840
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
840
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_data_source, the character length must be great than or equal to 1.'
|
|
841
841
|
end
|
|
842
842
|
|
|
843
843
|
# resource path
|
|
@@ -867,7 +867,7 @@ module ApiSdkRb
|
|
|
867
867
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
868
868
|
|
|
869
869
|
new_options = opts.merge(
|
|
870
|
-
:operation => :"CompositionsApi.
|
|
870
|
+
:operation => :"CompositionsApi.delete_composition_data_source",
|
|
871
871
|
:header_params => header_params,
|
|
872
872
|
:query_params => query_params,
|
|
873
873
|
:form_params => form_params,
|
|
@@ -878,7 +878,7 @@ module ApiSdkRb
|
|
|
878
878
|
|
|
879
879
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
880
880
|
if @api_client.config.debugging
|
|
881
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
881
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
882
882
|
end
|
|
883
883
|
return data, status_code, headers
|
|
884
884
|
end
|
|
@@ -891,9 +891,9 @@ module ApiSdkRb
|
|
|
891
891
|
# @param [Hash] opts the optional parameters
|
|
892
892
|
# @option opts [String] :x_managed_user_id 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.
|
|
893
893
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
894
|
-
# @return [
|
|
895
|
-
def
|
|
896
|
-
data, _status_code, _headers =
|
|
894
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
895
|
+
def delete_composition_database_record(id, table, record_id, opts = {})
|
|
896
|
+
data, _status_code, _headers = delete_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
897
897
|
data
|
|
898
898
|
end
|
|
899
899
|
|
|
@@ -905,29 +905,29 @@ module ApiSdkRb
|
|
|
905
905
|
# @param [Hash] opts the optional parameters
|
|
906
906
|
# @option opts [String] :x_managed_user_id 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.
|
|
907
907
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
908
|
-
# @return [Array<(
|
|
909
|
-
def
|
|
908
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
909
|
+
def delete_composition_database_record_with_http_info(id, table, record_id, opts = {})
|
|
910
910
|
if @api_client.config.debugging
|
|
911
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
911
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_database_record ...'
|
|
912
912
|
end
|
|
913
913
|
# verify the required parameter 'id' is set
|
|
914
914
|
if @api_client.config.client_side_validation && id.nil?
|
|
915
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
915
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_database_record"
|
|
916
916
|
end
|
|
917
917
|
# verify the required parameter 'table' is set
|
|
918
918
|
if @api_client.config.client_side_validation && table.nil?
|
|
919
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
919
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.delete_composition_database_record"
|
|
920
920
|
end
|
|
921
921
|
# verify the required parameter 'record_id' is set
|
|
922
922
|
if @api_client.config.client_side_validation && record_id.nil?
|
|
923
|
-
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.
|
|
923
|
+
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.delete_composition_database_record"
|
|
924
924
|
end
|
|
925
925
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
926
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
926
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
927
927
|
end
|
|
928
928
|
|
|
929
929
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
930
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
930
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_database_record, the character length must be great than or equal to 1.'
|
|
931
931
|
end
|
|
932
932
|
|
|
933
933
|
# resource path
|
|
@@ -950,13 +950,109 @@ module ApiSdkRb
|
|
|
950
950
|
post_body = opts[:debug_body]
|
|
951
951
|
|
|
952
952
|
# return_type
|
|
953
|
-
return_type = opts[:debug_return_type] || '
|
|
953
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
954
|
+
|
|
955
|
+
# auth_names
|
|
956
|
+
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
957
|
+
|
|
958
|
+
new_options = opts.merge(
|
|
959
|
+
:operation => :"CompositionsApi.delete_composition_database_record",
|
|
960
|
+
:header_params => header_params,
|
|
961
|
+
:query_params => query_params,
|
|
962
|
+
:form_params => form_params,
|
|
963
|
+
:body => post_body,
|
|
964
|
+
:auth_names => auth_names,
|
|
965
|
+
:return_type => return_type
|
|
966
|
+
)
|
|
967
|
+
|
|
968
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
969
|
+
if @api_client.config.debugging
|
|
970
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
971
|
+
end
|
|
972
|
+
return data, status_code, headers
|
|
973
|
+
end
|
|
974
|
+
|
|
975
|
+
# Delete composition entry items by id or host context
|
|
976
|
+
# Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
977
|
+
# @param id [String]
|
|
978
|
+
# @param table [String]
|
|
979
|
+
# @param [Hash] opts the optional parameters
|
|
980
|
+
# @option opts [String] :ids
|
|
981
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
982
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
983
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
984
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
985
|
+
# @return [CompositionEntryDeleteSuccess]
|
|
986
|
+
def delete_composition_entry_items(id, table, opts = {})
|
|
987
|
+
data, _status_code, _headers = delete_composition_entry_items_with_http_info(id, table, opts)
|
|
988
|
+
data
|
|
989
|
+
end
|
|
990
|
+
|
|
991
|
+
# Delete composition entry items by id or host context
|
|
992
|
+
# Delete by comma-separated ids (1–100) or by context filters (not both). Rate limit 30 requests per minute.
|
|
993
|
+
# @param id [String]
|
|
994
|
+
# @param table [String]
|
|
995
|
+
# @param [Hash] opts the optional parameters
|
|
996
|
+
# @option opts [String] :ids
|
|
997
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
998
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
999
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1000
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1001
|
+
# @return [Array<(CompositionEntryDeleteSuccess, Integer, Hash)>] CompositionEntryDeleteSuccess data, response status code and response headers
|
|
1002
|
+
def delete_composition_entry_items_with_http_info(id, table, opts = {})
|
|
1003
|
+
if @api_client.config.debugging
|
|
1004
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.delete_composition_entry_items ...'
|
|
1005
|
+
end
|
|
1006
|
+
# verify the required parameter 'id' is set
|
|
1007
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1008
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.delete_composition_entry_items"
|
|
1009
|
+
end
|
|
1010
|
+
# verify the required parameter 'table' is set
|
|
1011
|
+
if @api_client.config.client_side_validation && table.nil?
|
|
1012
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.delete_composition_entry_items"
|
|
1013
|
+
end
|
|
1014
|
+
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
1015
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.delete_composition_entry_items, the character length must be smaller than or equal to 63.'
|
|
1016
|
+
end
|
|
1017
|
+
|
|
1018
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1019
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_entry_items, the character length must be smaller than or equal to 255.'
|
|
1020
|
+
end
|
|
1021
|
+
|
|
1022
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1023
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.delete_composition_entry_items, the character length must be great than or equal to 1.'
|
|
1024
|
+
end
|
|
1025
|
+
|
|
1026
|
+
# resource path
|
|
1027
|
+
local_var_path = '/compositions/{id}/entries/{table}/items'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'table' + '}', CGI.escape(table.to_s))
|
|
1028
|
+
|
|
1029
|
+
# query parameters
|
|
1030
|
+
query_params = opts[:query_params] || {}
|
|
1031
|
+
query_params[:'ids'] = opts[:'ids'] if !opts[:'ids'].nil?
|
|
1032
|
+
query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
|
|
1033
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
1034
|
+
|
|
1035
|
+
# header parameters
|
|
1036
|
+
header_params = opts[:header_params] || {}
|
|
1037
|
+
# HTTP header 'Accept' (if needed)
|
|
1038
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1039
|
+
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
1040
|
+
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
1041
|
+
|
|
1042
|
+
# form parameters
|
|
1043
|
+
form_params = opts[:form_params] || {}
|
|
1044
|
+
|
|
1045
|
+
# http body (model)
|
|
1046
|
+
post_body = opts[:debug_body]
|
|
1047
|
+
|
|
1048
|
+
# return_type
|
|
1049
|
+
return_type = opts[:debug_return_type] || 'CompositionEntryDeleteSuccess'
|
|
954
1050
|
|
|
955
1051
|
# auth_names
|
|
956
1052
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
957
1053
|
|
|
958
1054
|
new_options = opts.merge(
|
|
959
|
-
:operation => :"CompositionsApi.
|
|
1055
|
+
:operation => :"CompositionsApi.delete_composition_entry_items",
|
|
960
1056
|
:header_params => header_params,
|
|
961
1057
|
:query_params => query_params,
|
|
962
1058
|
:form_params => form_params,
|
|
@@ -967,7 +1063,7 @@ module ApiSdkRb
|
|
|
967
1063
|
|
|
968
1064
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
969
1065
|
if @api_client.config.debugging
|
|
970
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1066
|
+
@api_client.config.logger.debug "API called: CompositionsApi#delete_composition_entry_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
971
1067
|
end
|
|
972
1068
|
return data, status_code, headers
|
|
973
1069
|
end
|
|
@@ -979,8 +1075,8 @@ module ApiSdkRb
|
|
|
979
1075
|
# @option opts [String] :x_managed_user_id 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.
|
|
980
1076
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
981
1077
|
# @return [CompositionEntriesDescriptionResponse]
|
|
982
|
-
def
|
|
983
|
-
data, _status_code, _headers =
|
|
1078
|
+
def describe_composition_entries(id, opts = {})
|
|
1079
|
+
data, _status_code, _headers = describe_composition_entries_with_http_info(id, opts)
|
|
984
1080
|
data
|
|
985
1081
|
end
|
|
986
1082
|
|
|
@@ -991,20 +1087,20 @@ module ApiSdkRb
|
|
|
991
1087
|
# @option opts [String] :x_managed_user_id 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.
|
|
992
1088
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
993
1089
|
# @return [Array<(CompositionEntriesDescriptionResponse, Integer, Hash)>] CompositionEntriesDescriptionResponse data, response status code and response headers
|
|
994
|
-
def
|
|
1090
|
+
def describe_composition_entries_with_http_info(id, opts = {})
|
|
995
1091
|
if @api_client.config.debugging
|
|
996
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1092
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.describe_composition_entries ...'
|
|
997
1093
|
end
|
|
998
1094
|
# verify the required parameter 'id' is set
|
|
999
1095
|
if @api_client.config.client_side_validation && id.nil?
|
|
1000
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1096
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.describe_composition_entries"
|
|
1001
1097
|
end
|
|
1002
1098
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1003
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1099
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.describe_composition_entries, the character length must be smaller than or equal to 255.'
|
|
1004
1100
|
end
|
|
1005
1101
|
|
|
1006
1102
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1007
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1103
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.describe_composition_entries, the character length must be great than or equal to 1.'
|
|
1008
1104
|
end
|
|
1009
1105
|
|
|
1010
1106
|
# resource path
|
|
@@ -1033,7 +1129,7 @@ module ApiSdkRb
|
|
|
1033
1129
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1034
1130
|
|
|
1035
1131
|
new_options = opts.merge(
|
|
1036
|
-
:operation => :"CompositionsApi.
|
|
1132
|
+
:operation => :"CompositionsApi.describe_composition_entries",
|
|
1037
1133
|
:header_params => header_params,
|
|
1038
1134
|
:query_params => query_params,
|
|
1039
1135
|
:form_params => form_params,
|
|
@@ -1044,7 +1140,7 @@ module ApiSdkRb
|
|
|
1044
1140
|
|
|
1045
1141
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1046
1142
|
if @api_client.config.debugging
|
|
1047
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1143
|
+
@api_client.config.logger.debug "API called: CompositionsApi#describe_composition_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1048
1144
|
end
|
|
1049
1145
|
return data, status_code, headers
|
|
1050
1146
|
end
|
|
@@ -1058,8 +1154,8 @@ module ApiSdkRb
|
|
|
1058
1154
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1059
1155
|
# @option opts [DuplicateCompositionRequest] :duplicate_composition_request
|
|
1060
1156
|
# @return [DuplicateComposition202Response]
|
|
1061
|
-
def
|
|
1062
|
-
data, _status_code, _headers =
|
|
1157
|
+
def duplicate_composition(id, idempotency_key, opts = {})
|
|
1158
|
+
data, _status_code, _headers = duplicate_composition_with_http_info(id, idempotency_key, opts)
|
|
1063
1159
|
data
|
|
1064
1160
|
end
|
|
1065
1161
|
|
|
@@ -1072,37 +1168,37 @@ module ApiSdkRb
|
|
|
1072
1168
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1073
1169
|
# @option opts [DuplicateCompositionRequest] :duplicate_composition_request
|
|
1074
1170
|
# @return [Array<(DuplicateComposition202Response, Integer, Hash)>] DuplicateComposition202Response data, response status code and response headers
|
|
1075
|
-
def
|
|
1171
|
+
def duplicate_composition_with_http_info(id, idempotency_key, opts = {})
|
|
1076
1172
|
if @api_client.config.debugging
|
|
1077
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1173
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.duplicate_composition ...'
|
|
1078
1174
|
end
|
|
1079
1175
|
# verify the required parameter 'id' is set
|
|
1080
1176
|
if @api_client.config.client_side_validation && id.nil?
|
|
1081
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1177
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.duplicate_composition"
|
|
1082
1178
|
end
|
|
1083
1179
|
# verify the required parameter 'idempotency_key' is set
|
|
1084
1180
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
1085
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
1181
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.duplicate_composition"
|
|
1086
1182
|
end
|
|
1087
1183
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
1088
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
1184
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.duplicate_composition, the character length must be smaller than or equal to 50.'
|
|
1089
1185
|
end
|
|
1090
1186
|
|
|
1091
1187
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
1092
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
1188
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.duplicate_composition, the character length must be great than or equal to 8.'
|
|
1093
1189
|
end
|
|
1094
1190
|
|
|
1095
1191
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
1096
1192
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
1097
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
1193
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.duplicate_composition, must conform to the pattern #{pattern}."
|
|
1098
1194
|
end
|
|
1099
1195
|
|
|
1100
1196
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1101
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1197
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.duplicate_composition, the character length must be smaller than or equal to 255.'
|
|
1102
1198
|
end
|
|
1103
1199
|
|
|
1104
1200
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1105
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1201
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.duplicate_composition, the character length must be great than or equal to 1.'
|
|
1106
1202
|
end
|
|
1107
1203
|
|
|
1108
1204
|
# resource path
|
|
@@ -1137,7 +1233,7 @@ module ApiSdkRb
|
|
|
1137
1233
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1138
1234
|
|
|
1139
1235
|
new_options = opts.merge(
|
|
1140
|
-
:operation => :"CompositionsApi.
|
|
1236
|
+
:operation => :"CompositionsApi.duplicate_composition",
|
|
1141
1237
|
:header_params => header_params,
|
|
1142
1238
|
:query_params => query_params,
|
|
1143
1239
|
:form_params => form_params,
|
|
@@ -1148,7 +1244,120 @@ module ApiSdkRb
|
|
|
1148
1244
|
|
|
1149
1245
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1150
1246
|
if @api_client.config.debugging
|
|
1151
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1247
|
+
@api_client.config.logger.debug "API called: CompositionsApi#duplicate_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1248
|
+
end
|
|
1249
|
+
return data, status_code, headers
|
|
1250
|
+
end
|
|
1251
|
+
|
|
1252
|
+
# Export composition entry items
|
|
1253
|
+
# 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.
|
|
1254
|
+
# @param id [String]
|
|
1255
|
+
# @param table [String]
|
|
1256
|
+
# @param [Hash] opts the optional parameters
|
|
1257
|
+
# @option opts [String] :format (default to 'csv')
|
|
1258
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
1259
|
+
# @option opts [Time] :since 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`.
|
|
1260
|
+
# @option opts [Time] :_until 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`).
|
|
1261
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
1262
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
1263
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1264
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1265
|
+
# @return [String]
|
|
1266
|
+
def export_composition_entry_items(id, table, opts = {})
|
|
1267
|
+
data, _status_code, _headers = export_composition_entry_items_with_http_info(id, table, opts)
|
|
1268
|
+
data
|
|
1269
|
+
end
|
|
1270
|
+
|
|
1271
|
+
# Export composition entry items
|
|
1272
|
+
# 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.
|
|
1273
|
+
# @param id [String]
|
|
1274
|
+
# @param table [String]
|
|
1275
|
+
# @param [Hash] opts the optional parameters
|
|
1276
|
+
# @option opts [String] :format (default to 'csv')
|
|
1277
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
1278
|
+
# @option opts [Time] :since 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`.
|
|
1279
|
+
# @option opts [Time] :_until 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`).
|
|
1280
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
1281
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
1282
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
1283
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
1284
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
1285
|
+
def export_composition_entry_items_with_http_info(id, table, opts = {})
|
|
1286
|
+
if @api_client.config.debugging
|
|
1287
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.export_composition_entry_items ...'
|
|
1288
|
+
end
|
|
1289
|
+
# verify the required parameter 'id' is set
|
|
1290
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1291
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.export_composition_entry_items"
|
|
1292
|
+
end
|
|
1293
|
+
# verify the required parameter 'table' is set
|
|
1294
|
+
if @api_client.config.client_side_validation && table.nil?
|
|
1295
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.export_composition_entry_items"
|
|
1296
|
+
end
|
|
1297
|
+
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
1298
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.export_composition_entry_items, the character length must be smaller than or equal to 63.'
|
|
1299
|
+
end
|
|
1300
|
+
|
|
1301
|
+
allowable_values = ["csv", "json"]
|
|
1302
|
+
if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
|
|
1303
|
+
fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
|
|
1304
|
+
end
|
|
1305
|
+
allowable_values = ["asc", "desc"]
|
|
1306
|
+
if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
|
|
1307
|
+
fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
|
|
1308
|
+
end
|
|
1309
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1310
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.export_composition_entry_items, the character length must be smaller than or equal to 255.'
|
|
1311
|
+
end
|
|
1312
|
+
|
|
1313
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1314
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.export_composition_entry_items, the character length must be great than or equal to 1.'
|
|
1315
|
+
end
|
|
1316
|
+
|
|
1317
|
+
# resource path
|
|
1318
|
+
local_var_path = '/compositions/{id}/entries/{table}/export'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'table' + '}', CGI.escape(table.to_s))
|
|
1319
|
+
|
|
1320
|
+
# query parameters
|
|
1321
|
+
query_params = opts[:query_params] || {}
|
|
1322
|
+
query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?
|
|
1323
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
1324
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
1325
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
1326
|
+
query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
|
|
1327
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
1328
|
+
|
|
1329
|
+
# header parameters
|
|
1330
|
+
header_params = opts[:header_params] || {}
|
|
1331
|
+
# HTTP header 'Accept' (if needed)
|
|
1332
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/csv', 'application/json']) unless header_params['Accept']
|
|
1333
|
+
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
1334
|
+
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
1335
|
+
|
|
1336
|
+
# form parameters
|
|
1337
|
+
form_params = opts[:form_params] || {}
|
|
1338
|
+
|
|
1339
|
+
# http body (model)
|
|
1340
|
+
post_body = opts[:debug_body]
|
|
1341
|
+
|
|
1342
|
+
# return_type
|
|
1343
|
+
return_type = opts[:debug_return_type] || 'String'
|
|
1344
|
+
|
|
1345
|
+
# auth_names
|
|
1346
|
+
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1347
|
+
|
|
1348
|
+
new_options = opts.merge(
|
|
1349
|
+
:operation => :"CompositionsApi.export_composition_entry_items",
|
|
1350
|
+
:header_params => header_params,
|
|
1351
|
+
:query_params => query_params,
|
|
1352
|
+
:form_params => form_params,
|
|
1353
|
+
:body => post_body,
|
|
1354
|
+
:auth_names => auth_names,
|
|
1355
|
+
:return_type => return_type
|
|
1356
|
+
)
|
|
1357
|
+
|
|
1358
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1359
|
+
if @api_client.config.debugging
|
|
1360
|
+
@api_client.config.logger.debug "API called: CompositionsApi#export_composition_entry_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1152
1361
|
end
|
|
1153
1362
|
return data, status_code, headers
|
|
1154
1363
|
end
|
|
@@ -1160,8 +1369,8 @@ module ApiSdkRb
|
|
|
1160
1369
|
# @option opts [String] :x_managed_user_id 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.
|
|
1161
1370
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1162
1371
|
# @return [GetAiAnswersKnowledge200Response]
|
|
1163
|
-
def
|
|
1164
|
-
data, _status_code, _headers =
|
|
1372
|
+
def get_ai_answers_knowledge(id, opts = {})
|
|
1373
|
+
data, _status_code, _headers = get_ai_answers_knowledge_with_http_info(id, opts)
|
|
1165
1374
|
data
|
|
1166
1375
|
end
|
|
1167
1376
|
|
|
@@ -1172,20 +1381,20 @@ module ApiSdkRb
|
|
|
1172
1381
|
# @option opts [String] :x_managed_user_id 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.
|
|
1173
1382
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1174
1383
|
# @return [Array<(GetAiAnswersKnowledge200Response, Integer, Hash)>] GetAiAnswersKnowledge200Response data, response status code and response headers
|
|
1175
|
-
def
|
|
1384
|
+
def get_ai_answers_knowledge_with_http_info(id, opts = {})
|
|
1176
1385
|
if @api_client.config.debugging
|
|
1177
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1386
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_ai_answers_knowledge ...'
|
|
1178
1387
|
end
|
|
1179
1388
|
# verify the required parameter 'id' is set
|
|
1180
1389
|
if @api_client.config.client_side_validation && id.nil?
|
|
1181
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1390
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_ai_answers_knowledge"
|
|
1182
1391
|
end
|
|
1183
1392
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1184
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1393
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_ai_answers_knowledge, the character length must be smaller than or equal to 255.'
|
|
1185
1394
|
end
|
|
1186
1395
|
|
|
1187
1396
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1188
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1397
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_ai_answers_knowledge, the character length must be great than or equal to 1.'
|
|
1189
1398
|
end
|
|
1190
1399
|
|
|
1191
1400
|
# resource path
|
|
@@ -1214,7 +1423,7 @@ module ApiSdkRb
|
|
|
1214
1423
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1215
1424
|
|
|
1216
1425
|
new_options = opts.merge(
|
|
1217
|
-
:operation => :"CompositionsApi.
|
|
1426
|
+
:operation => :"CompositionsApi.get_ai_answers_knowledge",
|
|
1218
1427
|
:header_params => header_params,
|
|
1219
1428
|
:query_params => query_params,
|
|
1220
1429
|
:form_params => form_params,
|
|
@@ -1225,7 +1434,7 @@ module ApiSdkRb
|
|
|
1225
1434
|
|
|
1226
1435
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1227
1436
|
if @api_client.config.debugging
|
|
1228
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1437
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_ai_answers_knowledge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1229
1438
|
end
|
|
1230
1439
|
return data, status_code, headers
|
|
1231
1440
|
end
|
|
@@ -1245,8 +1454,8 @@ module ApiSdkRb
|
|
|
1245
1454
|
# @option opts [String] :x_managed_user_id 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.
|
|
1246
1455
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1247
1456
|
# @return [GetAllCompositions200Response]
|
|
1248
|
-
def
|
|
1249
|
-
data, _status_code, _headers =
|
|
1457
|
+
def get_all_compositions(opts = {})
|
|
1458
|
+
data, _status_code, _headers = get_all_compositions_with_http_info(opts)
|
|
1250
1459
|
data
|
|
1251
1460
|
end
|
|
1252
1461
|
|
|
@@ -1265,20 +1474,20 @@ module ApiSdkRb
|
|
|
1265
1474
|
# @option opts [String] :x_managed_user_id 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.
|
|
1266
1475
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1267
1476
|
# @return [Array<(GetAllCompositions200Response, Integer, Hash)>] GetAllCompositions200Response data, response status code and response headers
|
|
1268
|
-
def
|
|
1477
|
+
def get_all_compositions_with_http_info(opts = {})
|
|
1269
1478
|
if @api_client.config.debugging
|
|
1270
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1479
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_all_compositions ...'
|
|
1271
1480
|
end
|
|
1272
1481
|
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
1273
|
-
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CompositionsApi.
|
|
1482
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CompositionsApi.get_all_compositions, must be greater than or equal to 1.'
|
|
1274
1483
|
end
|
|
1275
1484
|
|
|
1276
1485
|
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
|
|
1277
|
-
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.
|
|
1486
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.get_all_compositions, must be smaller than or equal to 100.'
|
|
1278
1487
|
end
|
|
1279
1488
|
|
|
1280
1489
|
if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
|
|
1281
|
-
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.
|
|
1490
|
+
fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CompositionsApi.get_all_compositions, must be greater than or equal to 1.'
|
|
1282
1491
|
end
|
|
1283
1492
|
|
|
1284
1493
|
allowable_values = ["true", "false"]
|
|
@@ -1290,15 +1499,15 @@ module ApiSdkRb
|
|
|
1290
1499
|
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
1291
1500
|
end
|
|
1292
1501
|
if @api_client.config.client_side_validation && !opts[:'managed_user_external_id'].nil? && opts[:'managed_user_external_id'].to_s.length > 255
|
|
1293
|
-
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling CompositionsApi.
|
|
1502
|
+
fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling CompositionsApi.get_all_compositions, the character length must be smaller than or equal to 255.'
|
|
1294
1503
|
end
|
|
1295
1504
|
|
|
1296
1505
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1297
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1506
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_all_compositions, the character length must be smaller than or equal to 255.'
|
|
1298
1507
|
end
|
|
1299
1508
|
|
|
1300
1509
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1301
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1510
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_all_compositions, the character length must be great than or equal to 1.'
|
|
1302
1511
|
end
|
|
1303
1512
|
|
|
1304
1513
|
# resource path
|
|
@@ -1336,7 +1545,7 @@ module ApiSdkRb
|
|
|
1336
1545
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1337
1546
|
|
|
1338
1547
|
new_options = opts.merge(
|
|
1339
|
-
:operation => :"CompositionsApi.
|
|
1548
|
+
:operation => :"CompositionsApi.get_all_compositions",
|
|
1340
1549
|
:header_params => header_params,
|
|
1341
1550
|
:query_params => query_params,
|
|
1342
1551
|
:form_params => form_params,
|
|
@@ -1347,7 +1556,7 @@ module ApiSdkRb
|
|
|
1347
1556
|
|
|
1348
1557
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1349
1558
|
if @api_client.config.debugging
|
|
1350
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1559
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_all_compositions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1351
1560
|
end
|
|
1352
1561
|
return data, status_code, headers
|
|
1353
1562
|
end
|
|
@@ -1358,9 +1567,9 @@ module ApiSdkRb
|
|
|
1358
1567
|
# @param [Hash] opts the optional parameters
|
|
1359
1568
|
# @option opts [String] :x_managed_user_id 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.
|
|
1360
1569
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1361
|
-
# @return [
|
|
1362
|
-
def
|
|
1363
|
-
data, _status_code, _headers =
|
|
1570
|
+
# @return [CompositionResponse]
|
|
1571
|
+
def get_composition_by_id(id, opts = {})
|
|
1572
|
+
data, _status_code, _headers = get_composition_by_id_with_http_info(id, opts)
|
|
1364
1573
|
data
|
|
1365
1574
|
end
|
|
1366
1575
|
|
|
@@ -1370,21 +1579,21 @@ module ApiSdkRb
|
|
|
1370
1579
|
# @param [Hash] opts the optional parameters
|
|
1371
1580
|
# @option opts [String] :x_managed_user_id 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.
|
|
1372
1581
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1373
|
-
# @return [Array<(
|
|
1374
|
-
def
|
|
1582
|
+
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
1583
|
+
def get_composition_by_id_with_http_info(id, opts = {})
|
|
1375
1584
|
if @api_client.config.debugging
|
|
1376
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1585
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_by_id ...'
|
|
1377
1586
|
end
|
|
1378
1587
|
# verify the required parameter 'id' is set
|
|
1379
1588
|
if @api_client.config.client_side_validation && id.nil?
|
|
1380
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1589
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_by_id"
|
|
1381
1590
|
end
|
|
1382
1591
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1383
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1592
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_by_id, the character length must be smaller than or equal to 255.'
|
|
1384
1593
|
end
|
|
1385
1594
|
|
|
1386
1595
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1387
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1596
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_by_id, the character length must be great than or equal to 1.'
|
|
1388
1597
|
end
|
|
1389
1598
|
|
|
1390
1599
|
# resource path
|
|
@@ -1407,13 +1616,13 @@ module ApiSdkRb
|
|
|
1407
1616
|
post_body = opts[:debug_body]
|
|
1408
1617
|
|
|
1409
1618
|
# return_type
|
|
1410
|
-
return_type = opts[:debug_return_type] || '
|
|
1619
|
+
return_type = opts[:debug_return_type] || 'CompositionResponse'
|
|
1411
1620
|
|
|
1412
1621
|
# auth_names
|
|
1413
1622
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1414
1623
|
|
|
1415
1624
|
new_options = opts.merge(
|
|
1416
|
-
:operation => :"CompositionsApi.
|
|
1625
|
+
:operation => :"CompositionsApi.get_composition_by_id",
|
|
1417
1626
|
:header_params => header_params,
|
|
1418
1627
|
:query_params => query_params,
|
|
1419
1628
|
:form_params => form_params,
|
|
@@ -1424,7 +1633,7 @@ module ApiSdkRb
|
|
|
1424
1633
|
|
|
1425
1634
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1426
1635
|
if @api_client.config.debugging
|
|
1427
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1636
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1428
1637
|
end
|
|
1429
1638
|
return data, status_code, headers
|
|
1430
1639
|
end
|
|
@@ -1436,8 +1645,8 @@ module ApiSdkRb
|
|
|
1436
1645
|
# @option opts [String] :x_managed_user_id 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.
|
|
1437
1646
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1438
1647
|
# @return [GetCompositionContentResponse]
|
|
1439
|
-
def
|
|
1440
|
-
data, _status_code, _headers =
|
|
1648
|
+
def get_composition_content(id, opts = {})
|
|
1649
|
+
data, _status_code, _headers = get_composition_content_with_http_info(id, opts)
|
|
1441
1650
|
data
|
|
1442
1651
|
end
|
|
1443
1652
|
|
|
@@ -1448,20 +1657,20 @@ module ApiSdkRb
|
|
|
1448
1657
|
# @option opts [String] :x_managed_user_id 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.
|
|
1449
1658
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1450
1659
|
# @return [Array<(GetCompositionContentResponse, Integer, Hash)>] GetCompositionContentResponse data, response status code and response headers
|
|
1451
|
-
def
|
|
1660
|
+
def get_composition_content_with_http_info(id, opts = {})
|
|
1452
1661
|
if @api_client.config.debugging
|
|
1453
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1662
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_content ...'
|
|
1454
1663
|
end
|
|
1455
1664
|
# verify the required parameter 'id' is set
|
|
1456
1665
|
if @api_client.config.client_side_validation && id.nil?
|
|
1457
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1666
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_content"
|
|
1458
1667
|
end
|
|
1459
1668
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1460
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1669
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content, the character length must be smaller than or equal to 255.'
|
|
1461
1670
|
end
|
|
1462
1671
|
|
|
1463
1672
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1464
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1673
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content, the character length must be great than or equal to 1.'
|
|
1465
1674
|
end
|
|
1466
1675
|
|
|
1467
1676
|
# resource path
|
|
@@ -1490,7 +1699,7 @@ module ApiSdkRb
|
|
|
1490
1699
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1491
1700
|
|
|
1492
1701
|
new_options = opts.merge(
|
|
1493
|
-
:operation => :"CompositionsApi.
|
|
1702
|
+
:operation => :"CompositionsApi.get_composition_content",
|
|
1494
1703
|
:header_params => header_params,
|
|
1495
1704
|
:query_params => query_params,
|
|
1496
1705
|
:form_params => form_params,
|
|
@@ -1501,7 +1710,7 @@ module ApiSdkRb
|
|
|
1501
1710
|
|
|
1502
1711
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1503
1712
|
if @api_client.config.debugging
|
|
1504
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1713
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1505
1714
|
end
|
|
1506
1715
|
return data, status_code, headers
|
|
1507
1716
|
end
|
|
@@ -1513,8 +1722,8 @@ module ApiSdkRb
|
|
|
1513
1722
|
# @option opts [String] :x_managed_user_id 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.
|
|
1514
1723
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1515
1724
|
# @return [GetCompositionContentSchemaResponse]
|
|
1516
|
-
def
|
|
1517
|
-
data, _status_code, _headers =
|
|
1725
|
+
def get_composition_content_schema(id, opts = {})
|
|
1726
|
+
data, _status_code, _headers = get_composition_content_schema_with_http_info(id, opts)
|
|
1518
1727
|
data
|
|
1519
1728
|
end
|
|
1520
1729
|
|
|
@@ -1525,20 +1734,20 @@ module ApiSdkRb
|
|
|
1525
1734
|
# @option opts [String] :x_managed_user_id 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.
|
|
1526
1735
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1527
1736
|
# @return [Array<(GetCompositionContentSchemaResponse, Integer, Hash)>] GetCompositionContentSchemaResponse data, response status code and response headers
|
|
1528
|
-
def
|
|
1737
|
+
def get_composition_content_schema_with_http_info(id, opts = {})
|
|
1529
1738
|
if @api_client.config.debugging
|
|
1530
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1739
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_content_schema ...'
|
|
1531
1740
|
end
|
|
1532
1741
|
# verify the required parameter 'id' is set
|
|
1533
1742
|
if @api_client.config.client_side_validation && id.nil?
|
|
1534
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1743
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_content_schema"
|
|
1535
1744
|
end
|
|
1536
1745
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1537
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1746
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content_schema, the character length must be smaller than or equal to 255.'
|
|
1538
1747
|
end
|
|
1539
1748
|
|
|
1540
1749
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1541
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1750
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_content_schema, the character length must be great than or equal to 1.'
|
|
1542
1751
|
end
|
|
1543
1752
|
|
|
1544
1753
|
# resource path
|
|
@@ -1567,7 +1776,7 @@ module ApiSdkRb
|
|
|
1567
1776
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1568
1777
|
|
|
1569
1778
|
new_options = opts.merge(
|
|
1570
|
-
:operation => :"CompositionsApi.
|
|
1779
|
+
:operation => :"CompositionsApi.get_composition_content_schema",
|
|
1571
1780
|
:header_params => header_params,
|
|
1572
1781
|
:query_params => query_params,
|
|
1573
1782
|
:form_params => form_params,
|
|
@@ -1578,7 +1787,7 @@ module ApiSdkRb
|
|
|
1578
1787
|
|
|
1579
1788
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1580
1789
|
if @api_client.config.debugging
|
|
1581
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1790
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_content_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1582
1791
|
end
|
|
1583
1792
|
return data, status_code, headers
|
|
1584
1793
|
end
|
|
@@ -1590,8 +1799,8 @@ module ApiSdkRb
|
|
|
1590
1799
|
# @option opts [String] :x_managed_user_id 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.
|
|
1591
1800
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1592
1801
|
# @return [GetCompositionDataSourceResponse]
|
|
1593
|
-
def
|
|
1594
|
-
data, _status_code, _headers =
|
|
1802
|
+
def get_composition_data_source(id, opts = {})
|
|
1803
|
+
data, _status_code, _headers = get_composition_data_source_with_http_info(id, opts)
|
|
1595
1804
|
data
|
|
1596
1805
|
end
|
|
1597
1806
|
|
|
@@ -1602,20 +1811,20 @@ module ApiSdkRb
|
|
|
1602
1811
|
# @option opts [String] :x_managed_user_id 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.
|
|
1603
1812
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1604
1813
|
# @return [Array<(GetCompositionDataSourceResponse, Integer, Hash)>] GetCompositionDataSourceResponse data, response status code and response headers
|
|
1605
|
-
def
|
|
1814
|
+
def get_composition_data_source_with_http_info(id, opts = {})
|
|
1606
1815
|
if @api_client.config.debugging
|
|
1607
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1816
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_data_source ...'
|
|
1608
1817
|
end
|
|
1609
1818
|
# verify the required parameter 'id' is set
|
|
1610
1819
|
if @api_client.config.client_side_validation && id.nil?
|
|
1611
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1820
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_data_source"
|
|
1612
1821
|
end
|
|
1613
1822
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1614
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1823
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_data_source, the character length must be smaller than or equal to 255.'
|
|
1615
1824
|
end
|
|
1616
1825
|
|
|
1617
1826
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1618
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1827
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_data_source, the character length must be great than or equal to 1.'
|
|
1619
1828
|
end
|
|
1620
1829
|
|
|
1621
1830
|
# resource path
|
|
@@ -1644,7 +1853,7 @@ module ApiSdkRb
|
|
|
1644
1853
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1645
1854
|
|
|
1646
1855
|
new_options = opts.merge(
|
|
1647
|
-
:operation => :"CompositionsApi.
|
|
1856
|
+
:operation => :"CompositionsApi.get_composition_data_source",
|
|
1648
1857
|
:header_params => header_params,
|
|
1649
1858
|
:query_params => query_params,
|
|
1650
1859
|
:form_params => form_params,
|
|
@@ -1655,7 +1864,7 @@ module ApiSdkRb
|
|
|
1655
1864
|
|
|
1656
1865
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1657
1866
|
if @api_client.config.debugging
|
|
1658
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1867
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1659
1868
|
end
|
|
1660
1869
|
return data, status_code, headers
|
|
1661
1870
|
end
|
|
@@ -1668,9 +1877,9 @@ module ApiSdkRb
|
|
|
1668
1877
|
# @param [Hash] opts the optional parameters
|
|
1669
1878
|
# @option opts [String] :x_managed_user_id 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.
|
|
1670
1879
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1671
|
-
# @return [
|
|
1672
|
-
def
|
|
1673
|
-
data, _status_code, _headers =
|
|
1880
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
1881
|
+
def get_composition_database_record(id, table, record_id, opts = {})
|
|
1882
|
+
data, _status_code, _headers = get_composition_database_record_with_http_info(id, table, record_id, opts)
|
|
1674
1883
|
data
|
|
1675
1884
|
end
|
|
1676
1885
|
|
|
@@ -1682,29 +1891,29 @@ module ApiSdkRb
|
|
|
1682
1891
|
# @param [Hash] opts the optional parameters
|
|
1683
1892
|
# @option opts [String] :x_managed_user_id 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.
|
|
1684
1893
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1685
|
-
# @return [Array<(
|
|
1686
|
-
def
|
|
1894
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
1895
|
+
def get_composition_database_record_with_http_info(id, table, record_id, opts = {})
|
|
1687
1896
|
if @api_client.config.debugging
|
|
1688
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1897
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_database_record ...'
|
|
1689
1898
|
end
|
|
1690
1899
|
# verify the required parameter 'id' is set
|
|
1691
1900
|
if @api_client.config.client_side_validation && id.nil?
|
|
1692
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1901
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_database_record"
|
|
1693
1902
|
end
|
|
1694
1903
|
# verify the required parameter 'table' is set
|
|
1695
1904
|
if @api_client.config.client_side_validation && table.nil?
|
|
1696
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
1905
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.get_composition_database_record"
|
|
1697
1906
|
end
|
|
1698
1907
|
# verify the required parameter 'record_id' is set
|
|
1699
1908
|
if @api_client.config.client_side_validation && record_id.nil?
|
|
1700
|
-
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.
|
|
1909
|
+
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.get_composition_database_record"
|
|
1701
1910
|
end
|
|
1702
1911
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1703
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1912
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
1704
1913
|
end
|
|
1705
1914
|
|
|
1706
1915
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1707
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1916
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_record, the character length must be great than or equal to 1.'
|
|
1708
1917
|
end
|
|
1709
1918
|
|
|
1710
1919
|
# resource path
|
|
@@ -1727,13 +1936,13 @@ module ApiSdkRb
|
|
|
1727
1936
|
post_body = opts[:debug_body]
|
|
1728
1937
|
|
|
1729
1938
|
# return_type
|
|
1730
|
-
return_type = opts[:debug_return_type] || '
|
|
1939
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
1731
1940
|
|
|
1732
1941
|
# auth_names
|
|
1733
1942
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1734
1943
|
|
|
1735
1944
|
new_options = opts.merge(
|
|
1736
|
-
:operation => :"CompositionsApi.
|
|
1945
|
+
:operation => :"CompositionsApi.get_composition_database_record",
|
|
1737
1946
|
:header_params => header_params,
|
|
1738
1947
|
:query_params => query_params,
|
|
1739
1948
|
:form_params => form_params,
|
|
@@ -1744,7 +1953,7 @@ module ApiSdkRb
|
|
|
1744
1953
|
|
|
1745
1954
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1746
1955
|
if @api_client.config.debugging
|
|
1747
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
1956
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1748
1957
|
end
|
|
1749
1958
|
return data, status_code, headers
|
|
1750
1959
|
end
|
|
@@ -1757,8 +1966,8 @@ module ApiSdkRb
|
|
|
1757
1966
|
# @option opts [String] :x_managed_user_id 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.
|
|
1758
1967
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1759
1968
|
# @return [GetCompositionDatabaseRecords200Response]
|
|
1760
|
-
def
|
|
1761
|
-
data, _status_code, _headers =
|
|
1969
|
+
def get_composition_database_records(id, table, opts = {})
|
|
1970
|
+
data, _status_code, _headers = get_composition_database_records_with_http_info(id, table, opts)
|
|
1762
1971
|
data
|
|
1763
1972
|
end
|
|
1764
1973
|
|
|
@@ -1770,24 +1979,24 @@ module ApiSdkRb
|
|
|
1770
1979
|
# @option opts [String] :x_managed_user_id 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.
|
|
1771
1980
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1772
1981
|
# @return [Array<(GetCompositionDatabaseRecords200Response, Integer, Hash)>] GetCompositionDatabaseRecords200Response data, response status code and response headers
|
|
1773
|
-
def
|
|
1982
|
+
def get_composition_database_records_with_http_info(id, table, opts = {})
|
|
1774
1983
|
if @api_client.config.debugging
|
|
1775
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
1984
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_database_records ...'
|
|
1776
1985
|
end
|
|
1777
1986
|
# verify the required parameter 'id' is set
|
|
1778
1987
|
if @api_client.config.client_side_validation && id.nil?
|
|
1779
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
1988
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_database_records"
|
|
1780
1989
|
end
|
|
1781
1990
|
# verify the required parameter 'table' is set
|
|
1782
1991
|
if @api_client.config.client_side_validation && table.nil?
|
|
1783
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
1992
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.get_composition_database_records"
|
|
1784
1993
|
end
|
|
1785
1994
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1786
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1995
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_records, the character length must be smaller than or equal to 255.'
|
|
1787
1996
|
end
|
|
1788
1997
|
|
|
1789
1998
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1790
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
1999
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_database_records, the character length must be great than or equal to 1.'
|
|
1791
2000
|
end
|
|
1792
2001
|
|
|
1793
2002
|
# resource path
|
|
@@ -1816,7 +2025,7 @@ module ApiSdkRb
|
|
|
1816
2025
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1817
2026
|
|
|
1818
2027
|
new_options = opts.merge(
|
|
1819
|
-
:operation => :"CompositionsApi.
|
|
2028
|
+
:operation => :"CompositionsApi.get_composition_database_records",
|
|
1820
2029
|
:header_params => header_params,
|
|
1821
2030
|
:query_params => query_params,
|
|
1822
2031
|
:form_params => form_params,
|
|
@@ -1827,7 +2036,7 @@ module ApiSdkRb
|
|
|
1827
2036
|
|
|
1828
2037
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1829
2038
|
if @api_client.config.debugging
|
|
1830
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2039
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_database_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1831
2040
|
end
|
|
1832
2041
|
return data, status_code, headers
|
|
1833
2042
|
end
|
|
@@ -1839,8 +2048,8 @@ module ApiSdkRb
|
|
|
1839
2048
|
# @option opts [String] :x_managed_user_id 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.
|
|
1840
2049
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1841
2050
|
# @return [GetCompositionDesignResponse]
|
|
1842
|
-
def
|
|
1843
|
-
data, _status_code, _headers =
|
|
2051
|
+
def get_composition_design(id, opts = {})
|
|
2052
|
+
data, _status_code, _headers = get_composition_design_with_http_info(id, opts)
|
|
1844
2053
|
data
|
|
1845
2054
|
end
|
|
1846
2055
|
|
|
@@ -1851,20 +2060,20 @@ module ApiSdkRb
|
|
|
1851
2060
|
# @option opts [String] :x_managed_user_id 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.
|
|
1852
2061
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1853
2062
|
# @return [Array<(GetCompositionDesignResponse, Integer, Hash)>] GetCompositionDesignResponse data, response status code and response headers
|
|
1854
|
-
def
|
|
2063
|
+
def get_composition_design_with_http_info(id, opts = {})
|
|
1855
2064
|
if @api_client.config.debugging
|
|
1856
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2065
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_design ...'
|
|
1857
2066
|
end
|
|
1858
2067
|
# verify the required parameter 'id' is set
|
|
1859
2068
|
if @api_client.config.client_side_validation && id.nil?
|
|
1860
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2069
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_design"
|
|
1861
2070
|
end
|
|
1862
2071
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1863
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2072
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design, the character length must be smaller than or equal to 255.'
|
|
1864
2073
|
end
|
|
1865
2074
|
|
|
1866
2075
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1867
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2076
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design, the character length must be great than or equal to 1.'
|
|
1868
2077
|
end
|
|
1869
2078
|
|
|
1870
2079
|
# resource path
|
|
@@ -1893,7 +2102,7 @@ module ApiSdkRb
|
|
|
1893
2102
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1894
2103
|
|
|
1895
2104
|
new_options = opts.merge(
|
|
1896
|
-
:operation => :"CompositionsApi.
|
|
2105
|
+
:operation => :"CompositionsApi.get_composition_design",
|
|
1897
2106
|
:header_params => header_params,
|
|
1898
2107
|
:query_params => query_params,
|
|
1899
2108
|
:form_params => form_params,
|
|
@@ -1904,7 +2113,7 @@ module ApiSdkRb
|
|
|
1904
2113
|
|
|
1905
2114
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1906
2115
|
if @api_client.config.debugging
|
|
1907
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2116
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_design\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1908
2117
|
end
|
|
1909
2118
|
return data, status_code, headers
|
|
1910
2119
|
end
|
|
@@ -1916,8 +2125,8 @@ module ApiSdkRb
|
|
|
1916
2125
|
# @option opts [String] :x_managed_user_id 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.
|
|
1917
2126
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1918
2127
|
# @return [GetCompositionDesignSchemaResponse]
|
|
1919
|
-
def
|
|
1920
|
-
data, _status_code, _headers =
|
|
2128
|
+
def get_composition_design_schema(id, opts = {})
|
|
2129
|
+
data, _status_code, _headers = get_composition_design_schema_with_http_info(id, opts)
|
|
1921
2130
|
data
|
|
1922
2131
|
end
|
|
1923
2132
|
|
|
@@ -1928,20 +2137,20 @@ module ApiSdkRb
|
|
|
1928
2137
|
# @option opts [String] :x_managed_user_id 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.
|
|
1929
2138
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1930
2139
|
# @return [Array<(GetCompositionDesignSchemaResponse, Integer, Hash)>] GetCompositionDesignSchemaResponse data, response status code and response headers
|
|
1931
|
-
def
|
|
2140
|
+
def get_composition_design_schema_with_http_info(id, opts = {})
|
|
1932
2141
|
if @api_client.config.debugging
|
|
1933
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2142
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_design_schema ...'
|
|
1934
2143
|
end
|
|
1935
2144
|
# verify the required parameter 'id' is set
|
|
1936
2145
|
if @api_client.config.client_side_validation && id.nil?
|
|
1937
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2146
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_design_schema"
|
|
1938
2147
|
end
|
|
1939
2148
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
1940
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2149
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design_schema, the character length must be smaller than or equal to 255.'
|
|
1941
2150
|
end
|
|
1942
2151
|
|
|
1943
2152
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
1944
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2153
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_design_schema, the character length must be great than or equal to 1.'
|
|
1945
2154
|
end
|
|
1946
2155
|
|
|
1947
2156
|
# resource path
|
|
@@ -1970,7 +2179,7 @@ module ApiSdkRb
|
|
|
1970
2179
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
1971
2180
|
|
|
1972
2181
|
new_options = opts.merge(
|
|
1973
|
-
:operation => :"CompositionsApi.
|
|
2182
|
+
:operation => :"CompositionsApi.get_composition_design_schema",
|
|
1974
2183
|
:header_params => header_params,
|
|
1975
2184
|
:query_params => query_params,
|
|
1976
2185
|
:form_params => form_params,
|
|
@@ -1981,7 +2190,7 @@ module ApiSdkRb
|
|
|
1981
2190
|
|
|
1982
2191
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1983
2192
|
if @api_client.config.debugging
|
|
1984
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2193
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_design_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1985
2194
|
end
|
|
1986
2195
|
return data, status_code, headers
|
|
1987
2196
|
end
|
|
@@ -1993,8 +2202,8 @@ module ApiSdkRb
|
|
|
1993
2202
|
# @option opts [String] :x_managed_user_id 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.
|
|
1994
2203
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
1995
2204
|
# @return [GetCompositionEmbedSchemaResponse]
|
|
1996
|
-
def
|
|
1997
|
-
data, _status_code, _headers =
|
|
2205
|
+
def get_composition_embed_schema(id, opts = {})
|
|
2206
|
+
data, _status_code, _headers = get_composition_embed_schema_with_http_info(id, opts)
|
|
1998
2207
|
data
|
|
1999
2208
|
end
|
|
2000
2209
|
|
|
@@ -2005,20 +2214,20 @@ module ApiSdkRb
|
|
|
2005
2214
|
# @option opts [String] :x_managed_user_id 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.
|
|
2006
2215
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2007
2216
|
# @return [Array<(GetCompositionEmbedSchemaResponse, Integer, Hash)>] GetCompositionEmbedSchemaResponse data, response status code and response headers
|
|
2008
|
-
def
|
|
2217
|
+
def get_composition_embed_schema_with_http_info(id, opts = {})
|
|
2009
2218
|
if @api_client.config.debugging
|
|
2010
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2219
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_embed_schema ...'
|
|
2011
2220
|
end
|
|
2012
2221
|
# verify the required parameter 'id' is set
|
|
2013
2222
|
if @api_client.config.client_side_validation && id.nil?
|
|
2014
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2223
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_embed_schema"
|
|
2015
2224
|
end
|
|
2016
2225
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2017
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2226
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_schema, the character length must be smaller than or equal to 255.'
|
|
2018
2227
|
end
|
|
2019
2228
|
|
|
2020
2229
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2021
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2230
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_schema, the character length must be great than or equal to 1.'
|
|
2022
2231
|
end
|
|
2023
2232
|
|
|
2024
2233
|
# resource path
|
|
@@ -2047,7 +2256,7 @@ module ApiSdkRb
|
|
|
2047
2256
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2048
2257
|
|
|
2049
2258
|
new_options = opts.merge(
|
|
2050
|
-
:operation => :"CompositionsApi.
|
|
2259
|
+
:operation => :"CompositionsApi.get_composition_embed_schema",
|
|
2051
2260
|
:header_params => header_params,
|
|
2052
2261
|
:query_params => query_params,
|
|
2053
2262
|
:form_params => form_params,
|
|
@@ -2058,7 +2267,7 @@ module ApiSdkRb
|
|
|
2058
2267
|
|
|
2059
2268
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2060
2269
|
if @api_client.config.debugging
|
|
2061
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2270
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_embed_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2062
2271
|
end
|
|
2063
2272
|
return data, status_code, headers
|
|
2064
2273
|
end
|
|
@@ -2070,8 +2279,8 @@ module ApiSdkRb
|
|
|
2070
2279
|
# @option opts [String] :x_managed_user_id 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.
|
|
2071
2280
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2072
2281
|
# @return [GetCompositionEmbedSettingsResponse]
|
|
2073
|
-
def
|
|
2074
|
-
data, _status_code, _headers =
|
|
2282
|
+
def get_composition_embed_settings(id, opts = {})
|
|
2283
|
+
data, _status_code, _headers = get_composition_embed_settings_with_http_info(id, opts)
|
|
2075
2284
|
data
|
|
2076
2285
|
end
|
|
2077
2286
|
|
|
@@ -2082,20 +2291,20 @@ module ApiSdkRb
|
|
|
2082
2291
|
# @option opts [String] :x_managed_user_id 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.
|
|
2083
2292
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2084
2293
|
# @return [Array<(GetCompositionEmbedSettingsResponse, Integer, Hash)>] GetCompositionEmbedSettingsResponse data, response status code and response headers
|
|
2085
|
-
def
|
|
2294
|
+
def get_composition_embed_settings_with_http_info(id, opts = {})
|
|
2086
2295
|
if @api_client.config.debugging
|
|
2087
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2296
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_embed_settings ...'
|
|
2088
2297
|
end
|
|
2089
2298
|
# verify the required parameter 'id' is set
|
|
2090
2299
|
if @api_client.config.client_side_validation && id.nil?
|
|
2091
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2300
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_embed_settings"
|
|
2092
2301
|
end
|
|
2093
2302
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2094
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2303
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_settings, the character length must be smaller than or equal to 255.'
|
|
2095
2304
|
end
|
|
2096
2305
|
|
|
2097
2306
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2098
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2307
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_embed_settings, the character length must be great than or equal to 1.'
|
|
2099
2308
|
end
|
|
2100
2309
|
|
|
2101
2310
|
# resource path
|
|
@@ -2124,7 +2333,7 @@ module ApiSdkRb
|
|
|
2124
2333
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2125
2334
|
|
|
2126
2335
|
new_options = opts.merge(
|
|
2127
|
-
:operation => :"CompositionsApi.
|
|
2336
|
+
:operation => :"CompositionsApi.get_composition_embed_settings",
|
|
2128
2337
|
:header_params => header_params,
|
|
2129
2338
|
:query_params => query_params,
|
|
2130
2339
|
:form_params => form_params,
|
|
@@ -2135,7 +2344,7 @@ module ApiSdkRb
|
|
|
2135
2344
|
|
|
2136
2345
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2137
2346
|
if @api_client.config.debugging
|
|
2138
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2347
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_embed_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2139
2348
|
end
|
|
2140
2349
|
return data, status_code, headers
|
|
2141
2350
|
end
|
|
@@ -2147,8 +2356,8 @@ module ApiSdkRb
|
|
|
2147
2356
|
# @option opts [String] :x_managed_user_id 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.
|
|
2148
2357
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2149
2358
|
# @return [GetCompositionPreviewResponse]
|
|
2150
|
-
def
|
|
2151
|
-
data, _status_code, _headers =
|
|
2359
|
+
def get_composition_preview(id, opts = {})
|
|
2360
|
+
data, _status_code, _headers = get_composition_preview_with_http_info(id, opts)
|
|
2152
2361
|
data
|
|
2153
2362
|
end
|
|
2154
2363
|
|
|
@@ -2159,20 +2368,20 @@ module ApiSdkRb
|
|
|
2159
2368
|
# @option opts [String] :x_managed_user_id 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.
|
|
2160
2369
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2161
2370
|
# @return [Array<(GetCompositionPreviewResponse, Integer, Hash)>] GetCompositionPreviewResponse data, response status code and response headers
|
|
2162
|
-
def
|
|
2371
|
+
def get_composition_preview_with_http_info(id, opts = {})
|
|
2163
2372
|
if @api_client.config.debugging
|
|
2164
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2373
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_preview ...'
|
|
2165
2374
|
end
|
|
2166
2375
|
# verify the required parameter 'id' is set
|
|
2167
2376
|
if @api_client.config.client_side_validation && id.nil?
|
|
2168
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2377
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_preview"
|
|
2169
2378
|
end
|
|
2170
2379
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2171
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2380
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_preview, the character length must be smaller than or equal to 255.'
|
|
2172
2381
|
end
|
|
2173
2382
|
|
|
2174
2383
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2175
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2384
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_preview, the character length must be great than or equal to 1.'
|
|
2176
2385
|
end
|
|
2177
2386
|
|
|
2178
2387
|
# resource path
|
|
@@ -2201,7 +2410,7 @@ module ApiSdkRb
|
|
|
2201
2410
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2202
2411
|
|
|
2203
2412
|
new_options = opts.merge(
|
|
2204
|
-
:operation => :"CompositionsApi.
|
|
2413
|
+
:operation => :"CompositionsApi.get_composition_preview",
|
|
2205
2414
|
:header_params => header_params,
|
|
2206
2415
|
:query_params => query_params,
|
|
2207
2416
|
:form_params => form_params,
|
|
@@ -2212,7 +2421,7 @@ module ApiSdkRb
|
|
|
2212
2421
|
|
|
2213
2422
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2214
2423
|
if @api_client.config.debugging
|
|
2215
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2424
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2216
2425
|
end
|
|
2217
2426
|
return data, status_code, headers
|
|
2218
2427
|
end
|
|
@@ -2224,8 +2433,8 @@ module ApiSdkRb
|
|
|
2224
2433
|
# @option opts [String] :x_managed_user_id 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.
|
|
2225
2434
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2226
2435
|
# @return [GetCompositionVersions200Response]
|
|
2227
|
-
def
|
|
2228
|
-
data, _status_code, _headers =
|
|
2436
|
+
def get_composition_versions(id, opts = {})
|
|
2437
|
+
data, _status_code, _headers = get_composition_versions_with_http_info(id, opts)
|
|
2229
2438
|
data
|
|
2230
2439
|
end
|
|
2231
2440
|
|
|
@@ -2236,20 +2445,20 @@ module ApiSdkRb
|
|
|
2236
2445
|
# @option opts [String] :x_managed_user_id 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.
|
|
2237
2446
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2238
2447
|
# @return [Array<(GetCompositionVersions200Response, Integer, Hash)>] GetCompositionVersions200Response data, response status code and response headers
|
|
2239
|
-
def
|
|
2448
|
+
def get_composition_versions_with_http_info(id, opts = {})
|
|
2240
2449
|
if @api_client.config.debugging
|
|
2241
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2450
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_composition_versions ...'
|
|
2242
2451
|
end
|
|
2243
2452
|
# verify the required parameter 'id' is set
|
|
2244
2453
|
if @api_client.config.client_side_validation && id.nil?
|
|
2245
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2454
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.get_composition_versions"
|
|
2246
2455
|
end
|
|
2247
2456
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2248
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2457
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_versions, the character length must be smaller than or equal to 255.'
|
|
2249
2458
|
end
|
|
2250
2459
|
|
|
2251
2460
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2252
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2461
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.get_composition_versions, the character length must be great than or equal to 1.'
|
|
2253
2462
|
end
|
|
2254
2463
|
|
|
2255
2464
|
# resource path
|
|
@@ -2278,7 +2487,7 @@ module ApiSdkRb
|
|
|
2278
2487
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2279
2488
|
|
|
2280
2489
|
new_options = opts.merge(
|
|
2281
|
-
:operation => :"CompositionsApi.
|
|
2490
|
+
:operation => :"CompositionsApi.get_composition_versions",
|
|
2282
2491
|
:header_params => header_params,
|
|
2283
2492
|
:query_params => query_params,
|
|
2284
2493
|
:form_params => form_params,
|
|
@@ -2289,7 +2498,7 @@ module ApiSdkRb
|
|
|
2289
2498
|
|
|
2290
2499
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2291
2500
|
if @api_client.config.debugging
|
|
2292
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2501
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_composition_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2293
2502
|
end
|
|
2294
2503
|
return data, status_code, headers
|
|
2295
2504
|
end
|
|
@@ -2299,8 +2508,8 @@ module ApiSdkRb
|
|
|
2299
2508
|
# @param get_compositions_batch_request [GetCompositionsBatchRequest]
|
|
2300
2509
|
# @param [Hash] opts the optional parameters
|
|
2301
2510
|
# @return [GetCompositionsBatchResponse]
|
|
2302
|
-
def
|
|
2303
|
-
data, _status_code, _headers =
|
|
2511
|
+
def get_compositions_batch(get_compositions_batch_request, opts = {})
|
|
2512
|
+
data, _status_code, _headers = get_compositions_batch_with_http_info(get_compositions_batch_request, opts)
|
|
2304
2513
|
data
|
|
2305
2514
|
end
|
|
2306
2515
|
|
|
@@ -2309,13 +2518,13 @@ module ApiSdkRb
|
|
|
2309
2518
|
# @param get_compositions_batch_request [GetCompositionsBatchRequest]
|
|
2310
2519
|
# @param [Hash] opts the optional parameters
|
|
2311
2520
|
# @return [Array<(GetCompositionsBatchResponse, Integer, Hash)>] GetCompositionsBatchResponse data, response status code and response headers
|
|
2312
|
-
def
|
|
2521
|
+
def get_compositions_batch_with_http_info(get_compositions_batch_request, opts = {})
|
|
2313
2522
|
if @api_client.config.debugging
|
|
2314
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2523
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.get_compositions_batch ...'
|
|
2315
2524
|
end
|
|
2316
2525
|
# verify the required parameter 'get_compositions_batch_request' is set
|
|
2317
2526
|
if @api_client.config.client_side_validation && get_compositions_batch_request.nil?
|
|
2318
|
-
fail ArgumentError, "Missing the required parameter 'get_compositions_batch_request' when calling CompositionsApi.
|
|
2527
|
+
fail ArgumentError, "Missing the required parameter 'get_compositions_batch_request' when calling CompositionsApi.get_compositions_batch"
|
|
2319
2528
|
end
|
|
2320
2529
|
# resource path
|
|
2321
2530
|
local_var_path = '/compositions/batch'
|
|
@@ -2346,7 +2555,7 @@ module ApiSdkRb
|
|
|
2346
2555
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2347
2556
|
|
|
2348
2557
|
new_options = opts.merge(
|
|
2349
|
-
:operation => :"CompositionsApi.
|
|
2558
|
+
:operation => :"CompositionsApi.get_compositions_batch",
|
|
2350
2559
|
:header_params => header_params,
|
|
2351
2560
|
:query_params => query_params,
|
|
2352
2561
|
:form_params => form_params,
|
|
@@ -2357,7 +2566,127 @@ module ApiSdkRb
|
|
|
2357
2566
|
|
|
2358
2567
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
2359
2568
|
if @api_client.config.debugging
|
|
2360
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2569
|
+
@api_client.config.logger.debug "API called: CompositionsApi#get_compositions_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2570
|
+
end
|
|
2571
|
+
return data, status_code, headers
|
|
2572
|
+
end
|
|
2573
|
+
|
|
2574
|
+
# List composition entry items with paging and filters
|
|
2575
|
+
# 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.
|
|
2576
|
+
# @param id [String]
|
|
2577
|
+
# @param table [String]
|
|
2578
|
+
# @param [Hash] opts the optional parameters
|
|
2579
|
+
# @option opts [Integer] :limit (default to 25)
|
|
2580
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
2581
|
+
# @option opts [Time] :since 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`.
|
|
2582
|
+
# @option opts [Time] :_until 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`).
|
|
2583
|
+
# @option opts [String] :cursor
|
|
2584
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
2585
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
2586
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2587
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2588
|
+
# @return [CompositionEntryItemsPageSuccess]
|
|
2589
|
+
def list_composition_entry_items(id, table, opts = {})
|
|
2590
|
+
data, _status_code, _headers = list_composition_entry_items_with_http_info(id, table, opts)
|
|
2591
|
+
data
|
|
2592
|
+
end
|
|
2593
|
+
|
|
2594
|
+
# List composition entry items with paging and filters
|
|
2595
|
+
# 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.
|
|
2596
|
+
# @param id [String]
|
|
2597
|
+
# @param table [String]
|
|
2598
|
+
# @param [Hash] opts the optional parameters
|
|
2599
|
+
# @option opts [Integer] :limit (default to 25)
|
|
2600
|
+
# @option opts [String] :order `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. (default to 'desc')
|
|
2601
|
+
# @option opts [Time] :since 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`.
|
|
2602
|
+
# @option opts [Time] :_until 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`).
|
|
2603
|
+
# @option opts [String] :cursor
|
|
2604
|
+
# @option opts [Hash<String, String>] :context 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.
|
|
2605
|
+
# @option opts [Hash<String, String>] :filter 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`.
|
|
2606
|
+
# @option opts [String] :x_managed_user_id 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.
|
|
2607
|
+
# @option opts [String] :x_managed_user_external_id 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.
|
|
2608
|
+
# @return [Array<(CompositionEntryItemsPageSuccess, Integer, Hash)>] CompositionEntryItemsPageSuccess data, response status code and response headers
|
|
2609
|
+
def list_composition_entry_items_with_http_info(id, table, opts = {})
|
|
2610
|
+
if @api_client.config.debugging
|
|
2611
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.list_composition_entry_items ...'
|
|
2612
|
+
end
|
|
2613
|
+
# verify the required parameter 'id' is set
|
|
2614
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
2615
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.list_composition_entry_items"
|
|
2616
|
+
end
|
|
2617
|
+
# verify the required parameter 'table' is set
|
|
2618
|
+
if @api_client.config.client_side_validation && table.nil?
|
|
2619
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.list_composition_entry_items"
|
|
2620
|
+
end
|
|
2621
|
+
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
2622
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.list_composition_entry_items, the character length must be smaller than or equal to 63.'
|
|
2623
|
+
end
|
|
2624
|
+
|
|
2625
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
2626
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompositionsApi.list_composition_entry_items, must be smaller than or equal to 100.'
|
|
2627
|
+
end
|
|
2628
|
+
|
|
2629
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
2630
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling CompositionsApi.list_composition_entry_items, must be greater than or equal to 1.'
|
|
2631
|
+
end
|
|
2632
|
+
|
|
2633
|
+
allowable_values = ["asc", "desc"]
|
|
2634
|
+
if @api_client.config.client_side_validation && opts[:'order'] && !allowable_values.include?(opts[:'order'])
|
|
2635
|
+
fail ArgumentError, "invalid value for \"order\", must be one of #{allowable_values}"
|
|
2636
|
+
end
|
|
2637
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2638
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.list_composition_entry_items, the character length must be smaller than or equal to 255.'
|
|
2639
|
+
end
|
|
2640
|
+
|
|
2641
|
+
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2642
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.list_composition_entry_items, the character length must be great than or equal to 1.'
|
|
2643
|
+
end
|
|
2644
|
+
|
|
2645
|
+
# resource path
|
|
2646
|
+
local_var_path = '/compositions/{id}/entries/{table}/items'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'table' + '}', CGI.escape(table.to_s))
|
|
2647
|
+
|
|
2648
|
+
# query parameters
|
|
2649
|
+
query_params = opts[:query_params] || {}
|
|
2650
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
2651
|
+
query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
|
|
2652
|
+
query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
|
|
2653
|
+
query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
|
|
2654
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
2655
|
+
query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
|
|
2656
|
+
query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
|
|
2657
|
+
|
|
2658
|
+
# header parameters
|
|
2659
|
+
header_params = opts[:header_params] || {}
|
|
2660
|
+
# HTTP header 'Accept' (if needed)
|
|
2661
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
2662
|
+
header_params[:'X-Managed-User-Id'] = opts[:'x_managed_user_id'] if !opts[:'x_managed_user_id'].nil?
|
|
2663
|
+
header_params[:'X-Managed-User-External-Id'] = opts[:'x_managed_user_external_id'] if !opts[:'x_managed_user_external_id'].nil?
|
|
2664
|
+
|
|
2665
|
+
# form parameters
|
|
2666
|
+
form_params = opts[:form_params] || {}
|
|
2667
|
+
|
|
2668
|
+
# http body (model)
|
|
2669
|
+
post_body = opts[:debug_body]
|
|
2670
|
+
|
|
2671
|
+
# return_type
|
|
2672
|
+
return_type = opts[:debug_return_type] || 'CompositionEntryItemsPageSuccess'
|
|
2673
|
+
|
|
2674
|
+
# auth_names
|
|
2675
|
+
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2676
|
+
|
|
2677
|
+
new_options = opts.merge(
|
|
2678
|
+
:operation => :"CompositionsApi.list_composition_entry_items",
|
|
2679
|
+
:header_params => header_params,
|
|
2680
|
+
:query_params => query_params,
|
|
2681
|
+
:form_params => form_params,
|
|
2682
|
+
:body => post_body,
|
|
2683
|
+
:auth_names => auth_names,
|
|
2684
|
+
:return_type => return_type
|
|
2685
|
+
)
|
|
2686
|
+
|
|
2687
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2688
|
+
if @api_client.config.debugging
|
|
2689
|
+
@api_client.config.logger.debug "API called: CompositionsApi#list_composition_entry_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2361
2690
|
end
|
|
2362
2691
|
return data, status_code, headers
|
|
2363
2692
|
end
|
|
@@ -2372,9 +2701,9 @@ module ApiSdkRb
|
|
|
2372
2701
|
# @option opts [String] :if_match
|
|
2373
2702
|
# @option opts [String] :x_managed_user_id 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.
|
|
2374
2703
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2375
|
-
# @return [
|
|
2376
|
-
def
|
|
2377
|
-
data, _status_code, _headers =
|
|
2704
|
+
# @return [ContentItemWriteResultResponse]
|
|
2705
|
+
def patch_composition_content_item(id, list, item_id, idempotency_key, request_body, opts = {})
|
|
2706
|
+
data, _status_code, _headers = patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts)
|
|
2378
2707
|
data
|
|
2379
2708
|
end
|
|
2380
2709
|
|
|
@@ -2388,50 +2717,50 @@ module ApiSdkRb
|
|
|
2388
2717
|
# @option opts [String] :if_match
|
|
2389
2718
|
# @option opts [String] :x_managed_user_id 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.
|
|
2390
2719
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2391
|
-
# @return [Array<(
|
|
2392
|
-
def
|
|
2720
|
+
# @return [Array<(ContentItemWriteResultResponse, Integer, Hash)>] ContentItemWriteResultResponse data, response status code and response headers
|
|
2721
|
+
def patch_composition_content_item_with_http_info(id, list, item_id, idempotency_key, request_body, opts = {})
|
|
2393
2722
|
if @api_client.config.debugging
|
|
2394
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2723
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.patch_composition_content_item ...'
|
|
2395
2724
|
end
|
|
2396
2725
|
# verify the required parameter 'id' is set
|
|
2397
2726
|
if @api_client.config.client_side_validation && id.nil?
|
|
2398
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2727
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.patch_composition_content_item"
|
|
2399
2728
|
end
|
|
2400
2729
|
# verify the required parameter 'list' is set
|
|
2401
2730
|
if @api_client.config.client_side_validation && list.nil?
|
|
2402
|
-
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.
|
|
2731
|
+
fail ArgumentError, "Missing the required parameter 'list' when calling CompositionsApi.patch_composition_content_item"
|
|
2403
2732
|
end
|
|
2404
2733
|
# verify the required parameter 'item_id' is set
|
|
2405
2734
|
if @api_client.config.client_side_validation && item_id.nil?
|
|
2406
|
-
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.
|
|
2735
|
+
fail ArgumentError, "Missing the required parameter 'item_id' when calling CompositionsApi.patch_composition_content_item"
|
|
2407
2736
|
end
|
|
2408
2737
|
# verify the required parameter 'idempotency_key' is set
|
|
2409
2738
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2410
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
2739
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.patch_composition_content_item"
|
|
2411
2740
|
end
|
|
2412
2741
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2413
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
2742
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.patch_composition_content_item, the character length must be smaller than or equal to 50.'
|
|
2414
2743
|
end
|
|
2415
2744
|
|
|
2416
2745
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2417
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
2746
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.patch_composition_content_item, the character length must be great than or equal to 8.'
|
|
2418
2747
|
end
|
|
2419
2748
|
|
|
2420
2749
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2421
2750
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2422
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
2751
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.patch_composition_content_item, must conform to the pattern #{pattern}."
|
|
2423
2752
|
end
|
|
2424
2753
|
|
|
2425
2754
|
# verify the required parameter 'request_body' is set
|
|
2426
2755
|
if @api_client.config.client_side_validation && request_body.nil?
|
|
2427
|
-
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.
|
|
2756
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.patch_composition_content_item"
|
|
2428
2757
|
end
|
|
2429
2758
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2430
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2759
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.patch_composition_content_item, the character length must be smaller than or equal to 255.'
|
|
2431
2760
|
end
|
|
2432
2761
|
|
|
2433
2762
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2434
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2763
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.patch_composition_content_item, the character length must be great than or equal to 1.'
|
|
2435
2764
|
end
|
|
2436
2765
|
|
|
2437
2766
|
# resource path
|
|
@@ -2461,13 +2790,13 @@ module ApiSdkRb
|
|
|
2461
2790
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
|
|
2462
2791
|
|
|
2463
2792
|
# return_type
|
|
2464
|
-
return_type = opts[:debug_return_type] || '
|
|
2793
|
+
return_type = opts[:debug_return_type] || 'ContentItemWriteResultResponse'
|
|
2465
2794
|
|
|
2466
2795
|
# auth_names
|
|
2467
2796
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2468
2797
|
|
|
2469
2798
|
new_options = opts.merge(
|
|
2470
|
-
:operation => :"CompositionsApi.
|
|
2799
|
+
:operation => :"CompositionsApi.patch_composition_content_item",
|
|
2471
2800
|
:header_params => header_params,
|
|
2472
2801
|
:query_params => query_params,
|
|
2473
2802
|
:form_params => form_params,
|
|
@@ -2478,7 +2807,7 @@ module ApiSdkRb
|
|
|
2478
2807
|
|
|
2479
2808
|
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
2480
2809
|
if @api_client.config.debugging
|
|
2481
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2810
|
+
@api_client.config.logger.debug "API called: CompositionsApi#patch_composition_content_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2482
2811
|
end
|
|
2483
2812
|
return data, status_code, headers
|
|
2484
2813
|
end
|
|
@@ -2499,8 +2828,8 @@ module ApiSdkRb
|
|
|
2499
2828
|
# @option opts [String] :x_managed_user_id 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.
|
|
2500
2829
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2501
2830
|
# @return [CompositionEntriesReadingResponse]
|
|
2502
|
-
def
|
|
2503
|
-
data, _status_code, _headers =
|
|
2831
|
+
def read_composition_entries(id, table, opts = {})
|
|
2832
|
+
data, _status_code, _headers = read_composition_entries_with_http_info(id, table, opts)
|
|
2504
2833
|
data
|
|
2505
2834
|
end
|
|
2506
2835
|
|
|
@@ -2520,48 +2849,48 @@ module ApiSdkRb
|
|
|
2520
2849
|
# @option opts [String] :x_managed_user_id 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.
|
|
2521
2850
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2522
2851
|
# @return [Array<(CompositionEntriesReadingResponse, Integer, Hash)>] CompositionEntriesReadingResponse data, response status code and response headers
|
|
2523
|
-
def
|
|
2852
|
+
def read_composition_entries_with_http_info(id, table, opts = {})
|
|
2524
2853
|
if @api_client.config.debugging
|
|
2525
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2854
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.read_composition_entries ...'
|
|
2526
2855
|
end
|
|
2527
2856
|
# verify the required parameter 'id' is set
|
|
2528
2857
|
if @api_client.config.client_side_validation && id.nil?
|
|
2529
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2858
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.read_composition_entries"
|
|
2530
2859
|
end
|
|
2531
2860
|
# verify the required parameter 'table' is set
|
|
2532
2861
|
if @api_client.config.client_side_validation && table.nil?
|
|
2533
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
2862
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.read_composition_entries"
|
|
2534
2863
|
end
|
|
2535
2864
|
if @api_client.config.client_side_validation && table.to_s.length > 63
|
|
2536
|
-
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.
|
|
2865
|
+
fail ArgumentError, 'invalid value for "table" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 63.'
|
|
2537
2866
|
end
|
|
2538
2867
|
|
|
2539
2868
|
if @api_client.config.client_side_validation && !opts[:'group_by'].nil? && opts[:'group_by'].to_s.length > 63
|
|
2540
|
-
fail ArgumentError, 'invalid value for "opts[:"group_by"]" when calling CompositionsApi.
|
|
2869
|
+
fail ArgumentError, 'invalid value for "opts[:"group_by"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 63.'
|
|
2541
2870
|
end
|
|
2542
2871
|
|
|
2543
2872
|
if @api_client.config.client_side_validation && !opts[:'rows'].nil? && opts[:'rows'] > 25
|
|
2544
|
-
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.
|
|
2873
|
+
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.read_composition_entries, must be smaller than or equal to 25.'
|
|
2545
2874
|
end
|
|
2546
2875
|
|
|
2547
2876
|
if @api_client.config.client_side_validation && !opts[:'rows'].nil? && opts[:'rows'] < 0
|
|
2548
|
-
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.
|
|
2877
|
+
fail ArgumentError, 'invalid value for "opts[:"rows"]" when calling CompositionsApi.read_composition_entries, must be greater than or equal to 0.'
|
|
2549
2878
|
end
|
|
2550
2879
|
|
|
2551
2880
|
if @api_client.config.client_side_validation && !opts[:'aggregate'].nil? && opts[:'aggregate'].to_s.length > 100
|
|
2552
|
-
fail ArgumentError, 'invalid value for "opts[:"aggregate"]" when calling CompositionsApi.
|
|
2881
|
+
fail ArgumentError, 'invalid value for "opts[:"aggregate"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 100.'
|
|
2553
2882
|
end
|
|
2554
2883
|
|
|
2555
2884
|
if @api_client.config.client_side_validation && !opts[:'column'].nil? && opts[:'column'].to_s.length > 63
|
|
2556
|
-
fail ArgumentError, 'invalid value for "opts[:"column"]" when calling CompositionsApi.
|
|
2885
|
+
fail ArgumentError, 'invalid value for "opts[:"column"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 63.'
|
|
2557
2886
|
end
|
|
2558
2887
|
|
|
2559
2888
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2560
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2889
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.read_composition_entries, the character length must be smaller than or equal to 255.'
|
|
2561
2890
|
end
|
|
2562
2891
|
|
|
2563
2892
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2564
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2893
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.read_composition_entries, the character length must be great than or equal to 1.'
|
|
2565
2894
|
end
|
|
2566
2895
|
|
|
2567
2896
|
# resource path
|
|
@@ -2598,7 +2927,7 @@ module ApiSdkRb
|
|
|
2598
2927
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2599
2928
|
|
|
2600
2929
|
new_options = opts.merge(
|
|
2601
|
-
:operation => :"CompositionsApi.
|
|
2930
|
+
:operation => :"CompositionsApi.read_composition_entries",
|
|
2602
2931
|
:header_params => header_params,
|
|
2603
2932
|
:query_params => query_params,
|
|
2604
2933
|
:form_params => form_params,
|
|
@@ -2609,7 +2938,7 @@ module ApiSdkRb
|
|
|
2609
2938
|
|
|
2610
2939
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
2611
2940
|
if @api_client.config.debugging
|
|
2612
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
2941
|
+
@api_client.config.logger.debug "API called: CompositionsApi#read_composition_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2613
2942
|
end
|
|
2614
2943
|
return data, status_code, headers
|
|
2615
2944
|
end
|
|
@@ -2622,8 +2951,8 @@ module ApiSdkRb
|
|
|
2622
2951
|
# @option opts [String] :x_managed_user_id 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.
|
|
2623
2952
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2624
2953
|
# @return [RemoveAiAnswersKnowledgeDocument200Response]
|
|
2625
|
-
def
|
|
2626
|
-
data, _status_code, _headers =
|
|
2954
|
+
def remove_ai_answers_knowledge_document(id, document_id, opts = {})
|
|
2955
|
+
data, _status_code, _headers = remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts)
|
|
2627
2956
|
data
|
|
2628
2957
|
end
|
|
2629
2958
|
|
|
@@ -2635,24 +2964,24 @@ module ApiSdkRb
|
|
|
2635
2964
|
# @option opts [String] :x_managed_user_id 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.
|
|
2636
2965
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2637
2966
|
# @return [Array<(RemoveAiAnswersKnowledgeDocument200Response, Integer, Hash)>] RemoveAiAnswersKnowledgeDocument200Response data, response status code and response headers
|
|
2638
|
-
def
|
|
2967
|
+
def remove_ai_answers_knowledge_document_with_http_info(id, document_id, opts = {})
|
|
2639
2968
|
if @api_client.config.debugging
|
|
2640
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
2969
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.remove_ai_answers_knowledge_document ...'
|
|
2641
2970
|
end
|
|
2642
2971
|
# verify the required parameter 'id' is set
|
|
2643
2972
|
if @api_client.config.client_side_validation && id.nil?
|
|
2644
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
2973
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.remove_ai_answers_knowledge_document"
|
|
2645
2974
|
end
|
|
2646
2975
|
# verify the required parameter 'document_id' is set
|
|
2647
2976
|
if @api_client.config.client_side_validation && document_id.nil?
|
|
2648
|
-
fail ArgumentError, "Missing the required parameter 'document_id' when calling CompositionsApi.
|
|
2977
|
+
fail ArgumentError, "Missing the required parameter 'document_id' when calling CompositionsApi.remove_ai_answers_knowledge_document"
|
|
2649
2978
|
end
|
|
2650
2979
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2651
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2980
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.remove_ai_answers_knowledge_document, the character length must be smaller than or equal to 255.'
|
|
2652
2981
|
end
|
|
2653
2982
|
|
|
2654
2983
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2655
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
2984
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.remove_ai_answers_knowledge_document, the character length must be great than or equal to 1.'
|
|
2656
2985
|
end
|
|
2657
2986
|
|
|
2658
2987
|
# resource path
|
|
@@ -2681,7 +3010,7 @@ module ApiSdkRb
|
|
|
2681
3010
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2682
3011
|
|
|
2683
3012
|
new_options = opts.merge(
|
|
2684
|
-
:operation => :"CompositionsApi.
|
|
3013
|
+
:operation => :"CompositionsApi.remove_ai_answers_knowledge_document",
|
|
2685
3014
|
:header_params => header_params,
|
|
2686
3015
|
:query_params => query_params,
|
|
2687
3016
|
:form_params => form_params,
|
|
@@ -2692,7 +3021,7 @@ module ApiSdkRb
|
|
|
2692
3021
|
|
|
2693
3022
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
2694
3023
|
if @api_client.config.debugging
|
|
2695
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3024
|
+
@api_client.config.logger.debug "API called: CompositionsApi#remove_ai_answers_knowledge_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2696
3025
|
end
|
|
2697
3026
|
return data, status_code, headers
|
|
2698
3027
|
end
|
|
@@ -2706,8 +3035,8 @@ module ApiSdkRb
|
|
|
2706
3035
|
# @option opts [String] :x_managed_user_id 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.
|
|
2707
3036
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2708
3037
|
# @return [CompositionDataSourceResponse]
|
|
2709
|
-
def
|
|
2710
|
-
data, _status_code, _headers =
|
|
3038
|
+
def set_composition_data_source(id, idempotency_key, set_composition_data_source_request, opts = {})
|
|
3039
|
+
data, _status_code, _headers = set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts)
|
|
2711
3040
|
data
|
|
2712
3041
|
end
|
|
2713
3042
|
|
|
@@ -2720,41 +3049,41 @@ module ApiSdkRb
|
|
|
2720
3049
|
# @option opts [String] :x_managed_user_id 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.
|
|
2721
3050
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2722
3051
|
# @return [Array<(CompositionDataSourceResponse, Integer, Hash)>] CompositionDataSourceResponse data, response status code and response headers
|
|
2723
|
-
def
|
|
3052
|
+
def set_composition_data_source_with_http_info(id, idempotency_key, set_composition_data_source_request, opts = {})
|
|
2724
3053
|
if @api_client.config.debugging
|
|
2725
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3054
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.set_composition_data_source ...'
|
|
2726
3055
|
end
|
|
2727
3056
|
# verify the required parameter 'id' is set
|
|
2728
3057
|
if @api_client.config.client_side_validation && id.nil?
|
|
2729
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3058
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.set_composition_data_source"
|
|
2730
3059
|
end
|
|
2731
3060
|
# verify the required parameter 'idempotency_key' is set
|
|
2732
3061
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2733
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3062
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.set_composition_data_source"
|
|
2734
3063
|
end
|
|
2735
3064
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2736
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3065
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_composition_data_source, the character length must be smaller than or equal to 50.'
|
|
2737
3066
|
end
|
|
2738
3067
|
|
|
2739
3068
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2740
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3069
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_composition_data_source, the character length must be great than or equal to 8.'
|
|
2741
3070
|
end
|
|
2742
3071
|
|
|
2743
3072
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2744
3073
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2745
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3074
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.set_composition_data_source, must conform to the pattern #{pattern}."
|
|
2746
3075
|
end
|
|
2747
3076
|
|
|
2748
3077
|
# verify the required parameter 'set_composition_data_source_request' is set
|
|
2749
3078
|
if @api_client.config.client_side_validation && set_composition_data_source_request.nil?
|
|
2750
|
-
fail ArgumentError, "Missing the required parameter 'set_composition_data_source_request' when calling CompositionsApi.
|
|
3079
|
+
fail ArgumentError, "Missing the required parameter 'set_composition_data_source_request' when calling CompositionsApi.set_composition_data_source"
|
|
2751
3080
|
end
|
|
2752
3081
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2753
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3082
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_composition_data_source, the character length must be smaller than or equal to 255.'
|
|
2754
3083
|
end
|
|
2755
3084
|
|
|
2756
3085
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2757
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3086
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_composition_data_source, the character length must be great than or equal to 1.'
|
|
2758
3087
|
end
|
|
2759
3088
|
|
|
2760
3089
|
# resource path
|
|
@@ -2789,7 +3118,7 @@ module ApiSdkRb
|
|
|
2789
3118
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2790
3119
|
|
|
2791
3120
|
new_options = opts.merge(
|
|
2792
|
-
:operation => :"CompositionsApi.
|
|
3121
|
+
:operation => :"CompositionsApi.set_composition_data_source",
|
|
2793
3122
|
:header_params => header_params,
|
|
2794
3123
|
:query_params => query_params,
|
|
2795
3124
|
:form_params => form_params,
|
|
@@ -2800,7 +3129,7 @@ module ApiSdkRb
|
|
|
2800
3129
|
|
|
2801
3130
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2802
3131
|
if @api_client.config.debugging
|
|
2803
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3132
|
+
@api_client.config.logger.debug "API called: CompositionsApi#set_composition_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2804
3133
|
end
|
|
2805
3134
|
return data, status_code, headers
|
|
2806
3135
|
end
|
|
@@ -2815,8 +3144,8 @@ module ApiSdkRb
|
|
|
2815
3144
|
# @option opts [String] :x_managed_user_id 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.
|
|
2816
3145
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2817
3146
|
# @return [SetDynamicContentResponse]
|
|
2818
|
-
def
|
|
2819
|
-
data, _status_code, _headers =
|
|
3147
|
+
def set_dynamic_content(id, idempotency_key, set_dynamic_content_request, opts = {})
|
|
3148
|
+
data, _status_code, _headers = set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts)
|
|
2820
3149
|
data
|
|
2821
3150
|
end
|
|
2822
3151
|
|
|
@@ -2830,41 +3159,41 @@ module ApiSdkRb
|
|
|
2830
3159
|
# @option opts [String] :x_managed_user_id 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.
|
|
2831
3160
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2832
3161
|
# @return [Array<(SetDynamicContentResponse, Integer, Hash)>] SetDynamicContentResponse data, response status code and response headers
|
|
2833
|
-
def
|
|
3162
|
+
def set_dynamic_content_with_http_info(id, idempotency_key, set_dynamic_content_request, opts = {})
|
|
2834
3163
|
if @api_client.config.debugging
|
|
2835
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3164
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.set_dynamic_content ...'
|
|
2836
3165
|
end
|
|
2837
3166
|
# verify the required parameter 'id' is set
|
|
2838
3167
|
if @api_client.config.client_side_validation && id.nil?
|
|
2839
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3168
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.set_dynamic_content"
|
|
2840
3169
|
end
|
|
2841
3170
|
# verify the required parameter 'idempotency_key' is set
|
|
2842
3171
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2843
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3172
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.set_dynamic_content"
|
|
2844
3173
|
end
|
|
2845
3174
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2846
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3175
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_dynamic_content, the character length must be smaller than or equal to 50.'
|
|
2847
3176
|
end
|
|
2848
3177
|
|
|
2849
3178
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2850
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3179
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.set_dynamic_content, the character length must be great than or equal to 8.'
|
|
2851
3180
|
end
|
|
2852
3181
|
|
|
2853
3182
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2854
3183
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2855
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3184
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.set_dynamic_content, must conform to the pattern #{pattern}."
|
|
2856
3185
|
end
|
|
2857
3186
|
|
|
2858
3187
|
# verify the required parameter 'set_dynamic_content_request' is set
|
|
2859
3188
|
if @api_client.config.client_side_validation && set_dynamic_content_request.nil?
|
|
2860
|
-
fail ArgumentError, "Missing the required parameter 'set_dynamic_content_request' when calling CompositionsApi.
|
|
3189
|
+
fail ArgumentError, "Missing the required parameter 'set_dynamic_content_request' when calling CompositionsApi.set_dynamic_content"
|
|
2861
3190
|
end
|
|
2862
3191
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2863
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3192
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_dynamic_content, the character length must be smaller than or equal to 255.'
|
|
2864
3193
|
end
|
|
2865
3194
|
|
|
2866
3195
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2867
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3196
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.set_dynamic_content, the character length must be great than or equal to 1.'
|
|
2868
3197
|
end
|
|
2869
3198
|
|
|
2870
3199
|
# resource path
|
|
@@ -2900,7 +3229,7 @@ module ApiSdkRb
|
|
|
2900
3229
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
2901
3230
|
|
|
2902
3231
|
new_options = opts.merge(
|
|
2903
|
-
:operation => :"CompositionsApi.
|
|
3232
|
+
:operation => :"CompositionsApi.set_dynamic_content",
|
|
2904
3233
|
:header_params => header_params,
|
|
2905
3234
|
:query_params => query_params,
|
|
2906
3235
|
:form_params => form_params,
|
|
@@ -2911,7 +3240,7 @@ module ApiSdkRb
|
|
|
2911
3240
|
|
|
2912
3241
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
2913
3242
|
if @api_client.config.debugging
|
|
2914
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3243
|
+
@api_client.config.logger.debug "API called: CompositionsApi#set_dynamic_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
2915
3244
|
end
|
|
2916
3245
|
return data, status_code, headers
|
|
2917
3246
|
end
|
|
@@ -2925,9 +3254,9 @@ module ApiSdkRb
|
|
|
2925
3254
|
# @option opts [String] :if_match Optional content version from `contentVersion` or an `ETag` (`\"3\"`, `3`, or `*`). Read only when the body has `content`.
|
|
2926
3255
|
# @option opts [String] :x_managed_user_id 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.
|
|
2927
3256
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2928
|
-
# @return [
|
|
2929
|
-
def
|
|
2930
|
-
data, _status_code, _headers =
|
|
3257
|
+
# @return [CompositionResponse]
|
|
3258
|
+
def update_composition(id, idempotency_key, update_composition, opts = {})
|
|
3259
|
+
data, _status_code, _headers = update_composition_with_http_info(id, idempotency_key, update_composition, opts)
|
|
2931
3260
|
data
|
|
2932
3261
|
end
|
|
2933
3262
|
|
|
@@ -2940,42 +3269,42 @@ module ApiSdkRb
|
|
|
2940
3269
|
# @option opts [String] :if_match Optional content version from `contentVersion` or an `ETag` (`\"3\"`, `3`, or `*`). Read only when the body has `content`.
|
|
2941
3270
|
# @option opts [String] :x_managed_user_id 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.
|
|
2942
3271
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
2943
|
-
# @return [Array<(
|
|
2944
|
-
def
|
|
3272
|
+
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
3273
|
+
def update_composition_with_http_info(id, idempotency_key, update_composition, opts = {})
|
|
2945
3274
|
if @api_client.config.debugging
|
|
2946
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3275
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.update_composition ...'
|
|
2947
3276
|
end
|
|
2948
3277
|
# verify the required parameter 'id' is set
|
|
2949
3278
|
if @api_client.config.client_side_validation && id.nil?
|
|
2950
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3279
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.update_composition"
|
|
2951
3280
|
end
|
|
2952
3281
|
# verify the required parameter 'idempotency_key' is set
|
|
2953
3282
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
2954
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3283
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.update_composition"
|
|
2955
3284
|
end
|
|
2956
3285
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
2957
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3286
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition, the character length must be smaller than or equal to 50.'
|
|
2958
3287
|
end
|
|
2959
3288
|
|
|
2960
3289
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
2961
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3290
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition, the character length must be great than or equal to 8.'
|
|
2962
3291
|
end
|
|
2963
3292
|
|
|
2964
3293
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
2965
3294
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
2966
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3295
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.update_composition, must conform to the pattern #{pattern}."
|
|
2967
3296
|
end
|
|
2968
3297
|
|
|
2969
3298
|
# verify the required parameter 'update_composition' is set
|
|
2970
3299
|
if @api_client.config.client_side_validation && update_composition.nil?
|
|
2971
|
-
fail ArgumentError, "Missing the required parameter 'update_composition' when calling CompositionsApi.
|
|
3300
|
+
fail ArgumentError, "Missing the required parameter 'update_composition' when calling CompositionsApi.update_composition"
|
|
2972
3301
|
end
|
|
2973
3302
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
2974
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3303
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition, the character length must be smaller than or equal to 255.'
|
|
2975
3304
|
end
|
|
2976
3305
|
|
|
2977
3306
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
2978
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3307
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition, the character length must be great than or equal to 1.'
|
|
2979
3308
|
end
|
|
2980
3309
|
|
|
2981
3310
|
# resource path
|
|
@@ -3005,13 +3334,13 @@ module ApiSdkRb
|
|
|
3005
3334
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_composition)
|
|
3006
3335
|
|
|
3007
3336
|
# return_type
|
|
3008
|
-
return_type = opts[:debug_return_type] || '
|
|
3337
|
+
return_type = opts[:debug_return_type] || 'CompositionResponse'
|
|
3009
3338
|
|
|
3010
3339
|
# auth_names
|
|
3011
3340
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
3012
3341
|
|
|
3013
3342
|
new_options = opts.merge(
|
|
3014
|
-
:operation => :"CompositionsApi.
|
|
3343
|
+
:operation => :"CompositionsApi.update_composition",
|
|
3015
3344
|
:header_params => header_params,
|
|
3016
3345
|
:query_params => query_params,
|
|
3017
3346
|
:form_params => form_params,
|
|
@@ -3022,7 +3351,7 @@ module ApiSdkRb
|
|
|
3022
3351
|
|
|
3023
3352
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
3024
3353
|
if @api_client.config.debugging
|
|
3025
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3354
|
+
@api_client.config.logger.debug "API called: CompositionsApi#update_composition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3026
3355
|
end
|
|
3027
3356
|
return data, status_code, headers
|
|
3028
3357
|
end
|
|
@@ -3037,9 +3366,9 @@ module ApiSdkRb
|
|
|
3037
3366
|
# @param [Hash] opts the optional parameters
|
|
3038
3367
|
# @option opts [String] :x_managed_user_id 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.
|
|
3039
3368
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
3040
|
-
# @return [
|
|
3041
|
-
def
|
|
3042
|
-
data, _status_code, _headers =
|
|
3369
|
+
# @return [CompositionDatabaseRecordResponse]
|
|
3370
|
+
def update_composition_database_record(id, table, record_id, idempotency_key, body, opts = {})
|
|
3371
|
+
data, _status_code, _headers = update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts)
|
|
3043
3372
|
data
|
|
3044
3373
|
end
|
|
3045
3374
|
|
|
@@ -3053,50 +3382,50 @@ module ApiSdkRb
|
|
|
3053
3382
|
# @param [Hash] opts the optional parameters
|
|
3054
3383
|
# @option opts [String] :x_managed_user_id 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.
|
|
3055
3384
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
3056
|
-
# @return [Array<(
|
|
3057
|
-
def
|
|
3385
|
+
# @return [Array<(CompositionDatabaseRecordResponse, Integer, Hash)>] CompositionDatabaseRecordResponse data, response status code and response headers
|
|
3386
|
+
def update_composition_database_record_with_http_info(id, table, record_id, idempotency_key, body, opts = {})
|
|
3058
3387
|
if @api_client.config.debugging
|
|
3059
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3388
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.update_composition_database_record ...'
|
|
3060
3389
|
end
|
|
3061
3390
|
# verify the required parameter 'id' is set
|
|
3062
3391
|
if @api_client.config.client_side_validation && id.nil?
|
|
3063
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3392
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.update_composition_database_record"
|
|
3064
3393
|
end
|
|
3065
3394
|
# verify the required parameter 'table' is set
|
|
3066
3395
|
if @api_client.config.client_side_validation && table.nil?
|
|
3067
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.
|
|
3396
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling CompositionsApi.update_composition_database_record"
|
|
3068
3397
|
end
|
|
3069
3398
|
# verify the required parameter 'record_id' is set
|
|
3070
3399
|
if @api_client.config.client_side_validation && record_id.nil?
|
|
3071
|
-
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.
|
|
3400
|
+
fail ArgumentError, "Missing the required parameter 'record_id' when calling CompositionsApi.update_composition_database_record"
|
|
3072
3401
|
end
|
|
3073
3402
|
# verify the required parameter 'idempotency_key' is set
|
|
3074
3403
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
3075
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3404
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.update_composition_database_record"
|
|
3076
3405
|
end
|
|
3077
3406
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
3078
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3407
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_database_record, the character length must be smaller than or equal to 50.'
|
|
3079
3408
|
end
|
|
3080
3409
|
|
|
3081
3410
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
3082
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3411
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_database_record, the character length must be great than or equal to 8.'
|
|
3083
3412
|
end
|
|
3084
3413
|
|
|
3085
3414
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
3086
3415
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
3087
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3416
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.update_composition_database_record, must conform to the pattern #{pattern}."
|
|
3088
3417
|
end
|
|
3089
3418
|
|
|
3090
3419
|
# verify the required parameter 'body' is set
|
|
3091
3420
|
if @api_client.config.client_side_validation && body.nil?
|
|
3092
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.
|
|
3421
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling CompositionsApi.update_composition_database_record"
|
|
3093
3422
|
end
|
|
3094
3423
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
3095
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3424
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_database_record, the character length must be smaller than or equal to 255.'
|
|
3096
3425
|
end
|
|
3097
3426
|
|
|
3098
3427
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
3099
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3428
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_database_record, the character length must be great than or equal to 1.'
|
|
3100
3429
|
end
|
|
3101
3430
|
|
|
3102
3431
|
# resource path
|
|
@@ -3125,13 +3454,13 @@ module ApiSdkRb
|
|
|
3125
3454
|
post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
|
|
3126
3455
|
|
|
3127
3456
|
# return_type
|
|
3128
|
-
return_type = opts[:debug_return_type] || '
|
|
3457
|
+
return_type = opts[:debug_return_type] || 'CompositionDatabaseRecordResponse'
|
|
3129
3458
|
|
|
3130
3459
|
# auth_names
|
|
3131
3460
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
3132
3461
|
|
|
3133
3462
|
new_options = opts.merge(
|
|
3134
|
-
:operation => :"CompositionsApi.
|
|
3463
|
+
:operation => :"CompositionsApi.update_composition_database_record",
|
|
3135
3464
|
:header_params => header_params,
|
|
3136
3465
|
:query_params => query_params,
|
|
3137
3466
|
:form_params => form_params,
|
|
@@ -3142,7 +3471,7 @@ module ApiSdkRb
|
|
|
3142
3471
|
|
|
3143
3472
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
3144
3473
|
if @api_client.config.debugging
|
|
3145
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3474
|
+
@api_client.config.logger.debug "API called: CompositionsApi#update_composition_database_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3146
3475
|
end
|
|
3147
3476
|
return data, status_code, headers
|
|
3148
3477
|
end
|
|
@@ -3156,8 +3485,8 @@ module ApiSdkRb
|
|
|
3156
3485
|
# @option opts [String] :x_managed_user_id 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.
|
|
3157
3486
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
3158
3487
|
# @return [CompositionResponse]
|
|
3159
|
-
def
|
|
3160
|
-
data, _status_code, _headers =
|
|
3488
|
+
def update_composition_status(id, idempotency_key, update_composition_status_request, opts = {})
|
|
3489
|
+
data, _status_code, _headers = update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts)
|
|
3161
3490
|
data
|
|
3162
3491
|
end
|
|
3163
3492
|
|
|
@@ -3170,41 +3499,41 @@ module ApiSdkRb
|
|
|
3170
3499
|
# @option opts [String] :x_managed_user_id 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.
|
|
3171
3500
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
3172
3501
|
# @return [Array<(CompositionResponse, Integer, Hash)>] CompositionResponse data, response status code and response headers
|
|
3173
|
-
def
|
|
3502
|
+
def update_composition_status_with_http_info(id, idempotency_key, update_composition_status_request, opts = {})
|
|
3174
3503
|
if @api_client.config.debugging
|
|
3175
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3504
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.update_composition_status ...'
|
|
3176
3505
|
end
|
|
3177
3506
|
# verify the required parameter 'id' is set
|
|
3178
3507
|
if @api_client.config.client_side_validation && id.nil?
|
|
3179
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3508
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.update_composition_status"
|
|
3180
3509
|
end
|
|
3181
3510
|
# verify the required parameter 'idempotency_key' is set
|
|
3182
3511
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
3183
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3512
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.update_composition_status"
|
|
3184
3513
|
end
|
|
3185
3514
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
3186
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3515
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_status, the character length must be smaller than or equal to 50.'
|
|
3187
3516
|
end
|
|
3188
3517
|
|
|
3189
3518
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
3190
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3519
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.update_composition_status, the character length must be great than or equal to 8.'
|
|
3191
3520
|
end
|
|
3192
3521
|
|
|
3193
3522
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
3194
3523
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
3195
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3524
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.update_composition_status, must conform to the pattern #{pattern}."
|
|
3196
3525
|
end
|
|
3197
3526
|
|
|
3198
3527
|
# verify the required parameter 'update_composition_status_request' is set
|
|
3199
3528
|
if @api_client.config.client_side_validation && update_composition_status_request.nil?
|
|
3200
|
-
fail ArgumentError, "Missing the required parameter 'update_composition_status_request' when calling CompositionsApi.
|
|
3529
|
+
fail ArgumentError, "Missing the required parameter 'update_composition_status_request' when calling CompositionsApi.update_composition_status"
|
|
3201
3530
|
end
|
|
3202
3531
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
3203
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3532
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_status, the character length must be smaller than or equal to 255.'
|
|
3204
3533
|
end
|
|
3205
3534
|
|
|
3206
3535
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
3207
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3536
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.update_composition_status, the character length must be great than or equal to 1.'
|
|
3208
3537
|
end
|
|
3209
3538
|
|
|
3210
3539
|
# resource path
|
|
@@ -3239,7 +3568,7 @@ module ApiSdkRb
|
|
|
3239
3568
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
3240
3569
|
|
|
3241
3570
|
new_options = opts.merge(
|
|
3242
|
-
:operation => :"CompositionsApi.
|
|
3571
|
+
:operation => :"CompositionsApi.update_composition_status",
|
|
3243
3572
|
:header_params => header_params,
|
|
3244
3573
|
:query_params => query_params,
|
|
3245
3574
|
:form_params => form_params,
|
|
@@ -3250,7 +3579,7 @@ module ApiSdkRb
|
|
|
3250
3579
|
|
|
3251
3580
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
3252
3581
|
if @api_client.config.debugging
|
|
3253
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3582
|
+
@api_client.config.logger.debug "API called: CompositionsApi#update_composition_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3254
3583
|
end
|
|
3255
3584
|
return data, status_code, headers
|
|
3256
3585
|
end
|
|
@@ -3264,8 +3593,8 @@ module ApiSdkRb
|
|
|
3264
3593
|
# @option opts [String] :x_managed_user_id 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.
|
|
3265
3594
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
3266
3595
|
# @return [ValidateCompositionContentResponse]
|
|
3267
|
-
def
|
|
3268
|
-
data, _status_code, _headers =
|
|
3596
|
+
def validate_composition_content(id, idempotency_key, request_body, opts = {})
|
|
3597
|
+
data, _status_code, _headers = validate_composition_content_with_http_info(id, idempotency_key, request_body, opts)
|
|
3269
3598
|
data
|
|
3270
3599
|
end
|
|
3271
3600
|
|
|
@@ -3278,41 +3607,41 @@ module ApiSdkRb
|
|
|
3278
3607
|
# @option opts [String] :x_managed_user_id 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.
|
|
3279
3608
|
# @option opts [String] :x_managed_user_external_id 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.
|
|
3280
3609
|
# @return [Array<(ValidateCompositionContentResponse, Integer, Hash)>] ValidateCompositionContentResponse data, response status code and response headers
|
|
3281
|
-
def
|
|
3610
|
+
def validate_composition_content_with_http_info(id, idempotency_key, request_body, opts = {})
|
|
3282
3611
|
if @api_client.config.debugging
|
|
3283
|
-
@api_client.config.logger.debug 'Calling API: CompositionsApi.
|
|
3612
|
+
@api_client.config.logger.debug 'Calling API: CompositionsApi.validate_composition_content ...'
|
|
3284
3613
|
end
|
|
3285
3614
|
# verify the required parameter 'id' is set
|
|
3286
3615
|
if @api_client.config.client_side_validation && id.nil?
|
|
3287
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.
|
|
3616
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling CompositionsApi.validate_composition_content"
|
|
3288
3617
|
end
|
|
3289
3618
|
# verify the required parameter 'idempotency_key' is set
|
|
3290
3619
|
if @api_client.config.client_side_validation && idempotency_key.nil?
|
|
3291
|
-
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.
|
|
3620
|
+
fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling CompositionsApi.validate_composition_content"
|
|
3292
3621
|
end
|
|
3293
3622
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
|
|
3294
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3623
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.validate_composition_content, the character length must be smaller than or equal to 50.'
|
|
3295
3624
|
end
|
|
3296
3625
|
|
|
3297
3626
|
if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
|
|
3298
|
-
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.
|
|
3627
|
+
fail ArgumentError, 'invalid value for "idempotency_key" when calling CompositionsApi.validate_composition_content, the character length must be great than or equal to 8.'
|
|
3299
3628
|
end
|
|
3300
3629
|
|
|
3301
3630
|
pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
|
|
3302
3631
|
if @api_client.config.client_side_validation && idempotency_key !~ pattern
|
|
3303
|
-
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.
|
|
3632
|
+
fail ArgumentError, "invalid value for 'idempotency_key' when calling CompositionsApi.validate_composition_content, must conform to the pattern #{pattern}."
|
|
3304
3633
|
end
|
|
3305
3634
|
|
|
3306
3635
|
# verify the required parameter 'request_body' is set
|
|
3307
3636
|
if @api_client.config.client_side_validation && request_body.nil?
|
|
3308
|
-
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.
|
|
3637
|
+
fail ArgumentError, "Missing the required parameter 'request_body' when calling CompositionsApi.validate_composition_content"
|
|
3309
3638
|
end
|
|
3310
3639
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length > 255
|
|
3311
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3640
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.validate_composition_content, the character length must be smaller than or equal to 255.'
|
|
3312
3641
|
end
|
|
3313
3642
|
|
|
3314
3643
|
if @api_client.config.client_side_validation && !opts[:'x_managed_user_external_id'].nil? && opts[:'x_managed_user_external_id'].to_s.length < 1
|
|
3315
|
-
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.
|
|
3644
|
+
fail ArgumentError, 'invalid value for "opts[:"x_managed_user_external_id"]" when calling CompositionsApi.validate_composition_content, the character length must be great than or equal to 1.'
|
|
3316
3645
|
end
|
|
3317
3646
|
|
|
3318
3647
|
# resource path
|
|
@@ -3347,7 +3676,7 @@ module ApiSdkRb
|
|
|
3347
3676
|
auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
|
|
3348
3677
|
|
|
3349
3678
|
new_options = opts.merge(
|
|
3350
|
-
:operation => :"CompositionsApi.
|
|
3679
|
+
:operation => :"CompositionsApi.validate_composition_content",
|
|
3351
3680
|
:header_params => header_params,
|
|
3352
3681
|
:query_params => query_params,
|
|
3353
3682
|
:form_params => form_params,
|
|
@@ -3358,7 +3687,7 @@ module ApiSdkRb
|
|
|
3358
3687
|
|
|
3359
3688
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
3360
3689
|
if @api_client.config.debugging
|
|
3361
|
-
@api_client.config.logger.debug "API called: CompositionsApi#
|
|
3690
|
+
@api_client.config.logger.debug "API called: CompositionsApi#validate_composition_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3362
3691
|
end
|
|
3363
3692
|
return data, status_code, headers
|
|
3364
3693
|
end
|