zyphr 0.1.19 → 0.1.21

data/lib/zyphr/api/slack_api.rb

@@ -0,0 +1,233 @@
+=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 'cgi'
+
+module Zyphr
+  class SlackApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get a Slack message
+    # Retrieve a single Slack message by ID, including its full block/attachment payload and status timestamps.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SlackMessageResponse]
+    def get_slack_message(id, opts = {})
+      data, _status_code, _headers = get_slack_message_with_http_info(id, opts)
+      data
+    end
+
+    # Get a Slack message
+    # Retrieve a single Slack message by ID, including its full block/attachment payload and status timestamps.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SlackMessageResponse, Integer, Hash)>] SlackMessageResponse data, response status code and response headers
+    def get_slack_message_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SlackApi.get_slack_message ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SlackApi.get_slack_message"
+      end
+      # resource path
+      local_var_path = '/slack/messages/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'SlackMessageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SlackApi.get_slack_message",
+        :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: SlackApi#get_slack_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Slack messages
+    # List Slack messages sent through the project, with optional filtering by connection, channel, and status.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :connection_id Filter by Slack connection ID.
+    # @option opts [String] :channel_id Filter by Slack channel ID.
+    # @option opts [String] :status Filter by message status.
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @return [SlackMessageListResponse]
+    def list_slack_messages(opts = {})
+      data, _status_code, _headers = list_slack_messages_with_http_info(opts)
+      data
+    end
+
+    # List Slack messages
+    # List Slack messages sent through the project, with optional filtering by connection, channel, and status.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :connection_id Filter by Slack connection ID.
+    # @option opts [String] :channel_id Filter by Slack channel ID.
+    # @option opts [String] :status Filter by message status.
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Integer] :offset  (default to 0)
+    # @return [Array<(SlackMessageListResponse, Integer, Hash)>] SlackMessageListResponse data, response status code and response headers
+    def list_slack_messages_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SlackApi.list_slack_messages ...'
+      end
+      allowable_values = ["queued", "sending", "sent", "delivered", "failed"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SlackApi.list_slack_messages, must be smaller than or equal to 200.'
+      end
+
+      # resource path
+      local_var_path = '/slack/messages'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'connection_id'] = opts[:'connection_id'] if !opts[:'connection_id'].nil?
+      query_params[:'channel_id'] = opts[:'channel_id'] if !opts[:'channel_id'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'SlackMessageListResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SlackApi.list_slack_messages",
+        :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: SlackApi#list_slack_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Send a Slack message
+    # Send a message to a Slack channel through a connected Slack workspace. Either `text` or `blocks` must be provided. If `connection_id` is omitted, the project's active Slack connection is used. If `channel` is omitted, the connection's default channel is used. 
+    # @param send_slack_message_request [SendSlackMessageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendSlackMessageResponse]
+    def send_slack_message(send_slack_message_request, opts = {})
+      data, _status_code, _headers = send_slack_message_with_http_info(send_slack_message_request, opts)
+      data
+    end
+
+    # Send a Slack message
+    # Send a message to a Slack channel through a connected Slack workspace. Either &#x60;text&#x60; or &#x60;blocks&#x60; must be provided. If &#x60;connection_id&#x60; is omitted, the project&#39;s active Slack connection is used. If &#x60;channel&#x60; is omitted, the connection&#39;s default channel is used. 
+    # @param send_slack_message_request [SendSlackMessageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendSlackMessageResponse, Integer, Hash)>] SendSlackMessageResponse data, response status code and response headers
+    def send_slack_message_with_http_info(send_slack_message_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SlackApi.send_slack_message ...'
+      end
+      # verify the required parameter 'send_slack_message_request' is set
+      if @api_client.config.client_side_validation && send_slack_message_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_slack_message_request' when calling SlackApi.send_slack_message"
+      end
+      # resource path
+      local_var_path = '/slack/send'
+
+      # 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(send_slack_message_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendSlackMessageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"SlackApi.send_slack_message",
+        :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: SlackApi#send_slack_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/zyphr/models/auth_email_template.rb

@@ -0,0 +1,372 @@
+=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 AuthEmailTemplate
+    attr_accessor :email_type
+
+    attr_accessor :subject
+
+    attr_accessor :html
+
+    attr_accessor :text
+
+    attr_accessor :mjml_source
+
+    attr_accessor :design_json
+
+    attr_accessor :editor_type
+
+    attr_accessor :from_name
+
+    attr_accessor :reply_to
+
+    attr_accessor :is_enabled
+
+    # True when the system default is being returned (no override exists)
+    attr_accessor :is_default
+
+    attr_accessor :has_override
+
+    attr_accessor :version
+
+    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
+      {
+        :'email_type' => :'email_type',
+        :'subject' => :'subject',
+        :'html' => :'html',
+        :'text' => :'text',
+        :'mjml_source' => :'mjml_source',
+        :'design_json' => :'design_json',
+        :'editor_type' => :'editor_type',
+        :'from_name' => :'from_name',
+        :'reply_to' => :'reply_to',
+        :'is_enabled' => :'is_enabled',
+        :'is_default' => :'is_default',
+        :'has_override' => :'has_override',
+        :'version' => :'version'
+      }
+    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
+      {
+        :'email_type' => :'AuthEmailType',
+        :'subject' => :'String',
+        :'html' => :'String',
+        :'text' => :'String',
+        :'mjml_source' => :'String',
+        :'design_json' => :'Hash<String, Object>',
+        :'editor_type' => :'String',
+        :'from_name' => :'String',
+        :'reply_to' => :'String',
+        :'is_enabled' => :'Boolean',
+        :'is_default' => :'Boolean',
+        :'has_override' => :'Boolean',
+        :'version' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'text',
+        :'mjml_source',
+        :'design_json',
+        :'editor_type',
+        :'from_name',
+        :'reply_to',
+        :'version'
+      ])
+    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::AuthEmailTemplate` 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::AuthEmailTemplate`. 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?(:'email_type')
+        self.email_type = attributes[:'email_type']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'mjml_source')
+        self.mjml_source = attributes[:'mjml_source']
+      end
+
+      if attributes.key?(:'design_json')
+        if (value = attributes[:'design_json']).is_a?(Hash)
+          self.design_json = value
+        end
+      end
+
+      if attributes.key?(:'editor_type')
+        self.editor_type = attributes[:'editor_type']
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'reply_to')
+        self.reply_to = attributes[:'reply_to']
+      end
+
+      if attributes.key?(:'is_enabled')
+        self.is_enabled = attributes[:'is_enabled']
+      end
+
+      if attributes.key?(:'is_default')
+        self.is_default = attributes[:'is_default']
+      end
+
+      if attributes.key?(:'has_override')
+        self.has_override = attributes[:'has_override']
+      end
+
+      if attributes.key?(:'version')
+        self.version = attributes[:'version']
+      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
+      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'
+      editor_type_validator = EnumAttributeValidator.new('String', ["code", "mjml", "design"])
+      return false unless editor_type_validator.valid?(@editor_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] editor_type Object to be assigned
+    def editor_type=(editor_type)
+      validator = EnumAttributeValidator.new('String', ["code", "mjml", "design"])
+      unless validator.valid?(editor_type)
+        fail ArgumentError, "invalid value for \"editor_type\", must be one of #{validator.allowable_values}."
+      end
+      @editor_type = editor_type
+    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 &&
+          email_type == o.email_type &&
+          subject == o.subject &&
+          html == o.html &&
+          text == o.text &&
+          mjml_source == o.mjml_source &&
+          design_json == o.design_json &&
+          editor_type == o.editor_type &&
+          from_name == o.from_name &&
+          reply_to == o.reply_to &&
+          is_enabled == o.is_enabled &&
+          is_default == o.is_default &&
+          has_override == o.has_override &&
+          version == o.version
+    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
+      [email_type, subject, html, text, mjml_source, design_json, editor_type, from_name, reply_to, is_enabled, is_default, has_override, version].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