zyphr 0.1.39 → 0.1.40

data/lib/zyphr/models/workflow_step.rb

@@ -0,0 +1,505 @@
+=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 'date'
+require 'time'
+
+module Zyphr
+  class WorkflowStep
+    attr_accessor :id
+
+    attr_accessor :workflow_id
+
+    # Unique step identifier within the workflow.
+    attr_accessor :step_key
+
+    # Human-readable step name.
+    attr_accessor :name
+
+    attr_accessor :type
+
+    # Ordering position of the step within the workflow.
+    attr_accessor :position
+
+    # Step configuration. The shape depends on `type` — channel steps carry message content (subject, body, template_id, etc.), `delay` steps carry `{ amount, unit }`, and `branch` steps carry `{ conditions }`. 
+    attr_accessor :config
+
+    attr_accessor :parent_step_id
+
+    attr_accessor :branch_path
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'workflow_id' => :'workflow_id',
+        :'step_key' => :'step_key',
+        :'name' => :'name',
+        :'type' => :'type',
+        :'position' => :'position',
+        :'config' => :'config',
+        :'parent_step_id' => :'parent_step_id',
+        :'branch_path' => :'branch_path',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'workflow_id' => :'String',
+        :'step_key' => :'String',
+        :'name' => :'String',
+        :'type' => :'WorkflowStepType',
+        :'position' => :'Integer',
+        :'config' => :'Hash<String, Object>',
+        :'parent_step_id' => :'String',
+        :'branch_path' => :'String',
+        :'created_at' => :'Time',
+        :'updated_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'parent_step_id',
+        :'branch_path',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::WorkflowStep` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::WorkflowStep`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'workflow_id')
+        self.workflow_id = attributes[:'workflow_id']
+      else
+        self.workflow_id = nil
+      end
+
+      if attributes.key?(:'step_key')
+        self.step_key = attributes[:'step_key']
+      else
+        self.step_key = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'position')
+        self.position = attributes[:'position']
+      else
+        self.position = nil
+      end
+
+      if attributes.key?(:'config')
+        if (value = attributes[:'config']).is_a?(Hash)
+          self.config = value
+        end
+      else
+        self.config = nil
+      end
+
+      if attributes.key?(:'parent_step_id')
+        self.parent_step_id = attributes[:'parent_step_id']
+      end
+
+      if attributes.key?(:'branch_path')
+        self.branch_path = attributes[:'branch_path']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @workflow_id.nil?
+        invalid_properties.push('invalid value for "workflow_id", workflow_id cannot be nil.')
+      end
+
+      if @step_key.nil?
+        invalid_properties.push('invalid value for "step_key", step_key cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @position.nil?
+        invalid_properties.push('invalid value for "position", position cannot be nil.')
+      end
+
+      if @config.nil?
+        invalid_properties.push('invalid value for "config", config cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @id.nil?
+      return false if @workflow_id.nil?
+      return false if @step_key.nil?
+      return false if @name.nil?
+      return false if @type.nil?
+      return false if @position.nil?
+      return false if @config.nil?
+      branch_path_validator = EnumAttributeValidator.new('String', ["true", "false"])
+      return false unless branch_path_validator.valid?(@branch_path)
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] workflow_id Value to be assigned
+    def workflow_id=(workflow_id)
+      if workflow_id.nil?
+        fail ArgumentError, 'workflow_id cannot be nil'
+      end
+
+      @workflow_id = workflow_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] step_key Value to be assigned
+    def step_key=(step_key)
+      if step_key.nil?
+        fail ArgumentError, 'step_key cannot be nil'
+      end
+
+      @step_key = step_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] position Value to be assigned
+    def position=(position)
+      if position.nil?
+        fail ArgumentError, 'position cannot be nil'
+      end
+
+      @position = position
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] config Value to be assigned
+    def config=(config)
+      if config.nil?
+        fail ArgumentError, 'config cannot be nil'
+      end
+
+      @config = config
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] branch_path Object to be assigned
+    def branch_path=(branch_path)
+      validator = EnumAttributeValidator.new('String', ["true", "false"])
+      unless validator.valid?(branch_path)
+        fail ArgumentError, "invalid value for \"branch_path\", must be one of #{validator.allowable_values}."
+      end
+      @branch_path = branch_path
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          workflow_id == o.workflow_id &&
+          step_key == o.step_key &&
+          name == o.name &&
+          type == o.type &&
+          position == o.position &&
+          config == o.config &&
+          parent_step_id == o.parent_step_id &&
+          branch_path == o.branch_path &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, workflow_id, step_key, name, type, position, config, parent_step_id, branch_path, created_at, updated_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Zyphr.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/zyphr/models/workflow_step_type.rb

@@ -0,0 +1,47 @@
+=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 'date'
+require 'time'
+
+module Zyphr
+  class WorkflowStepType
+    EMAIL = "email".freeze
+    PUSH = "push".freeze
+    SMS = "sms".freeze
+    IN_APP = "in_app".freeze
+    SLACK = "slack".freeze
+    DISCORD = "discord".freeze
+    TEAMS = "teams".freeze
+    DELAY = "delay".freeze
+    BRANCH = "branch".freeze
+
+    def self.all_vars
+      @all_vars ||= [EMAIL, PUSH, SMS, IN_APP, SLACK, DISCORD, TEAMS, DELAY, BRANCH].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if WorkflowStepType.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #WorkflowStepType"
+    end
+  end
+end

data/lib/zyphr.rb

@@ -22,6 +22,8 @@ require 'zyphr/models/add_domain200_response_meta'
 require 'zyphr/models/add_domain_request'
 require 'zyphr/models/add_organization_member_request'
 require 'zyphr/models/add_topic_subscribers_request'
+require 'zyphr/models/add_workflow_step201_response'
+require 'zyphr/models/add_workflow_step_request'
 require 'zyphr/models/api_error'
 require 'zyphr/models/api_error_error'
 require 'zyphr/models/api_error_meta'
@@ -88,10 +90,16 @@ require 'zyphr/models/create_waa_s_endpoint_response'
 require 'zyphr/models/create_waa_s_event_type201_response'
 require 'zyphr/models/create_waa_s_event_type_request'
 require 'zyphr/models/create_webhook_request'
+require 'zyphr/models/create_workflow201_response'
+require 'zyphr/models/create_workflow_request'
 require 'zyphr/models/delete_domain_response'
 require 'zyphr/models/delete_domain_response_data'
 require 'zyphr/models/delete_result'
 require 'zyphr/models/delete_result_data'
+require 'zyphr/models/delete_workflow200_response'
+require 'zyphr/models/delete_workflow200_response_data'
+require 'zyphr/models/delete_workflow_step200_response'
+require 'zyphr/models/delete_workflow_step200_response_data'
 require 'zyphr/models/device'
 require 'zyphr/models/device_list_response'
 require 'zyphr/models/device_push_topic'
@@ -149,6 +157,10 @@ require 'zyphr/models/list_waa_s_applications200_response'
 require 'zyphr/models/list_waa_s_endpoint_deliveries200_response'
 require 'zyphr/models/list_waa_s_endpoints200_response'
 require 'zyphr/models/list_waa_s_event_types200_response'
+require 'zyphr/models/list_workflow_executions200_response'
+require 'zyphr/models/list_workflow_executions200_response_meta'
+require 'zyphr/models/list_workflows200_response'
+require 'zyphr/models/list_workflows200_response_meta'
 require 'zyphr/models/login_request'
 require 'zyphr/models/magic_link_send_request'
 require 'zyphr/models/magic_link_verify_request'
@@ -243,6 +255,7 @@ require 'zyphr/models/register_request'
 require 'zyphr/models/remove_topic_subscribers_request'
 require 'zyphr/models/rename_web_authn_credential_request'
 require 'zyphr/models/render_template_request'
+require 'zyphr/models/reorder_workflow_steps_request'
 require 'zyphr/models/replay_webhook_events_request'
 require 'zyphr/models/request_meta'
 require 'zyphr/models/reset_password_request'
@@ -313,7 +326,6 @@ require 'zyphr/models/sms_config_delete_response_data'
 require 'zyphr/models/sms_config_response'
 require 'zyphr/models/sms_detail_response'
 require 'zyphr/models/sms_list_response'
-require 'zyphr/models/sms_list_response_meta'
 require 'zyphr/models/sms_message'
 require 'zyphr/models/sms_message_detail'
 require 'zyphr/models/subscribe_push_topic_request'
@@ -335,7 +347,6 @@ require 'zyphr/models/template_response'
 require 'zyphr/models/test_webhook_transform_request'
 require 'zyphr/models/topic'
 require 'zyphr/models/topic_delete_response'
-require 'zyphr/models/topic_delete_response_data'
 require 'zyphr/models/topic_list_response'
 require 'zyphr/models/topic_response'
 require 'zyphr/models/topic_stats_data'
@@ -347,6 +358,9 @@ require 'zyphr/models/topic_subscribers_add_response'
 require 'zyphr/models/topic_subscribers_add_result'
 require 'zyphr/models/topic_subscribers_remove_response'
 require 'zyphr/models/topic_subscribers_remove_result'
+require 'zyphr/models/trigger_workflow202_response'
+require 'zyphr/models/trigger_workflow202_response_data'
+require 'zyphr/models/trigger_workflow_request'
 require 'zyphr/models/unread_count_data'
 require 'zyphr/models/unread_count_response'
 require 'zyphr/models/unsubscribe'
@@ -367,11 +381,13 @@ require 'zyphr/models/update_waa_s_application_request'
 require 'zyphr/models/update_waa_s_endpoint_request'
 require 'zyphr/models/update_waa_s_event_type_request'
 require 'zyphr/models/update_webhook_request'
+require 'zyphr/models/update_workflow_request'
+require 'zyphr/models/update_workflow_status_request'
+require 'zyphr/models/update_workflow_step_request'
 require 'zyphr/models/upsert_auth_email_template_request'
 require 'zyphr/models/upsert_sms_config_request'
 require 'zyphr/models/user_devices_delete_response'
 require 'zyphr/models/user_devices_delete_response_data'
-require 'zyphr/models/v1_muse_subjects_suggest_post_request'
 require 'zyphr/models/validate_reset_token_request'
 require 'zyphr/models/validate_reset_token_response'
 require 'zyphr/models/validate_reset_token_response_data'
@@ -447,10 +463,14 @@ require 'zyphr/models/webhook_version'
 require 'zyphr/models/webhook_versions_response'
 require 'zyphr/models/webhook_versions_response_data'
 require 'zyphr/models/withdraw_subscriber_consent_request'
+require 'zyphr/models/workflow'
 require 'zyphr/models/workflow_execution'
 require 'zyphr/models/workflow_execution_status'
+require 'zyphr/models/workflow_status'
+require 'zyphr/models/workflow_step'
 require 'zyphr/models/workflow_step_execution'
 require 'zyphr/models/workflow_step_execution_status'
+require 'zyphr/models/workflow_step_type'
 
 # APIs
 require 'zyphr/api/auth_email_otp_api'
@@ -474,7 +494,6 @@ require 'zyphr/api/emails_api'
 require 'zyphr/api/executions_api'
 require 'zyphr/api/inbound_email_api'
 require 'zyphr/api/inbox_api'
-require 'zyphr/api/muse_api'
 require 'zyphr/api/push_api'
 require 'zyphr/api/sms_api'
 require 'zyphr/api/slack_api'
@@ -489,6 +508,7 @@ require 'zyphr/api/waa_s_event_types_api'
 require 'zyphr/api/waa_s_events_api'
 require 'zyphr/api/waa_s_portal_api'
 require 'zyphr/api/webhooks_api'
+require 'zyphr/api/workflows_api'
 
 module Zyphr
   class << self

data/spec/api/auth_registration_api_spec.rb

@@ -70,7 +70,7 @@ describe 'AuthRegistrationApi' do
 
   # unit tests for sign_in_with_game_center
   # Sign in with Apple Game Center
-  # Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the modern scoped `playerId` (gamePlayerID).  ## Producing the assertion (Integration)  The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit's `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player's `gamePlayerID` and the app's bundle identifier and submit them here.  Two integration shapes are supported:   - **client-direct** — the iOS app holds the Zyphr application public     key and calls this endpoint itself.   - **backend-relayed** — the app forwards the fetched assertion fields     to the customer's own backend, which relays them to this endpoint;     the app never holds Zyphr keys. (This is the common shape for games.)  On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed. 
+  # Exchange an Apple Game Center identity-verification assertion for a Zyphr end-user session. Zyphr independently re-verifies the assertion server-side (Apple certificate chain, RSA-SHA256 signature, timestamp freshness, single-use replay guard, and bundle-id binding) before provisioning-or-looking-up the user and minting tokens. The user is keyed on the player's `teamPlayerID` (the id GameKit signs the assertion over).  ## Producing the assertion (Integration)  The assertion is produced **on-device by the iOS app** — there is no server-side way to mint it. The app calls GameKit's `GKLocalPlayer.fetchItems(forIdentityVerificationSignature:)`, which returns `publicKeyURL`, `signature`, `salt`, and `timestamp`; combine those with the local player's `teamPlayerID` (NOT `gamePlayerID`) and the app's bundle identifier and submit them here.  Two integration shapes are supported:   - **client-direct** — the iOS app holds the Zyphr application public     key and calls this endpoint itself.   - **backend-relayed** — the app forwards the fetched assertion fields     to the customer's own backend, which relays them to this endpoint;     the app never holds Zyphr keys. (This is the common shape for games.)  On any verification failure the response is a single opaque `401` `invalid_assertion` — the specific control that failed is never disclosed. 
   # @param sign_in_with_game_center_request 
   # @param [Hash] opts the optional parameters
   # @return [AuthResultResponse]