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
|
@@ -27,8 +27,8 @@ module ApiSdkRb
|
|
|
27
27
|
# @param public_adapter_call_request [PublicAdapterCallRequest]
|
|
28
28
|
# @param [Hash] opts the optional parameters
|
|
29
29
|
# @return [PublicAdapterCallResult]
|
|
30
|
-
def
|
|
31
|
-
data, _status_code, _headers =
|
|
30
|
+
def call_public_composition_adapter(composition_id, adapter_id, operation, public_adapter_call_request, opts = {})
|
|
31
|
+
data, _status_code, _headers = call_public_composition_adapter_with_http_info(composition_id, adapter_id, operation, public_adapter_call_request, opts)
|
|
32
32
|
data
|
|
33
33
|
end
|
|
34
34
|
|
|
@@ -40,43 +40,43 @@ module ApiSdkRb
|
|
|
40
40
|
# @param public_adapter_call_request [PublicAdapterCallRequest]
|
|
41
41
|
# @param [Hash] opts the optional parameters
|
|
42
42
|
# @return [Array<(PublicAdapterCallResult, Integer, Hash)>] PublicAdapterCallResult data, response status code and response headers
|
|
43
|
-
def
|
|
43
|
+
def call_public_composition_adapter_with_http_info(composition_id, adapter_id, operation, public_adapter_call_request, opts = {})
|
|
44
44
|
if @api_client.config.debugging
|
|
45
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
45
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.call_public_composition_adapter ...'
|
|
46
46
|
end
|
|
47
47
|
# verify the required parameter 'composition_id' is set
|
|
48
48
|
if @api_client.config.client_side_validation && composition_id.nil?
|
|
49
|
-
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.
|
|
49
|
+
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.call_public_composition_adapter"
|
|
50
50
|
end
|
|
51
51
|
# verify the required parameter 'adapter_id' is set
|
|
52
52
|
if @api_client.config.client_side_validation && adapter_id.nil?
|
|
53
|
-
fail ArgumentError, "Missing the required parameter 'adapter_id' when calling PublicEmbedApi.
|
|
53
|
+
fail ArgumentError, "Missing the required parameter 'adapter_id' when calling PublicEmbedApi.call_public_composition_adapter"
|
|
54
54
|
end
|
|
55
55
|
if @api_client.config.client_side_validation && adapter_id.to_s.length > 40
|
|
56
|
-
fail ArgumentError, 'invalid value for "adapter_id" when calling PublicEmbedApi.
|
|
56
|
+
fail ArgumentError, 'invalid value for "adapter_id" when calling PublicEmbedApi.call_public_composition_adapter, the character length must be smaller than or equal to 40.'
|
|
57
57
|
end
|
|
58
58
|
|
|
59
59
|
pattern = Regexp.new(/^[a-z][a-z0-9]*(-[a-z0-9]+)*$/)
|
|
60
60
|
if @api_client.config.client_side_validation && adapter_id !~ pattern
|
|
61
|
-
fail ArgumentError, "invalid value for 'adapter_id' when calling PublicEmbedApi.
|
|
61
|
+
fail ArgumentError, "invalid value for 'adapter_id' when calling PublicEmbedApi.call_public_composition_adapter, must conform to the pattern #{pattern}."
|
|
62
62
|
end
|
|
63
63
|
|
|
64
64
|
# verify the required parameter 'operation' is set
|
|
65
65
|
if @api_client.config.client_side_validation && operation.nil?
|
|
66
|
-
fail ArgumentError, "Missing the required parameter 'operation' when calling PublicEmbedApi.
|
|
66
|
+
fail ArgumentError, "Missing the required parameter 'operation' when calling PublicEmbedApi.call_public_composition_adapter"
|
|
67
67
|
end
|
|
68
68
|
if @api_client.config.client_side_validation && operation.to_s.length > 40
|
|
69
|
-
fail ArgumentError, 'invalid value for "operation" when calling PublicEmbedApi.
|
|
69
|
+
fail ArgumentError, 'invalid value for "operation" when calling PublicEmbedApi.call_public_composition_adapter, the character length must be smaller than or equal to 40.'
|
|
70
70
|
end
|
|
71
71
|
|
|
72
72
|
pattern = Regexp.new(/^[a-z][a-z0-9]*(-[a-z0-9]+)*$/)
|
|
73
73
|
if @api_client.config.client_side_validation && operation !~ pattern
|
|
74
|
-
fail ArgumentError, "invalid value for 'operation' when calling PublicEmbedApi.
|
|
74
|
+
fail ArgumentError, "invalid value for 'operation' when calling PublicEmbedApi.call_public_composition_adapter, must conform to the pattern #{pattern}."
|
|
75
75
|
end
|
|
76
76
|
|
|
77
77
|
# verify the required parameter 'public_adapter_call_request' is set
|
|
78
78
|
if @api_client.config.client_side_validation && public_adapter_call_request.nil?
|
|
79
|
-
fail ArgumentError, "Missing the required parameter 'public_adapter_call_request' when calling PublicEmbedApi.
|
|
79
|
+
fail ArgumentError, "Missing the required parameter 'public_adapter_call_request' when calling PublicEmbedApi.call_public_composition_adapter"
|
|
80
80
|
end
|
|
81
81
|
# resource path
|
|
82
82
|
local_var_path = '/embed/compositions/{compositionId}/adapters/{adapterId}/{operation}'.sub('{' + 'compositionId' + '}', CGI.escape(composition_id.to_s)).sub('{' + 'adapterId' + '}', CGI.escape(adapter_id.to_s)).sub('{' + 'operation' + '}', CGI.escape(operation.to_s))
|
|
@@ -107,7 +107,7 @@ module ApiSdkRb
|
|
|
107
107
|
auth_names = opts[:debug_auth_names] || []
|
|
108
108
|
|
|
109
109
|
new_options = opts.merge(
|
|
110
|
-
:operation => :"PublicEmbedApi.
|
|
110
|
+
:operation => :"PublicEmbedApi.call_public_composition_adapter",
|
|
111
111
|
:header_params => header_params,
|
|
112
112
|
:query_params => query_params,
|
|
113
113
|
:form_params => form_params,
|
|
@@ -118,7 +118,7 @@ module ApiSdkRb
|
|
|
118
118
|
|
|
119
119
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
120
120
|
if @api_client.config.debugging
|
|
121
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
121
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#call_public_composition_adapter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
122
122
|
end
|
|
123
123
|
return data, status_code, headers
|
|
124
124
|
end
|
|
@@ -132,8 +132,8 @@ module ApiSdkRb
|
|
|
132
132
|
# @option opts [String] :x_widgetic_write_token Signed per-composition write token handed to the widget in `widgetic:host` as `entries.writeToken` (and returned by `GET /embed/compositions/{compositionId}` as `entryWriteToken`). Required when the request comes from the shared Widgetic artifact origin; verified whenever present.
|
|
133
133
|
# @option opts [String] :x_widgetic_visitor_id A random id the widget's browser makes once and keeps (16 to 64 characters of `A-Za-z0-9_-`), sent so a table's per-visitor `limit` (declared in the widget database file) can count this browser. Not an identity and not a secret. Without it, or with a malformed value, the limit counts only by network address.
|
|
134
134
|
# @return [PublicCompositionEntryCreated]
|
|
135
|
-
def
|
|
136
|
-
data, _status_code, _headers =
|
|
135
|
+
def create_public_composition_entry(composition_id, table, public_composition_entry_request, opts = {})
|
|
136
|
+
data, _status_code, _headers = create_public_composition_entry_with_http_info(composition_id, table, public_composition_entry_request, opts)
|
|
137
137
|
data
|
|
138
138
|
end
|
|
139
139
|
|
|
@@ -146,25 +146,25 @@ module ApiSdkRb
|
|
|
146
146
|
# @option opts [String] :x_widgetic_write_token Signed per-composition write token handed to the widget in `widgetic:host` as `entries.writeToken` (and returned by `GET /embed/compositions/{compositionId}` as `entryWriteToken`). Required when the request comes from the shared Widgetic artifact origin; verified whenever present.
|
|
147
147
|
# @option opts [String] :x_widgetic_visitor_id A random id the widget's browser makes once and keeps (16 to 64 characters of `A-Za-z0-9_-`), sent so a table's per-visitor `limit` (declared in the widget database file) can count this browser. Not an identity and not a secret. Without it, or with a malformed value, the limit counts only by network address.
|
|
148
148
|
# @return [Array<(PublicCompositionEntryCreated, Integer, Hash)>] PublicCompositionEntryCreated data, response status code and response headers
|
|
149
|
-
def
|
|
149
|
+
def create_public_composition_entry_with_http_info(composition_id, table, public_composition_entry_request, opts = {})
|
|
150
150
|
if @api_client.config.debugging
|
|
151
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
151
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.create_public_composition_entry ...'
|
|
152
152
|
end
|
|
153
153
|
# verify the required parameter 'composition_id' is set
|
|
154
154
|
if @api_client.config.client_side_validation && composition_id.nil?
|
|
155
|
-
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.
|
|
155
|
+
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.create_public_composition_entry"
|
|
156
156
|
end
|
|
157
157
|
# verify the required parameter 'table' is set
|
|
158
158
|
if @api_client.config.client_side_validation && table.nil?
|
|
159
|
-
fail ArgumentError, "Missing the required parameter 'table' when calling PublicEmbedApi.
|
|
159
|
+
fail ArgumentError, "Missing the required parameter 'table' when calling PublicEmbedApi.create_public_composition_entry"
|
|
160
160
|
end
|
|
161
161
|
# verify the required parameter 'public_composition_entry_request' is set
|
|
162
162
|
if @api_client.config.client_side_validation && public_composition_entry_request.nil?
|
|
163
|
-
fail ArgumentError, "Missing the required parameter 'public_composition_entry_request' when calling PublicEmbedApi.
|
|
163
|
+
fail ArgumentError, "Missing the required parameter 'public_composition_entry_request' when calling PublicEmbedApi.create_public_composition_entry"
|
|
164
164
|
end
|
|
165
165
|
pattern = Regexp.new(/^[A-Za-z0-9_-]{16,64}$/)
|
|
166
166
|
if @api_client.config.client_side_validation && !opts[:'x_widgetic_visitor_id'].nil? && opts[:'x_widgetic_visitor_id'] !~ pattern
|
|
167
|
-
fail ArgumentError, "invalid value for 'opts[:\"x_widgetic_visitor_id\"]' when calling PublicEmbedApi.
|
|
167
|
+
fail ArgumentError, "invalid value for 'opts[:\"x_widgetic_visitor_id\"]' when calling PublicEmbedApi.create_public_composition_entry, must conform to the pattern #{pattern}."
|
|
168
168
|
end
|
|
169
169
|
|
|
170
170
|
# resource path
|
|
@@ -198,7 +198,7 @@ module ApiSdkRb
|
|
|
198
198
|
auth_names = opts[:debug_auth_names] || []
|
|
199
199
|
|
|
200
200
|
new_options = opts.merge(
|
|
201
|
-
:operation => :"PublicEmbedApi.
|
|
201
|
+
:operation => :"PublicEmbedApi.create_public_composition_entry",
|
|
202
202
|
:header_params => header_params,
|
|
203
203
|
:query_params => query_params,
|
|
204
204
|
:form_params => form_params,
|
|
@@ -209,7 +209,7 @@ module ApiSdkRb
|
|
|
209
209
|
|
|
210
210
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
211
211
|
if @api_client.config.debugging
|
|
212
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
212
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#create_public_composition_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
213
213
|
end
|
|
214
214
|
return data, status_code, headers
|
|
215
215
|
end
|
|
@@ -219,8 +219,8 @@ module ApiSdkRb
|
|
|
219
219
|
# @param composition_id [String]
|
|
220
220
|
# @param [Hash] opts the optional parameters
|
|
221
221
|
# @return [GetPublicCompositionEmbed200Response]
|
|
222
|
-
def
|
|
223
|
-
data, _status_code, _headers =
|
|
222
|
+
def get_public_composition_embed(composition_id, opts = {})
|
|
223
|
+
data, _status_code, _headers = get_public_composition_embed_with_http_info(composition_id, opts)
|
|
224
224
|
data
|
|
225
225
|
end
|
|
226
226
|
|
|
@@ -229,13 +229,13 @@ module ApiSdkRb
|
|
|
229
229
|
# @param composition_id [String]
|
|
230
230
|
# @param [Hash] opts the optional parameters
|
|
231
231
|
# @return [Array<(GetPublicCompositionEmbed200Response, Integer, Hash)>] GetPublicCompositionEmbed200Response data, response status code and response headers
|
|
232
|
-
def
|
|
232
|
+
def get_public_composition_embed_with_http_info(composition_id, opts = {})
|
|
233
233
|
if @api_client.config.debugging
|
|
234
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
234
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.get_public_composition_embed ...'
|
|
235
235
|
end
|
|
236
236
|
# verify the required parameter 'composition_id' is set
|
|
237
237
|
if @api_client.config.client_side_validation && composition_id.nil?
|
|
238
|
-
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.
|
|
238
|
+
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.get_public_composition_embed"
|
|
239
239
|
end
|
|
240
240
|
# resource path
|
|
241
241
|
local_var_path = '/embed/compositions/{compositionId}'.sub('{' + 'compositionId' + '}', CGI.escape(composition_id.to_s))
|
|
@@ -261,7 +261,7 @@ module ApiSdkRb
|
|
|
261
261
|
auth_names = opts[:debug_auth_names] || []
|
|
262
262
|
|
|
263
263
|
new_options = opts.merge(
|
|
264
|
-
:operation => :"PublicEmbedApi.
|
|
264
|
+
:operation => :"PublicEmbedApi.get_public_composition_embed",
|
|
265
265
|
:header_params => header_params,
|
|
266
266
|
:query_params => query_params,
|
|
267
267
|
:form_params => form_params,
|
|
@@ -272,7 +272,7 @@ module ApiSdkRb
|
|
|
272
272
|
|
|
273
273
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
274
274
|
if @api_client.config.debugging
|
|
275
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
275
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#get_public_composition_embed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
276
276
|
end
|
|
277
277
|
return data, status_code, headers
|
|
278
278
|
end
|
|
@@ -282,8 +282,8 @@ module ApiSdkRb
|
|
|
282
282
|
# @param composition_id [String]
|
|
283
283
|
# @param [Hash] opts the optional parameters
|
|
284
284
|
# @return [String]
|
|
285
|
-
def
|
|
286
|
-
data, _status_code, _headers =
|
|
285
|
+
def get_public_composition_iframe(composition_id, opts = {})
|
|
286
|
+
data, _status_code, _headers = get_public_composition_iframe_with_http_info(composition_id, opts)
|
|
287
287
|
data
|
|
288
288
|
end
|
|
289
289
|
|
|
@@ -292,13 +292,13 @@ module ApiSdkRb
|
|
|
292
292
|
# @param composition_id [String]
|
|
293
293
|
# @param [Hash] opts the optional parameters
|
|
294
294
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
295
|
-
def
|
|
295
|
+
def get_public_composition_iframe_with_http_info(composition_id, opts = {})
|
|
296
296
|
if @api_client.config.debugging
|
|
297
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
297
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.get_public_composition_iframe ...'
|
|
298
298
|
end
|
|
299
299
|
# verify the required parameter 'composition_id' is set
|
|
300
300
|
if @api_client.config.client_side_validation && composition_id.nil?
|
|
301
|
-
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.
|
|
301
|
+
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.get_public_composition_iframe"
|
|
302
302
|
end
|
|
303
303
|
# resource path
|
|
304
304
|
local_var_path = '/embed/compositions/{compositionId}/frame'.sub('{' + 'compositionId' + '}', CGI.escape(composition_id.to_s))
|
|
@@ -324,7 +324,7 @@ module ApiSdkRb
|
|
|
324
324
|
auth_names = opts[:debug_auth_names] || []
|
|
325
325
|
|
|
326
326
|
new_options = opts.merge(
|
|
327
|
-
:operation => :"PublicEmbedApi.
|
|
327
|
+
:operation => :"PublicEmbedApi.get_public_composition_iframe",
|
|
328
328
|
:header_params => header_params,
|
|
329
329
|
:query_params => query_params,
|
|
330
330
|
:form_params => form_params,
|
|
@@ -335,7 +335,7 @@ module ApiSdkRb
|
|
|
335
335
|
|
|
336
336
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
337
337
|
if @api_client.config.debugging
|
|
338
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
338
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#get_public_composition_iframe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
339
339
|
end
|
|
340
340
|
return data, status_code, headers
|
|
341
341
|
end
|
|
@@ -344,9 +344,9 @@ module ApiSdkRb
|
|
|
344
344
|
# Public read of a workflow for the embed that carries `workflow-id`. No API key. The answer is the live version (its graph, the composition a new visitor starts on, the time zone, the languages its compositions can be shown in, and the token that lets the browser report counts), or `status: paused` with nothing else, in which case the embed shows only its first composition. A workflow that is a draft, archived or unknown answers 404, and the embed then behaves as a plain embed of its `composition-id`. So does a workflow whose owner is not being served (a plan that lapsed, a partner whose agreement is not in force): the answer is the one the compositions of that owner give. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag. The answer may be reused for a few seconds (`Cache-Control: public, max-age=15`), so a publish or a pause reaches visitors within moments. The graph is readable by anyone who has the workflow's id: its rules run in the visitor's browser, so a rule must never hold a secret.
|
|
345
345
|
# @param workflow_id [String]
|
|
346
346
|
# @param [Hash] opts the optional parameters
|
|
347
|
-
# @return [
|
|
348
|
-
def
|
|
349
|
-
data, _status_code, _headers =
|
|
347
|
+
# @return [PublicWorkflowResponse]
|
|
348
|
+
def get_public_workflow(workflow_id, opts = {})
|
|
349
|
+
data, _status_code, _headers = get_public_workflow_with_http_info(workflow_id, opts)
|
|
350
350
|
data
|
|
351
351
|
end
|
|
352
352
|
|
|
@@ -354,14 +354,14 @@ module ApiSdkRb
|
|
|
354
354
|
# Public read of a workflow for the embed that carries `workflow-id`. No API key. The answer is the live version (its graph, the composition a new visitor starts on, the time zone, the languages its compositions can be shown in, and the token that lets the browser report counts), or `status: paused` with nothing else, in which case the embed shows only its first composition. A workflow that is a draft, archived or unknown answers 404, and the embed then behaves as a plain embed of its `composition-id`. So does a workflow whose owner is not being served (a plan that lapsed, a partner whose agreement is not in force): the answer is the one the compositions of that owner give. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag. The answer may be reused for a few seconds (`Cache-Control: public, max-age=15`), so a publish or a pause reaches visitors within moments. The graph is readable by anyone who has the workflow's id: its rules run in the visitor's browser, so a rule must never hold a secret.
|
|
355
355
|
# @param workflow_id [String]
|
|
356
356
|
# @param [Hash] opts the optional parameters
|
|
357
|
-
# @return [Array<(
|
|
358
|
-
def
|
|
357
|
+
# @return [Array<(PublicWorkflowResponse, Integer, Hash)>] PublicWorkflowResponse data, response status code and response headers
|
|
358
|
+
def get_public_workflow_with_http_info(workflow_id, opts = {})
|
|
359
359
|
if @api_client.config.debugging
|
|
360
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
360
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.get_public_workflow ...'
|
|
361
361
|
end
|
|
362
362
|
# verify the required parameter 'workflow_id' is set
|
|
363
363
|
if @api_client.config.client_side_validation && workflow_id.nil?
|
|
364
|
-
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.
|
|
364
|
+
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.get_public_workflow"
|
|
365
365
|
end
|
|
366
366
|
# resource path
|
|
367
367
|
local_var_path = '/embed/workflows/{workflowId}'.sub('{' + 'workflowId' + '}', CGI.escape(workflow_id.to_s))
|
|
@@ -381,13 +381,13 @@ module ApiSdkRb
|
|
|
381
381
|
post_body = opts[:debug_body]
|
|
382
382
|
|
|
383
383
|
# return_type
|
|
384
|
-
return_type = opts[:debug_return_type] || '
|
|
384
|
+
return_type = opts[:debug_return_type] || 'PublicWorkflowResponse'
|
|
385
385
|
|
|
386
386
|
# auth_names
|
|
387
387
|
auth_names = opts[:debug_auth_names] || []
|
|
388
388
|
|
|
389
389
|
new_options = opts.merge(
|
|
390
|
-
:operation => :"PublicEmbedApi.
|
|
390
|
+
:operation => :"PublicEmbedApi.get_public_workflow",
|
|
391
391
|
:header_params => header_params,
|
|
392
392
|
:query_params => query_params,
|
|
393
393
|
:form_params => form_params,
|
|
@@ -398,33 +398,33 @@ module ApiSdkRb
|
|
|
398
398
|
|
|
399
399
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
400
400
|
if @api_client.config.debugging
|
|
401
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
401
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#get_public_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
402
402
|
end
|
|
403
403
|
return data, status_code, headers
|
|
404
404
|
end
|
|
405
405
|
|
|
406
406
|
# Show a published Workflow in a page of its own
|
|
407
|
-
# A page that runs a published workflow, for a place that can only be given an address or an iframe: a chat messenger, a link page, a site builder, a blog that follows oEmbed. No API key, no SDK to add. The page holds the Embed SDK and the same tag a website carries (`<widgetic workflow-id composition-id>`), so a visitor moves from one composition to the next in place, by the same rules, exactly as on a website. A paused workflow shows its first composition alone, as its embeds do. **What the frame can count.** Only what happens inside it: entries, a widget's goals and actions, and waits. The page events a website can send to a workflow (`widgetic:workflow-event`) are events of the page around the embed, and they do not cross an iframe, so a connection that waits for one never fires from a frame. A workflow that is a draft, is archived, or does not exist, and one whose owner is not being served, answers 404 with a short page that gives no reason. If the owner of the workflow's first composition listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic's own), so a browser refuses to show it inside any other website. Opening the address directly still works. An owner who listed nothing is not restricted. The page links its oEmbed card, so a site that follows oEmbed turns the address of the frame into an embed. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
407
|
+
# A page that runs a published workflow, for a place that can only be given an address or an iframe: a chat messenger, a link page, a site builder, a blog that follows oEmbed. No API key, no SDK to add. The page holds the Embed SDK and the same tag a website carries (`<widgetic workflow-id composition-id>`), so a visitor moves from one composition to the next in place, by the same rules, exactly as on a website. A paused workflow shows its first composition alone, as its embeds do. **What the frame can count.** Only what happens inside it: entries, a widget's goals and actions, and waits. The page events a website can send to a workflow (`widgetic:workflow-event`) are events of the page around the embed, and they do not cross an iframe, so a connection that waits for one never fires from a frame. A workflow that is a draft, is archived, or does not exist, and one whose owner is not being served, answers 404 with a short page that gives no reason. If the owner of the workflow's first composition listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic's own, and the website where the partner the owner administers integrates Widgetic, with its subdomains), so a browser refuses to show it inside any other website. Opening the address directly still works. An owner who listed nothing is not restricted. The page links its oEmbed card, so a site that follows oEmbed turns the address of the frame into an embed. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
408
408
|
# @param workflow_id [String]
|
|
409
409
|
# @param [Hash] opts the optional parameters
|
|
410
410
|
# @return [String]
|
|
411
|
-
def
|
|
412
|
-
data, _status_code, _headers =
|
|
411
|
+
def get_public_workflow_frame(workflow_id, opts = {})
|
|
412
|
+
data, _status_code, _headers = get_public_workflow_frame_with_http_info(workflow_id, opts)
|
|
413
413
|
data
|
|
414
414
|
end
|
|
415
415
|
|
|
416
416
|
# Show a published Workflow in a page of its own
|
|
417
|
-
# A page that runs a published workflow, for a place that can only be given an address or an iframe: a chat messenger, a link page, a site builder, a blog that follows oEmbed. No API key, no SDK to add. The page holds the Embed SDK and the same tag a website carries (`<widgetic workflow-id composition-id>`), so a visitor moves from one composition to the next in place, by the same rules, exactly as on a website. A paused workflow shows its first composition alone, as its embeds do. **What the frame can count.** Only what happens inside it: entries, a widget's goals and actions, and waits. The page events a website can send to a workflow (`widgetic:workflow-event`) are events of the page around the embed, and they do not cross an iframe, so a connection that waits for one never fires from a frame. A workflow that is a draft, is archived, or does not exist, and one whose owner is not being served, answers 404 with a short page that gives no reason. If the owner of the workflow's first composition listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic's own), so a browser refuses to show it inside any other website. Opening the address directly still works. An owner who listed nothing is not restricted. The page links its oEmbed card, so a site that follows oEmbed turns the address of the frame into an embed. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
417
|
+
# A page that runs a published workflow, for a place that can only be given an address or an iframe: a chat messenger, a link page, a site builder, a blog that follows oEmbed. No API key, no SDK to add. The page holds the Embed SDK and the same tag a website carries (`<widgetic workflow-id composition-id>`), so a visitor moves from one composition to the next in place, by the same rules, exactly as on a website. A paused workflow shows its first composition alone, as its embeds do. **What the frame can count.** Only what happens inside it: entries, a widget's goals and actions, and waits. The page events a website can send to a workflow (`widgetic:workflow-event`) are events of the page around the embed, and they do not cross an iframe, so a connection that waits for one never fires from a frame. A workflow that is a draft, is archived, or does not exist, and one whose owner is not being served, answers 404 with a short page that gives no reason. If the owner of the workflow's first composition listed the websites it may appear on, the page is sent with `Content-Security-Policy: frame-ancestors` naming those websites (and Widgetic's own, and the website where the partner the owner administers integrates Widgetic, with its subdomains), so a browser refuses to show it inside any other website. Opening the address directly still works. An owner who listed nothing is not restricted. The page links its oEmbed card, so a site that follows oEmbed turns the address of the frame into an embed. **Address.** `https://api.widgetic.com/embed/workflows/{workflowId}/frame`: the root of the API host, NOT under `/v1`. A client generated from this description for `https://api.widgetic.com/v1` must be given the base address `https://api.widgetic.com` for the calls of the `Public Embed` tag.
|
|
418
418
|
# @param workflow_id [String]
|
|
419
419
|
# @param [Hash] opts the optional parameters
|
|
420
420
|
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
421
|
-
def
|
|
421
|
+
def get_public_workflow_frame_with_http_info(workflow_id, opts = {})
|
|
422
422
|
if @api_client.config.debugging
|
|
423
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
423
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.get_public_workflow_frame ...'
|
|
424
424
|
end
|
|
425
425
|
# verify the required parameter 'workflow_id' is set
|
|
426
426
|
if @api_client.config.client_side_validation && workflow_id.nil?
|
|
427
|
-
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.
|
|
427
|
+
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.get_public_workflow_frame"
|
|
428
428
|
end
|
|
429
429
|
# resource path
|
|
430
430
|
local_var_path = '/embed/workflows/{workflowId}/frame'.sub('{' + 'workflowId' + '}', CGI.escape(workflow_id.to_s))
|
|
@@ -450,7 +450,7 @@ module ApiSdkRb
|
|
|
450
450
|
auth_names = opts[:debug_auth_names] || []
|
|
451
451
|
|
|
452
452
|
new_options = opts.merge(
|
|
453
|
-
:operation => :"PublicEmbedApi.
|
|
453
|
+
:operation => :"PublicEmbedApi.get_public_workflow_frame",
|
|
454
454
|
:header_params => header_params,
|
|
455
455
|
:query_params => query_params,
|
|
456
456
|
:form_params => form_params,
|
|
@@ -461,7 +461,7 @@ module ApiSdkRb
|
|
|
461
461
|
|
|
462
462
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
463
463
|
if @api_client.config.debugging
|
|
464
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
464
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#get_public_workflow_frame\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
465
465
|
end
|
|
466
466
|
return data, status_code, headers
|
|
467
467
|
end
|
|
@@ -471,9 +471,9 @@ module ApiSdkRb
|
|
|
471
471
|
# @param workflow_id [String]
|
|
472
472
|
# @param version_id [String]
|
|
473
473
|
# @param [Hash] opts the optional parameters
|
|
474
|
-
# @return [
|
|
475
|
-
def
|
|
476
|
-
data, _status_code, _headers =
|
|
474
|
+
# @return [PublicWorkflowResponse]
|
|
475
|
+
def get_public_workflow_version(workflow_id, version_id, opts = {})
|
|
476
|
+
data, _status_code, _headers = get_public_workflow_version_with_http_info(workflow_id, version_id, opts)
|
|
477
477
|
data
|
|
478
478
|
end
|
|
479
479
|
|
|
@@ -482,18 +482,18 @@ module ApiSdkRb
|
|
|
482
482
|
# @param workflow_id [String]
|
|
483
483
|
# @param version_id [String]
|
|
484
484
|
# @param [Hash] opts the optional parameters
|
|
485
|
-
# @return [Array<(
|
|
486
|
-
def
|
|
485
|
+
# @return [Array<(PublicWorkflowResponse, Integer, Hash)>] PublicWorkflowResponse data, response status code and response headers
|
|
486
|
+
def get_public_workflow_version_with_http_info(workflow_id, version_id, opts = {})
|
|
487
487
|
if @api_client.config.debugging
|
|
488
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
488
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.get_public_workflow_version ...'
|
|
489
489
|
end
|
|
490
490
|
# verify the required parameter 'workflow_id' is set
|
|
491
491
|
if @api_client.config.client_side_validation && workflow_id.nil?
|
|
492
|
-
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.
|
|
492
|
+
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.get_public_workflow_version"
|
|
493
493
|
end
|
|
494
494
|
# verify the required parameter 'version_id' is set
|
|
495
495
|
if @api_client.config.client_side_validation && version_id.nil?
|
|
496
|
-
fail ArgumentError, "Missing the required parameter 'version_id' when calling PublicEmbedApi.
|
|
496
|
+
fail ArgumentError, "Missing the required parameter 'version_id' when calling PublicEmbedApi.get_public_workflow_version"
|
|
497
497
|
end
|
|
498
498
|
# resource path
|
|
499
499
|
local_var_path = '/embed/workflows/{workflowId}/versions/{versionId}'.sub('{' + 'workflowId' + '}', CGI.escape(workflow_id.to_s)).sub('{' + 'versionId' + '}', CGI.escape(version_id.to_s))
|
|
@@ -513,13 +513,13 @@ module ApiSdkRb
|
|
|
513
513
|
post_body = opts[:debug_body]
|
|
514
514
|
|
|
515
515
|
# return_type
|
|
516
|
-
return_type = opts[:debug_return_type] || '
|
|
516
|
+
return_type = opts[:debug_return_type] || 'PublicWorkflowResponse'
|
|
517
517
|
|
|
518
518
|
# auth_names
|
|
519
519
|
auth_names = opts[:debug_auth_names] || []
|
|
520
520
|
|
|
521
521
|
new_options = opts.merge(
|
|
522
|
-
:operation => :"PublicEmbedApi.
|
|
522
|
+
:operation => :"PublicEmbedApi.get_public_workflow_version",
|
|
523
523
|
:header_params => header_params,
|
|
524
524
|
:query_params => query_params,
|
|
525
525
|
:form_params => form_params,
|
|
@@ -530,7 +530,7 @@ module ApiSdkRb
|
|
|
530
530
|
|
|
531
531
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
532
532
|
if @api_client.config.debugging
|
|
533
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
533
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#get_public_workflow_version\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
534
534
|
end
|
|
535
535
|
return data, status_code, headers
|
|
536
536
|
end
|
|
@@ -540,8 +540,8 @@ module ApiSdkRb
|
|
|
540
540
|
# @param post_public_composition_embed_status_request [PostPublicCompositionEmbedStatusRequest]
|
|
541
541
|
# @param [Hash] opts the optional parameters
|
|
542
542
|
# @return [PostPublicCompositionEmbedStatus200Response]
|
|
543
|
-
def
|
|
544
|
-
data, _status_code, _headers =
|
|
543
|
+
def post_public_composition_embed_status(post_public_composition_embed_status_request, opts = {})
|
|
544
|
+
data, _status_code, _headers = post_public_composition_embed_status_with_http_info(post_public_composition_embed_status_request, opts)
|
|
545
545
|
data
|
|
546
546
|
end
|
|
547
547
|
|
|
@@ -550,13 +550,13 @@ module ApiSdkRb
|
|
|
550
550
|
# @param post_public_composition_embed_status_request [PostPublicCompositionEmbedStatusRequest]
|
|
551
551
|
# @param [Hash] opts the optional parameters
|
|
552
552
|
# @return [Array<(PostPublicCompositionEmbedStatus200Response, Integer, Hash)>] PostPublicCompositionEmbedStatus200Response data, response status code and response headers
|
|
553
|
-
def
|
|
553
|
+
def post_public_composition_embed_status_with_http_info(post_public_composition_embed_status_request, opts = {})
|
|
554
554
|
if @api_client.config.debugging
|
|
555
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
555
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.post_public_composition_embed_status ...'
|
|
556
556
|
end
|
|
557
557
|
# verify the required parameter 'post_public_composition_embed_status_request' is set
|
|
558
558
|
if @api_client.config.client_side_validation && post_public_composition_embed_status_request.nil?
|
|
559
|
-
fail ArgumentError, "Missing the required parameter 'post_public_composition_embed_status_request' when calling PublicEmbedApi.
|
|
559
|
+
fail ArgumentError, "Missing the required parameter 'post_public_composition_embed_status_request' when calling PublicEmbedApi.post_public_composition_embed_status"
|
|
560
560
|
end
|
|
561
561
|
# resource path
|
|
562
562
|
local_var_path = '/embed/compositions/status'
|
|
@@ -587,7 +587,7 @@ module ApiSdkRb
|
|
|
587
587
|
auth_names = opts[:debug_auth_names] || []
|
|
588
588
|
|
|
589
589
|
new_options = opts.merge(
|
|
590
|
-
:operation => :"PublicEmbedApi.
|
|
590
|
+
:operation => :"PublicEmbedApi.post_public_composition_embed_status",
|
|
591
591
|
:header_params => header_params,
|
|
592
592
|
:query_params => query_params,
|
|
593
593
|
:form_params => form_params,
|
|
@@ -598,7 +598,7 @@ module ApiSdkRb
|
|
|
598
598
|
|
|
599
599
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
600
600
|
if @api_client.config.debugging
|
|
601
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
601
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#post_public_composition_embed_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
602
602
|
end
|
|
603
603
|
return data, status_code, headers
|
|
604
604
|
end
|
|
@@ -609,8 +609,8 @@ module ApiSdkRb
|
|
|
609
609
|
# @param public_workflow_events_request [PublicWorkflowEventsRequest]
|
|
610
610
|
# @param [Hash] opts the optional parameters
|
|
611
611
|
# @return [ReportPublicWorkflowEvents200Response]
|
|
612
|
-
def
|
|
613
|
-
data, _status_code, _headers =
|
|
612
|
+
def report_public_workflow_events(workflow_id, public_workflow_events_request, opts = {})
|
|
613
|
+
data, _status_code, _headers = report_public_workflow_events_with_http_info(workflow_id, public_workflow_events_request, opts)
|
|
614
614
|
data
|
|
615
615
|
end
|
|
616
616
|
|
|
@@ -620,17 +620,17 @@ module ApiSdkRb
|
|
|
620
620
|
# @param public_workflow_events_request [PublicWorkflowEventsRequest]
|
|
621
621
|
# @param [Hash] opts the optional parameters
|
|
622
622
|
# @return [Array<(ReportPublicWorkflowEvents200Response, Integer, Hash)>] ReportPublicWorkflowEvents200Response data, response status code and response headers
|
|
623
|
-
def
|
|
623
|
+
def report_public_workflow_events_with_http_info(workflow_id, public_workflow_events_request, opts = {})
|
|
624
624
|
if @api_client.config.debugging
|
|
625
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
625
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.report_public_workflow_events ...'
|
|
626
626
|
end
|
|
627
627
|
# verify the required parameter 'workflow_id' is set
|
|
628
628
|
if @api_client.config.client_side_validation && workflow_id.nil?
|
|
629
|
-
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.
|
|
629
|
+
fail ArgumentError, "Missing the required parameter 'workflow_id' when calling PublicEmbedApi.report_public_workflow_events"
|
|
630
630
|
end
|
|
631
631
|
# verify the required parameter 'public_workflow_events_request' is set
|
|
632
632
|
if @api_client.config.client_side_validation && public_workflow_events_request.nil?
|
|
633
|
-
fail ArgumentError, "Missing the required parameter 'public_workflow_events_request' when calling PublicEmbedApi.
|
|
633
|
+
fail ArgumentError, "Missing the required parameter 'public_workflow_events_request' when calling PublicEmbedApi.report_public_workflow_events"
|
|
634
634
|
end
|
|
635
635
|
# resource path
|
|
636
636
|
local_var_path = '/embed/workflows/{workflowId}/events'.sub('{' + 'workflowId' + '}', CGI.escape(workflow_id.to_s))
|
|
@@ -661,7 +661,7 @@ module ApiSdkRb
|
|
|
661
661
|
auth_names = opts[:debug_auth_names] || []
|
|
662
662
|
|
|
663
663
|
new_options = opts.merge(
|
|
664
|
-
:operation => :"PublicEmbedApi.
|
|
664
|
+
:operation => :"PublicEmbedApi.report_public_workflow_events",
|
|
665
665
|
:header_params => header_params,
|
|
666
666
|
:query_params => query_params,
|
|
667
667
|
:form_params => form_params,
|
|
@@ -672,7 +672,7 @@ module ApiSdkRb
|
|
|
672
672
|
|
|
673
673
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
674
674
|
if @api_client.config.debugging
|
|
675
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
675
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#report_public_workflow_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
676
676
|
end
|
|
677
677
|
return data, status_code, headers
|
|
678
678
|
end
|
|
@@ -684,8 +684,8 @@ module ApiSdkRb
|
|
|
684
684
|
# @param body [File]
|
|
685
685
|
# @param [Hash] opts the optional parameters
|
|
686
686
|
# @return [PublicAdapterFileResult]
|
|
687
|
-
def
|
|
688
|
-
data, _status_code, _headers =
|
|
687
|
+
def upload_public_composition_adapter_file(composition_id, ticket, body, opts = {})
|
|
688
|
+
data, _status_code, _headers = upload_public_composition_adapter_file_with_http_info(composition_id, ticket, body, opts)
|
|
689
689
|
data
|
|
690
690
|
end
|
|
691
691
|
|
|
@@ -696,34 +696,34 @@ module ApiSdkRb
|
|
|
696
696
|
# @param body [File]
|
|
697
697
|
# @param [Hash] opts the optional parameters
|
|
698
698
|
# @return [Array<(PublicAdapterFileResult, Integer, Hash)>] PublicAdapterFileResult data, response status code and response headers
|
|
699
|
-
def
|
|
699
|
+
def upload_public_composition_adapter_file_with_http_info(composition_id, ticket, body, opts = {})
|
|
700
700
|
if @api_client.config.debugging
|
|
701
|
-
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.
|
|
701
|
+
@api_client.config.logger.debug 'Calling API: PublicEmbedApi.upload_public_composition_adapter_file ...'
|
|
702
702
|
end
|
|
703
703
|
# verify the required parameter 'composition_id' is set
|
|
704
704
|
if @api_client.config.client_side_validation && composition_id.nil?
|
|
705
|
-
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.
|
|
705
|
+
fail ArgumentError, "Missing the required parameter 'composition_id' when calling PublicEmbedApi.upload_public_composition_adapter_file"
|
|
706
706
|
end
|
|
707
707
|
# verify the required parameter 'ticket' is set
|
|
708
708
|
if @api_client.config.client_side_validation && ticket.nil?
|
|
709
|
-
fail ArgumentError, "Missing the required parameter 'ticket' when calling PublicEmbedApi.
|
|
709
|
+
fail ArgumentError, "Missing the required parameter 'ticket' when calling PublicEmbedApi.upload_public_composition_adapter_file"
|
|
710
710
|
end
|
|
711
711
|
if @api_client.config.client_side_validation && ticket.to_s.length > 128
|
|
712
|
-
fail ArgumentError, 'invalid value for "ticket" when calling PublicEmbedApi.
|
|
712
|
+
fail ArgumentError, 'invalid value for "ticket" when calling PublicEmbedApi.upload_public_composition_adapter_file, the character length must be smaller than or equal to 128.'
|
|
713
713
|
end
|
|
714
714
|
|
|
715
715
|
if @api_client.config.client_side_validation && ticket.to_s.length < 20
|
|
716
|
-
fail ArgumentError, 'invalid value for "ticket" when calling PublicEmbedApi.
|
|
716
|
+
fail ArgumentError, 'invalid value for "ticket" when calling PublicEmbedApi.upload_public_composition_adapter_file, the character length must be great than or equal to 20.'
|
|
717
717
|
end
|
|
718
718
|
|
|
719
719
|
pattern = Regexp.new(/^[A-Za-z0-9_-]{20,128}$/)
|
|
720
720
|
if @api_client.config.client_side_validation && ticket !~ pattern
|
|
721
|
-
fail ArgumentError, "invalid value for 'ticket' when calling PublicEmbedApi.
|
|
721
|
+
fail ArgumentError, "invalid value for 'ticket' when calling PublicEmbedApi.upload_public_composition_adapter_file, must conform to the pattern #{pattern}."
|
|
722
722
|
end
|
|
723
723
|
|
|
724
724
|
# verify the required parameter 'body' is set
|
|
725
725
|
if @api_client.config.client_side_validation && body.nil?
|
|
726
|
-
fail ArgumentError, "Missing the required parameter 'body' when calling PublicEmbedApi.
|
|
726
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling PublicEmbedApi.upload_public_composition_adapter_file"
|
|
727
727
|
end
|
|
728
728
|
# resource path
|
|
729
729
|
local_var_path = '/embed/compositions/{compositionId}/adapters/upload/files/{ticket}'.sub('{' + 'compositionId' + '}', CGI.escape(composition_id.to_s)).sub('{' + 'ticket' + '}', CGI.escape(ticket.to_s))
|
|
@@ -754,7 +754,7 @@ module ApiSdkRb
|
|
|
754
754
|
auth_names = opts[:debug_auth_names] || []
|
|
755
755
|
|
|
756
756
|
new_options = opts.merge(
|
|
757
|
-
:operation => :"PublicEmbedApi.
|
|
757
|
+
:operation => :"PublicEmbedApi.upload_public_composition_adapter_file",
|
|
758
758
|
:header_params => header_params,
|
|
759
759
|
:query_params => query_params,
|
|
760
760
|
:form_params => form_params,
|
|
@@ -765,7 +765,7 @@ module ApiSdkRb
|
|
|
765
765
|
|
|
766
766
|
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
767
767
|
if @api_client.config.debugging
|
|
768
|
-
@api_client.config.logger.debug "API called: PublicEmbedApi#
|
|
768
|
+
@api_client.config.logger.debug "API called: PublicEmbedApi#upload_public_composition_adapter_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
769
769
|
end
|
|
770
770
|
return data, status_code, headers
|
|
771
771
|
end
|