zyphr 0.1.39 → 0.1.41

data/lib/zyphr/api/workflows_api.rb

@@ -0,0 +1,897 @@
+=begin
+#Zyphr API
+
+#Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API.  ## Authentication  All API requests require authentication using an API key. Include your API key in the `X-API-Key` header:  ``` X-API-Key: zy_live_xxxxxxxxxxxx ```  API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production.  ## Rate Limiting  The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers:  - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets  ## Account Sending Status  Every authenticated response carries the account's current sending state so you can surface it in your own tooling without a separate call:  - `X-Account-Sending-Status`: `active`, `throttled`, or `frozen` - `X-Account-Sending-Status-Reason`: human-readable reason (present only when the status is `throttled` or `frozen`)  This header is informational and non-blocking on non-send endpoints (reads, billing, and deliverability stay available). Send-capable endpoints additionally enforce the state: a frozen account receives `403 account_frozen` and a throttled account receives `429 account_throttled`, both with the reason in the error message.  ## Errors  All errors follow a consistent format:  ```json {   \"error\": {     \"code\": \"error_code\",     \"message\": \"Human readable message\",     \"details\": {}   },   \"meta\": {     \"request_id\": \"req_xxxx\"   } } ```
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@zyphr.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.12.0
+
+=end
+
+require 'cgi'
+
+module Zyphr
+  class WorkflowsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Add a workflow step
+    # Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`. 
+    # @param key [String] The workflow key.
+    # @param add_workflow_step_request [AddWorkflowStepRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AddWorkflowStep201Response]
+    def add_workflow_step(key, add_workflow_step_request, opts = {})
+      data, _status_code, _headers = add_workflow_step_with_http_info(key, add_workflow_step_request, opts)
+      data
+    end
+
+    # Add a workflow step
+    # Append a step to a workflow. Channel steps (`email`, `push`, `sms`, `in_app`, `slack`, `discord`, `teams`) carry message content in `config`; `delay` steps carry `{ amount, unit }`; `branch` steps carry `{ conditions }`. 
+    # @param key [String] The workflow key.
+    # @param add_workflow_step_request [AddWorkflowStepRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AddWorkflowStep201Response, Integer, Hash)>] AddWorkflowStep201Response data, response status code and response headers
+    def add_workflow_step_with_http_info(key, add_workflow_step_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.add_workflow_step ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.add_workflow_step"
+      end
+      # verify the required parameter 'add_workflow_step_request' is set
+      if @api_client.config.client_side_validation && add_workflow_step_request.nil?
+        fail ArgumentError, "Missing the required parameter 'add_workflow_step_request' when calling WorkflowsApi.add_workflow_step"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}/steps'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(add_workflow_step_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AddWorkflowStep201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.add_workflow_step",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#add_workflow_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a workflow
+    # Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique `key` within the project. If `key` is omitted, one is derived from the `name`. 
+    # @param create_workflow_request [CreateWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWorkflow201Response]
+    def create_workflow(create_workflow_request, opts = {})
+      data, _status_code, _headers = create_workflow_with_http_info(create_workflow_request, opts)
+      data
+    end
+
+    # Create a workflow
+    # Create a new notification workflow. A workflow is a named, multi-step notification sequence identified by a unique &#x60;key&#x60; within the project. If &#x60;key&#x60; is omitted, one is derived from the &#x60;name&#x60;. 
+    # @param create_workflow_request [CreateWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWorkflow201Response, Integer, Hash)>] CreateWorkflow201Response data, response status code and response headers
+    def create_workflow_with_http_info(create_workflow_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.create_workflow ...'
+      end
+      # verify the required parameter 'create_workflow_request' is set
+      if @api_client.config.client_side_validation && create_workflow_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_workflow_request' when calling WorkflowsApi.create_workflow"
+      end
+      # resource path
+      local_var_path = '/workflows'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_workflow_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWorkflow201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.create_workflow",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#create_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a workflow
+    # Permanently delete a workflow and all of its steps.
+    # @param key [String] The workflow key.
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteWorkflow200Response]
+    def delete_workflow(key, opts = {})
+      data, _status_code, _headers = delete_workflow_with_http_info(key, opts)
+      data
+    end
+
+    # Delete a workflow
+    # Permanently delete a workflow and all of its steps.
+    # @param key [String] The workflow key.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteWorkflow200Response, Integer, Hash)>] DeleteWorkflow200Response data, response status code and response headers
+    def delete_workflow_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.delete_workflow ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.delete_workflow"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeleteWorkflow200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.delete_workflow",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#delete_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a workflow step
+    # Remove a step from a workflow.
+    # @param key [String] The workflow key.
+    # @param step_key [String] The step key.
+    # @param [Hash] opts the optional parameters
+    # @return [DeleteWorkflowStep200Response]
+    def delete_workflow_step(key, step_key, opts = {})
+      data, _status_code, _headers = delete_workflow_step_with_http_info(key, step_key, opts)
+      data
+    end
+
+    # Delete a workflow step
+    # Remove a step from a workflow.
+    # @param key [String] The workflow key.
+    # @param step_key [String] The step key.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DeleteWorkflowStep200Response, Integer, Hash)>] DeleteWorkflowStep200Response data, response status code and response headers
+    def delete_workflow_step_with_http_info(key, step_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.delete_workflow_step ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.delete_workflow_step"
+      end
+      # verify the required parameter 'step_key' is set
+      if @api_client.config.client_side_validation && step_key.nil?
+        fail ArgumentError, "Missing the required parameter 'step_key' when calling WorkflowsApi.delete_workflow_step"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}/steps/{stepKey}'.sub('{' + 'key' + '}', CGI.escape(key.to_s)).sub('{' + 'stepKey' + '}', CGI.escape(step_key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'DeleteWorkflowStep200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.delete_workflow_step",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#delete_workflow_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a workflow
+    # Retrieve a single workflow by its key, including its ordered steps.
+    # @param key [String] The workflow key.
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWorkflow201Response]
+    def get_workflow(key, opts = {})
+      data, _status_code, _headers = get_workflow_with_http_info(key, opts)
+      data
+    end
+
+    # Get a workflow
+    # Retrieve a single workflow by its key, including its ordered steps.
+    # @param key [String] The workflow key.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWorkflow201Response, Integer, Hash)>] CreateWorkflow201Response data, response status code and response headers
+    def get_workflow_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.get_workflow ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.get_workflow"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWorkflow201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.get_workflow",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#get_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List workflow executions
+    # List the executions of a workflow, most recent first. Supports pagination.
+    # @param key [String] The workflow key.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based). (default to 1)
+    # @option opts [Integer] :per_page Number of executions per page (max 100). (default to 25)
+    # @return [ListWorkflowExecutions200Response]
+    def list_workflow_executions(key, opts = {})
+      data, _status_code, _headers = list_workflow_executions_with_http_info(key, opts)
+      data
+    end
+
+    # List workflow executions
+    # List the executions of a workflow, most recent first. Supports pagination.
+    # @param key [String] The workflow key.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based). (default to 1)
+    # @option opts [Integer] :per_page Number of executions per page (max 100). (default to 25)
+    # @return [Array<(ListWorkflowExecutions200Response, Integer, Hash)>] ListWorkflowExecutions200Response data, response status code and response headers
+    def list_workflow_executions_with_http_info(key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.list_workflow_executions ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.list_workflow_executions"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling WorkflowsApi.list_workflow_executions, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling WorkflowsApi.list_workflow_executions, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling WorkflowsApi.list_workflow_executions, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/workflows/{key}/executions'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListWorkflowExecutions200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.list_workflow_executions",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#list_workflow_executions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List workflows
+    # List workflows in the project. Supports pagination, free-text search, and status filtering.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based). (default to 1)
+    # @option opts [Integer] :per_page Number of workflows per page (max 100). (default to 25)
+    # @option opts [String] :search Free-text search over workflow name and key.
+    # @option opts [WorkflowStatus] :status Filter by workflow status.
+    # @return [ListWorkflows200Response]
+    def list_workflows(opts = {})
+      data, _status_code, _headers = list_workflows_with_http_info(opts)
+      data
+    end
+
+    # List workflows
+    # List workflows in the project. Supports pagination, free-text search, and status filtering.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (1-based). (default to 1)
+    # @option opts [Integer] :per_page Number of workflows per page (max 100). (default to 25)
+    # @option opts [String] :search Free-text search over workflow name and key.
+    # @option opts [WorkflowStatus] :status Filter by workflow status.
+    # @return [Array<(ListWorkflows200Response, Integer, Hash)>] ListWorkflows200Response data, response status code and response headers
+    def list_workflows_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.list_workflows ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling WorkflowsApi.list_workflows, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling WorkflowsApi.list_workflows, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling WorkflowsApi.list_workflows, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/workflows'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListWorkflows200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.list_workflows",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#list_workflows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reorder workflow steps
+    # Reorder a workflow's steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow's existing step keys. 
+    # @param key [String] The workflow key.
+    # @param reorder_workflow_steps_request [ReorderWorkflowStepsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWorkflow201Response]
+    def reorder_workflow_steps(key, reorder_workflow_steps_request, opts = {})
+      data, _status_code, _headers = reorder_workflow_steps_with_http_info(key, reorder_workflow_steps_request, opts)
+      data
+    end
+
+    # Reorder workflow steps
+    # Reorder a workflow&#39;s steps. Provide the full set of step keys in the desired order — the array must contain exactly the workflow&#39;s existing step keys. 
+    # @param key [String] The workflow key.
+    # @param reorder_workflow_steps_request [ReorderWorkflowStepsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWorkflow201Response, Integer, Hash)>] CreateWorkflow201Response data, response status code and response headers
+    def reorder_workflow_steps_with_http_info(key, reorder_workflow_steps_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.reorder_workflow_steps ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.reorder_workflow_steps"
+      end
+      # verify the required parameter 'reorder_workflow_steps_request' is set
+      if @api_client.config.client_side_validation && reorder_workflow_steps_request.nil?
+        fail ArgumentError, "Missing the required parameter 'reorder_workflow_steps_request' when calling WorkflowsApi.reorder_workflow_steps"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}/steps/reorder'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(reorder_workflow_steps_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWorkflow201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.reorder_workflow_steps",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#reorder_workflow_steps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Trigger a workflow
+    # Trigger an execution of an active workflow for one or more recipients. The `to` field accepts a single recipient, an array of recipients, or a topic object (`{ \"topic\": \"topic-key\" }`) to trigger for all subscribers of a topic. One execution is created per resolved subscriber. 
+    # @param key [String] The workflow key.
+    # @param trigger_workflow_request [TriggerWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [TriggerWorkflow202Response]
+    def trigger_workflow(key, trigger_workflow_request, opts = {})
+      data, _status_code, _headers = trigger_workflow_with_http_info(key, trigger_workflow_request, opts)
+      data
+    end
+
+    # Trigger a workflow
+    # Trigger an execution of an active workflow for one or more recipients. The &#x60;to&#x60; field accepts a single recipient, an array of recipients, or a topic object (&#x60;{ \&quot;topic\&quot;: \&quot;topic-key\&quot; }&#x60;) to trigger for all subscribers of a topic. One execution is created per resolved subscriber. 
+    # @param key [String] The workflow key.
+    # @param trigger_workflow_request [TriggerWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TriggerWorkflow202Response, Integer, Hash)>] TriggerWorkflow202Response data, response status code and response headers
+    def trigger_workflow_with_http_info(key, trigger_workflow_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.trigger_workflow ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.trigger_workflow"
+      end
+      # verify the required parameter 'trigger_workflow_request' is set
+      if @api_client.config.client_side_validation && trigger_workflow_request.nil?
+        fail ArgumentError, "Missing the required parameter 'trigger_workflow_request' when calling WorkflowsApi.trigger_workflow"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}/trigger'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(trigger_workflow_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TriggerWorkflow202Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.trigger_workflow",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#trigger_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a workflow
+    # Update a workflow's metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
+    # @param key [String] The workflow key.
+    # @param update_workflow_request [UpdateWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWorkflow201Response]
+    def update_workflow(key, update_workflow_request, opts = {})
+      data, _status_code, _headers = update_workflow_with_http_info(key, update_workflow_request, opts)
+      data
+    end
+
+    # Update a workflow
+    # Update a workflow&#39;s metadata. Only the provided fields are changed. To change the status, use the dedicated status endpoint.
+    # @param key [String] The workflow key.
+    # @param update_workflow_request [UpdateWorkflowRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWorkflow201Response, Integer, Hash)>] CreateWorkflow201Response data, response status code and response headers
+    def update_workflow_with_http_info(key, update_workflow_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.update_workflow ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.update_workflow"
+      end
+      # verify the required parameter 'update_workflow_request' is set
+      if @api_client.config.client_side_validation && update_workflow_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_workflow_request' when calling WorkflowsApi.update_workflow"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_workflow_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWorkflow201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.update_workflow",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#update_workflow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update workflow status
+    # Change a workflow's lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate `/activate` or `/pause` endpoints. Set `status` to `active` to activate and `paused` to pause. 
+    # @param key [String] The workflow key.
+    # @param update_workflow_status_request [UpdateWorkflowStatusRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWorkflow201Response]
+    def update_workflow_status(key, update_workflow_status_request, opts = {})
+      data, _status_code, _headers = update_workflow_status_with_http_info(key, update_workflow_status_request, opts)
+      data
+    end
+
+    # Update workflow status
+    # Change a workflow&#39;s lifecycle status. This is the single endpoint for activating, pausing, archiving, or returning a workflow to draft — there are no separate &#x60;/activate&#x60; or &#x60;/pause&#x60; endpoints. Set &#x60;status&#x60; to &#x60;active&#x60; to activate and &#x60;paused&#x60; to pause. 
+    # @param key [String] The workflow key.
+    # @param update_workflow_status_request [UpdateWorkflowStatusRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWorkflow201Response, Integer, Hash)>] CreateWorkflow201Response data, response status code and response headers
+    def update_workflow_status_with_http_info(key, update_workflow_status_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.update_workflow_status ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.update_workflow_status"
+      end
+      # verify the required parameter 'update_workflow_status_request' is set
+      if @api_client.config.client_side_validation && update_workflow_status_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_workflow_status_request' when calling WorkflowsApi.update_workflow_status"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}/status'.sub('{' + 'key' + '}', CGI.escape(key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_workflow_status_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWorkflow201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.update_workflow_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#update_workflow_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a workflow step
+    # Update a step's name and/or config. Only the provided fields are changed.
+    # @param key [String] The workflow key.
+    # @param step_key [String] The step key.
+    # @param update_workflow_step_request [UpdateWorkflowStepRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AddWorkflowStep201Response]
+    def update_workflow_step(key, step_key, update_workflow_step_request, opts = {})
+      data, _status_code, _headers = update_workflow_step_with_http_info(key, step_key, update_workflow_step_request, opts)
+      data
+    end
+
+    # Update a workflow step
+    # Update a step&#39;s name and/or config. Only the provided fields are changed.
+    # @param key [String] The workflow key.
+    # @param step_key [String] The step key.
+    # @param update_workflow_step_request [UpdateWorkflowStepRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AddWorkflowStep201Response, Integer, Hash)>] AddWorkflowStep201Response data, response status code and response headers
+    def update_workflow_step_with_http_info(key, step_key, update_workflow_step_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WorkflowsApi.update_workflow_step ...'
+      end
+      # verify the required parameter 'key' is set
+      if @api_client.config.client_side_validation && key.nil?
+        fail ArgumentError, "Missing the required parameter 'key' when calling WorkflowsApi.update_workflow_step"
+      end
+      # verify the required parameter 'step_key' is set
+      if @api_client.config.client_side_validation && step_key.nil?
+        fail ArgumentError, "Missing the required parameter 'step_key' when calling WorkflowsApi.update_workflow_step"
+      end
+      # verify the required parameter 'update_workflow_step_request' is set
+      if @api_client.config.client_side_validation && update_workflow_step_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_workflow_step_request' when calling WorkflowsApi.update_workflow_step"
+      end
+      # resource path
+      local_var_path = '/workflows/{key}/steps/{stepKey}'.sub('{' + 'key' + '}', CGI.escape(key.to_s)).sub('{' + 'stepKey' + '}', CGI.escape(step_key.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_workflow_step_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AddWorkflowStep201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WorkflowsApi.update_workflow_step",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WorkflowsApi#update_workflow_step\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end