zyphr 0.1.32 → 0.1.34

data/lib/zyphr/models/v1_muse_subjects_suggest_post_request.rb

@@ -0,0 +1,326 @@
+=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  ## 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 V1MuseSubjectsSuggestPostRequest
+    # Optional template id. When provided, the route resolves the template body server-side. Cannot be combined with template_body.
+    attr_accessor :template_id
+
+    # Optional raw template body. Empty/missing is allowed — the prompt handles sparse input by falling back to channel best-practices.
+    attr_accessor :template_body
+
+    attr_accessor :channel
+
+    attr_accessor :project_id
+
+    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
+      {
+        :'template_id' => :'template_id',
+        :'template_body' => :'template_body',
+        :'channel' => :'channel',
+        :'project_id' => :'project_id'
+      }
+    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
+      {
+        :'template_id' => :'String',
+        :'template_body' => :'String',
+        :'channel' => :'String',
+        :'project_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::V1MuseSubjectsSuggestPostRequest` 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::V1MuseSubjectsSuggestPostRequest`. 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?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      end
+
+      if attributes.key?(:'template_body')
+        self.template_body = attributes[:'template_body']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      else
+        self.channel = nil
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_id = 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 !@template_body.nil? && @template_body.to_s.length > 50000
+        invalid_properties.push('invalid value for "template_body", the character length must be smaller than or equal to 50000.')
+      end
+
+      if @channel.nil?
+        invalid_properties.push('invalid value for "channel", channel cannot be nil.')
+      end
+
+      if @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_id 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 !@template_body.nil? && @template_body.to_s.length > 50000
+      return false if @channel.nil?
+      channel_validator = EnumAttributeValidator.new('String', ["email", "push"])
+      return false unless channel_validator.valid?(@channel)
+      return false if @project_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] template_body Value to be assigned
+    def template_body=(template_body)
+      if template_body.nil?
+        fail ArgumentError, 'template_body cannot be nil'
+      end
+
+      if template_body.to_s.length > 50000
+        fail ArgumentError, 'invalid value for "template_body", the character length must be smaller than or equal to 50000.'
+      end
+
+      @template_body = template_body
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["email", "push"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] project_id Value to be assigned
+    def project_id=(project_id)
+      if project_id.nil?
+        fail ArgumentError, 'project_id cannot be nil'
+      end
+
+      @project_id = project_id
+    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 &&
+          template_id == o.template_id &&
+          template_body == o.template_body &&
+          channel == o.channel &&
+          project_id == o.project_id
+    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
+      [template_id, template_body, channel, project_id].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.rb

@@ -20,6 +20,7 @@ require 'zyphr/configuration'
 require 'zyphr/models/add_domain200_response'
 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/api_error'
 require 'zyphr/models/api_error_error'
@@ -75,6 +76,7 @@ require 'zyphr/models/convert_anonymous_user_request_one_of1'
 require 'zyphr/models/convert_anonymous_user_request_one_of1_apple_user'
 require 'zyphr/models/convert_anonymous_user_request_one_of1_apple_user_name'
 require 'zyphr/models/create_category_request'
+require 'zyphr/models/create_organization_request'
 require 'zyphr/models/create_subscriber_request'
 require 'zyphr/models/create_template_request'
 require 'zyphr/models/create_topic_request'
@@ -131,6 +133,14 @@ require 'zyphr/models/get_domain200_response_meta'
 require 'zyphr/models/get_waa_s_endpoint200_response'
 require 'zyphr/models/get_waa_s_usage200_response'
 require 'zyphr/models/in_app_notification'
+require 'zyphr/models/inbound_attachment_url_response'
+require 'zyphr/models/inbound_attachment_url_response_data'
+require 'zyphr/models/inbound_email'
+require 'zyphr/models/inbound_email_attachment'
+require 'zyphr/models/inbound_email_from'
+require 'zyphr/models/inbound_email_list_response'
+require 'zyphr/models/inbound_email_list_response_meta'
+require 'zyphr/models/inbound_email_response'
 require 'zyphr/models/inbox_list_meta'
 require 'zyphr/models/inbox_list_response'
 require 'zyphr/models/inbox_notification_response'
@@ -184,6 +194,14 @@ require 'zyphr/models/o_auth_tokens_refresh_response'
 require 'zyphr/models/o_auth_tokens_refresh_response_data'
 require 'zyphr/models/o_auth_tokens_response'
 require 'zyphr/models/o_auth_tokens_response_data'
+require 'zyphr/models/organization'
+require 'zyphr/models/organization_list_response'
+require 'zyphr/models/organization_list_response_meta'
+require 'zyphr/models/organization_members_list_response'
+require 'zyphr/models/organization_membership'
+require 'zyphr/models/organization_membership_response'
+require 'zyphr/models/organization_membership_with_user'
+require 'zyphr/models/organization_response'
 require 'zyphr/models/pagination_meta'
 require 'zyphr/models/password_requirements'
 require 'zyphr/models/password_requirements_response'
@@ -270,6 +288,7 @@ require 'zyphr/models/send_webhook_test_event_request'
 require 'zyphr/models/session_list_response'
 require 'zyphr/models/session_list_response_data'
 require 'zyphr/models/session_list_response_data_session_info'
+require 'zyphr/models/set_domain_inbound_request'
 require 'zyphr/models/set_preferences_request'
 require 'zyphr/models/set_preferences_request_preferences_inner'
 require 'zyphr/models/sign_in_anonymously_request'
@@ -296,6 +315,11 @@ require 'zyphr/models/subscriber_list_response'
 require 'zyphr/models/subscriber_preference'
 require 'zyphr/models/subscriber_response'
 require 'zyphr/models/success_result'
+require 'zyphr/models/switch_organization_request'
+require 'zyphr/models/switch_organization_response'
+require 'zyphr/models/switch_organization_response_data'
+require 'zyphr/models/switch_organization_response_data_tokens'
+require 'zyphr/models/switch_organization_response_data_user'
 require 'zyphr/models/template'
 require 'zyphr/models/template_list_response'
 require 'zyphr/models/template_render_response'
@@ -324,6 +348,8 @@ require 'zyphr/models/unsubscribe_request'
 require 'zyphr/models/unsubscribe_response'
 require 'zyphr/models/update_category_request'
 require 'zyphr/models/update_end_user_request'
+require 'zyphr/models/update_organization_member_role_request'
+require 'zyphr/models/update_organization_request'
 require 'zyphr/models/update_subscriber_preferences_request'
 require 'zyphr/models/update_subscriber_preferences_request_preferences_inner'
 require 'zyphr/models/update_subscriber_request'
@@ -337,6 +363,7 @@ 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'
@@ -422,6 +449,7 @@ require 'zyphr/api/auth_login_api'
 require 'zyphr/api/auth_mfa_api'
 require 'zyphr/api/auth_magic_links_api'
 require 'zyphr/api/auth_o_auth_api'
+require 'zyphr/api/auth_organizations_api'
 require 'zyphr/api/auth_password_reset_api'
 require 'zyphr/api/auth_phone_api'
 require 'zyphr/api/auth_registration_api'
@@ -432,7 +460,9 @@ require 'zyphr/api/devices_api'
 require 'zyphr/api/domains_api'
 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'

data/spec/api/auth_organizations_api_spec.rb

@@ -0,0 +1,171 @@
+=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  ## 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 'spec_helper'
+require 'json'
+
+# Unit tests for Zyphr::AuthOrganizationsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AuthOrganizationsApi' do
+  before do
+    # run before each test
+    @api_instance = Zyphr::AuthOrganizationsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AuthOrganizationsApi' do
+    it 'should create an instance of AuthOrganizationsApi' do
+      expect(@api_instance).to be_instance_of(Zyphr::AuthOrganizationsApi)
+    end
+  end
+
+  # unit tests for add_organization_member
+  # Add a member to an organization
+  # @param id 
+  # @param add_organization_member_request 
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationMembershipResponse]
+  describe 'add_organization_member test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for create_organization
+  # Create an organization
+  # Create a new organization inside the current application × environment. Membership is many-to-many — add end users via POST /auth/organizations/{id}/members. The Default organization for the environment is auto-created at migration time and cannot be created via API.
+  # @param create_organization_request 
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationResponse]
+  describe 'create_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for delete_organization
+  # Delete an organization
+  # Hard-deletes the org and cascades memberships. The Default organization cannot be deleted.
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_organization
+  # Get organization by id
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationResponse]
+  describe 'get_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_organization_members
+  # List organization members
+  # @param id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit 
+  # @option opts [String] :cursor 
+  # @return [OrganizationMembersListResponse]
+  describe 'list_organization_members test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_organizations
+  # List organizations
+  # List organizations in the current environment. Cursor-paginated.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit 
+  # @option opts [String] :cursor 
+  # @option opts [String] :search ILIKE match on name OR slug
+  # @return [OrganizationListResponse]
+  describe 'list_organizations test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for list_organizations_for_end_user
+  # List organizations an end user belongs to
+  # Inverse of the membership list — returns all orgs the user is a member of within the current environment. Use this when the orgs[] JWT claim is omitted because the user belongs to more than 50.
+  # @param user_id 
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationListResponse]
+  describe 'list_organizations_for_end_user test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for remove_organization_member
+  # Remove a member from an organization
+  # @param id 
+  # @param user_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'remove_organization_member test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for switch_organization
+  # Switch the active organization on a session
+  # Takes a valid refresh token + a target organization the user is a member of, verifies membership at mint time, revokes the old session, and mints a fresh access + refresh pair with `org_id` set to the target. The old refresh token is invalidated (jti rotated). Use this when the user's active workspace changes (the Slack/Linear workspace-switch pattern).
+  # @param switch_organization_request 
+  # @param [Hash] opts the optional parameters
+  # @return [SwitchOrganizationResponse]
+  describe 'switch_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_organization
+  # Update an organization
+  # The Default organization cannot be renamed or have its slug/metadata changed.
+  # @param id 
+  # @param update_organization_request 
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationResponse]
+  describe 'update_organization test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for update_organization_member_role
+  # Update a member's role
+  # @param id 
+  # @param user_id 
+  # @param update_organization_member_role_request 
+  # @param [Hash] opts the optional parameters
+  # @return [OrganizationMembershipResponse]
+  describe 'update_organization_member_role test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/auth_user_profile_api_spec.rb

@@ -43,6 +43,18 @@ describe 'AuthUserProfileApi' do
     end
   end
 
+  # unit tests for delete_end_user_by_application
+  # Delete an end user (test environment only)
+  # App-credentialed soft-delete for an end user, scoped to the test environment only. Live-mode credentials receive 403 — this is the intentional safety guard against a misconfigured CI runner nuking production users.  Mirrors the self-service `DELETE /auth/users/me` flow: revokes all sessions, soft-deletes the row (status='deleted'), and emits a `user.deleted` webhook with `method='application_admin'`. The audit log row survives (no FK to end_users), so org-history queries still resolve.  Intended for smoke / test-fixture cleanup. Production deletes should continue to use `DELETE /auth/users/me` from the end-user's own session or the dashboard. 
+  # @param user_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_end_user_by_application test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for get_end_user
   # Get current end user profile
   # Retrieve the profile of the currently authenticated end user.

data/spec/api/domains_api_spec.rb

@@ -91,6 +91,19 @@ describe 'DomainsApi' do
     end
   end
 
+  # unit tests for set_domain_inbound
+  # Enable or disable inbound email for a domain
+  # Toggle email receiving for a domain. When enabled, the domain's DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+). 
+  # @param id 
+  # @param set_domain_inbound_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'set_domain_inbound test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   # unit tests for verify_domain
   # Trigger domain verification
   # Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships.  Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).