Module: EmbedWorkflow

Defined in:
lib/embed_workflow/version.rb,
lib/embed_workflow.rb,
lib/embed_workflow/api_error.rb,
lib/embed_workflow/api_client.rb,
lib/embed_workflow/api/users_api.rb,
lib/embed_workflow/configuration.rb,
lib/embed_workflow/api/events_api.rb,
lib/embed_workflow/api/actions_api.rb,
lib/embed_workflow/api/accounts_api.rb,
lib/embed_workflow/api/payments_api.rb,
lib/embed_workflow/api/triggers_api.rb,
lib/embed_workflow/api/workflows_api.rb,
lib/embed_workflow/api/executions_api.rb,
lib/embed_workflow/api/data_fields_api.rb,
lib/embed_workflow/api/action_types_api.rb,
lib/embed_workflow/api/available_apps_api.rb,
lib/embed_workflow/api/installed_apps_api.rb,
lib/embed_workflow/api/app_connections_api.rb,
lib/embed_workflow/models/catch_hook_request.rb,
lib/embed_workflow/models/install_app_request.rb,
lib/embed_workflow/models/upsert_user_request.rb,
lib/embed_workflow/models/retry_action_request.rb,
lib/embed_workflow/models/list_users200_response.rb,
lib/embed_workflow/models/update_account_request.rb,
lib/embed_workflow/models/update_trigger_request.rb,
lib/embed_workflow/models/create_workflow_request.rb,
lib/embed_workflow/models/install_app201_response.rb,
lib/embed_workflow/models/list_events200_response.rb,
lib/embed_workflow/models/stop_executions_request.rb,
lib/embed_workflow/models/update_workflow_request.rb,
lib/embed_workflow/models/execute_workflow_request.rb,
lib/embed_workflow/models/list_actions200_response.rb,
lib/embed_workflow/models/publish_workflow_request.rb,
lib/embed_workflow/models/trigger_workflow_request.rb,
lib/embed_workflow/models/create_user_token_request.rb,
lib/embed_workflow/models/list_triggers200_response.rb,
lib/embed_workflow/models/create_action_type_request.rb,
lib/embed_workflow/models/list_workflows200_response.rb,
lib/embed_workflow/models/update_action_type_request.rb,
lib/embed_workflow/models/create_workflow201_response.rb,
lib/embed_workflow/models/delete_workflow200_response.rb,
lib/embed_workflow/models/evaluate_expression_request.rb,
lib/embed_workflow/models/execute_workflow201_response.rb,
lib/embed_workflow/models/import_configuration_request.rb,
lib/embed_workflow/models/list_data_fields200_response.rb,
lib/embed_workflow/models/retrieve_account200_response.rb,
lib/embed_workflow/models/update_installed_app_request.rb,
lib/embed_workflow/models/create_app_connection_request.rb,
lib/embed_workflow/models/create_user_token200_response.rb,
lib/embed_workflow/models/list_action_types200_response.rb,
lib/embed_workflow/models/create_action_type422_response.rb,
lib/embed_workflow/models/delete_action_type200_response.rb,
lib/embed_workflow/models/discard_workflow_draft_request.rb,
lib/embed_workflow/models/retrieve_execution200_response.rb,
lib/embed_workflow/models/evaluate_expression200_response.rb,
lib/embed_workflow/models/list_available_apps200_response.rb,
lib/embed_workflow/models/list_data_fields_type_parameter.rb,
lib/embed_workflow/models/list_installed_apps200_response.rb,
lib/embed_workflow/models/export_configuration200_response.rb,
lib/embed_workflow/models/import_configuration201_response.rb,
lib/embed_workflow/models/list_app_connections200_response.rb,
lib/embed_workflow/models/delete_workflow200_response_one_of.rb,
lib/embed_workflow/models/list_action_types200_response_meta.rb,
lib/embed_workflow/models/list_workflow_versions200_response.rb,
lib/embed_workflow/models/retrieve_account_usage200_response.rb,
lib/embed_workflow/models/retrieve_available_app200_response.rb,
lib/embed_workflow/models/delete_workflow200_response_one_of1.rb,
lib/embed_workflow/models/import_configuration_request_schema.rb,
lib/embed_workflow/models/list_workflow_executions200_response.rb,
lib/embed_workflow/models/create_action_type_request_icon_draft.rb,
lib/embed_workflow/models/create_workflow_request_template_draft.rb,
lib/embed_workflow/models/list_users200_response_collection_inner.rb,
lib/embed_workflow/models/list_events200_response_collection_inner.rb,
lib/embed_workflow/models/list_actions200_response_collection_inner.rb,
lib/embed_workflow/models/list_triggers200_response_collection_inner.rb,
lib/embed_workflow/models/create_action_type_request_form_draft_inner.rb,
lib/embed_workflow/models/list_workflows200_response_collection_inner.rb,
lib/embed_workflow/models/list_data_fields200_response_collection_inner.rb,
lib/embed_workflow/models/update_account_request_user_data_schema_inner.rb,
lib/embed_workflow/models/export_configuration200_response_configuration.rb,
lib/embed_workflow/models/list_action_types200_response_collection_inner.rb,
lib/embed_workflow/models/list_available_apps200_response_collection_inner.rb,
lib/embed_workflow/models/list_installed_apps200_response_collection_inner.rb,
lib/embed_workflow/models/list_app_connections200_response_collection_inner.rb,
lib/embed_workflow/models/create_workflow_request_template_draft_nodes_inner.rb,
lib/embed_workflow/models/list_workflow_versions200_response_collection_inner.rb,
lib/embed_workflow/models/update_account_request_action_type_categories_inner.rb,
lib/embed_workflow/models/update_account_request_action_type_categories_inner_icon.rb

Overview

#API V1

#No description provided (generated by Openapi Generator github.com/openapitools/openapi-generator)

The version of the OpenAPI document: v1

Generated by: openapi-generator.tech OpenAPI Generator version: 7.2.0

Defined Under Namespace

Modules: DeleteWorkflow200Response, ExportConfiguration200ResponseConfiguration, ImportConfigurationRequestSchema, ListDataFieldsTypeParameter Classes: AccountsApi, ActionTypesApi, ActionsApi, ApiClient, ApiError, AppConnectionsApi, AvailableAppsApi, CatchHookRequest, Client, Configuration, CreateActionType422Response, CreateActionTypeRequest, CreateActionTypeRequestFormDraftInner, CreateActionTypeRequestIconDraft, CreateAppConnectionRequest, CreateUserToken200Response, CreateUserTokenRequest, CreateWorkflow201Response, CreateWorkflowRequest, CreateWorkflowRequestTemplateDraft, CreateWorkflowRequestTemplateDraftNodesInner, DataFieldsApi, DeleteActionType200Response, DeleteWorkflow200ResponseOneOf, DeleteWorkflow200ResponseOneOf1, DiscardWorkflowDraftRequest, EvaluateExpression200Response, EvaluateExpressionRequest, EventsApi, ExecuteWorkflow201Response, ExecuteWorkflowRequest, ExecutionsApi, ExportConfiguration200Response, ImportConfiguration201Response, ImportConfigurationRequest, InstallApp201Response, InstallAppRequest, InstalledAppsApi, ListActionTypes200Response, ListActionTypes200ResponseCollectionInner, ListActionTypes200ResponseMeta, ListActions200Response, ListActions200ResponseCollectionInner, ListAppConnections200Response, ListAppConnections200ResponseCollectionInner, ListAvailableApps200Response, ListAvailableApps200ResponseCollectionInner, ListDataFields200Response, ListDataFields200ResponseCollectionInner, ListEvents200Response, ListEvents200ResponseCollectionInner, ListInstalledApps200Response, ListInstalledApps200ResponseCollectionInner, ListTriggers200Response, ListTriggers200ResponseCollectionInner, ListUsers200Response, ListUsers200ResponseCollectionInner, ListWorkflowExecutions200Response, ListWorkflowVersions200Response, ListWorkflowVersions200ResponseCollectionInner, ListWorkflows200Response, ListWorkflows200ResponseCollectionInner, PaymentsApi, PublishWorkflowRequest, RetrieveAccount200Response, RetrieveAccountUsage200Response, RetrieveAvailableApp200Response, RetrieveExecution200Response, RetryActionRequest, StopExecutionsRequest, TriggerWorkflowRequest, TriggersApi, UpdateAccountRequest, UpdateAccountRequestActionTypeCategoriesInner, UpdateAccountRequestActionTypeCategoriesInnerIcon, UpdateAccountRequestUserDataSchemaInner, UpdateActionTypeRequest, UpdateInstalledAppRequest, UpdateTriggerRequest, UpdateWorkflowRequest, UpsertUserRequest, UsersApi, WorkflowsApi

Constant Summary collapse

VERSION = 
'1.2.0'

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.skey ⇒ String

Returns the configured API key.

Returns:

  • (String) —

    the configured API key



120
121
122
 
# File 'lib/embed_workflow.rb', line 120

def skey
  @skey
end

Class Method Details

.accounts ⇒ EmbedWorkflow::AccountsApi

Returns:



129
130
131
 
# File 'lib/embed_workflow.rb', line 129

def accounts
  client.accounts
end

.action_types ⇒ EmbedWorkflow::ActionTypesApi

Returns:



133
134
135
 
# File 'lib/embed_workflow.rb', line 133

def action_types
  client.action_types
end

.actions ⇒ EmbedWorkflow::ActionsApi

Returns:



137
138
139
 
# File 'lib/embed_workflow.rb', line 137

def actions
  client.actions
end

.app_connections ⇒ EmbedWorkflow::AppConnectionsApi

Returns:



141
142
143
 
# File 'lib/embed_workflow.rb', line 141

def app_connections
  client.app_connections
end

.available_apps ⇒ EmbedWorkflow::AvailableAppsApi

Returns:



145
146
147
 
# File 'lib/embed_workflow.rb', line 145

def available_apps
  client.available_apps
end

.client ⇒ Client

Returns the default client (requires skey to be set first).

Returns:

  • (Client) —

    the default client (requires skey to be set first)



123
124
125
126
 
# File 'lib/embed_workflow.rb', line 123

def client
  raise "#{name}.skey must be set before using the default client" unless @client
  @client
end

.configure ⇒ Object

Customize default settings for the SDK using block.

EmbedWorkflow.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



187
188
189
190
191
192
193
 
# File 'lib/embed_workflow.rb', line 187

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end

.data_fields ⇒ EmbedWorkflow::DataFieldsApi

Returns:



149
150
151
 
# File 'lib/embed_workflow.rb', line 149

def data_fields
  client.data_fields
end

.events ⇒ EmbedWorkflow::EventsApi

Returns:



153
154
155
 
# File 'lib/embed_workflow.rb', line 153

def events
  client.events
end

.executions ⇒ EmbedWorkflow::ExecutionsApi

Returns:



157
158
159
 
# File 'lib/embed_workflow.rb', line 157

def executions
  client.executions
end

.installed_apps ⇒ EmbedWorkflow::InstalledAppsApi

Returns:



161
162
163
 
# File 'lib/embed_workflow.rb', line 161

def installed_apps
  client.installed_apps
end

.payments ⇒ EmbedWorkflow::PaymentsApi

Returns:



165
166
167
 
# File 'lib/embed_workflow.rb', line 165

def payments
  client.payments
end

.triggers ⇒ EmbedWorkflow::TriggersApi

Returns:



169
170
171
 
# File 'lib/embed_workflow.rb', line 169

def triggers
  client.triggers
end

.users ⇒ EmbedWorkflow::UsersApi

Returns:



173
174
175
 
# File 'lib/embed_workflow.rb', line 173

def users
  client.users
end

.workflows ⇒ EmbedWorkflow::WorkflowsApi

Returns:



177
178
179
 
# File 'lib/embed_workflow.rb', line 177

def workflows
  client.workflows
end