zyphr 0.1.20 → 0.1.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc762ee588936e1ec8d39ea372bc0c8986cd201e1672ee0eee54d044570f62dd
-  data.tar.gz: b0a9af6a8ab3ed788a093adde023ab5dba58e5a7a30885bb64e36fae250ac0c0
+  metadata.gz: e75874c981fc43e5c9d062663c83994e0b36056e5900a8cd2c7fb83c6c6b70d1
+  data.tar.gz: 27f41a3ec7e4a6c8dba12f7e3f7290badff1452849469d53e2ccdf46a6e9c99d
 SHA512:
-  metadata.gz: 9410b310ef0500325dbb85aa0e04a2dc78d1edc10509628b4ca382e383f189108869f7f2a02f714bf55e75a7ba502fedfe82600047be58bf4acc777c41b8c852
-  data.tar.gz: 99fde07f3ba85115df8c8d0ab6e0a6d9a753493ac04a222ae4e238d72f19cd7ac88144f1eebd7f4ad23e842a147c7b3d2c6b759eabf353437b947583054dc516
+  metadata.gz: ffced373257589887f08d647f3363e0dd26b2387481d8f04ced7a5fa5438dba4aca35f1f5d6babcc65ed9bed79887fc57ed8b1d7e8e405b0a9d4f7c8a08c0f0c
+  data.tar.gz: f8ac7dafb92a7dee945fe94157a53a6ce81f94f08ef52b3a059bcad76a2722b45b8e8d5854eb4336a5b78668a7d747ef2d37f18f3537c580f66086667417f1b8

data/README.md

@@ -341,6 +341,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::AuthEmailTemplateDeleteResponse](docs/AuthEmailTemplateDeleteResponse.md)
  - [Zyphr::AuthEmailTemplateDeleteResponseData](docs/AuthEmailTemplateDeleteResponseData.md)
  - [Zyphr::AuthEmailTemplateListResponse](docs/AuthEmailTemplateListResponse.md)
+ - [Zyphr::AuthEmailTemplatePreviewDraft](docs/AuthEmailTemplatePreviewDraft.md)
  - [Zyphr::AuthEmailTemplatePreviewRequest](docs/AuthEmailTemplatePreviewRequest.md)
  - [Zyphr::AuthEmailTemplatePreviewResponse](docs/AuthEmailTemplatePreviewResponse.md)
  - [Zyphr::AuthEmailTemplatePreviewResult](docs/AuthEmailTemplatePreviewResult.md)

data/docs/AuthEmailTemplatePreviewDraft.md

@@ -0,0 +1,28 @@
+# Zyphr::AuthEmailTemplatePreviewDraft
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject** | **String** |  | [optional] |
+| **html** | **String** |  | [optional] |
+| **text** | **String** |  | [optional] |
+| **mjml_source** | **String** |  | [optional] |
+| **from_name** | **String** |  | [optional] |
+| **reply_to** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::AuthEmailTemplatePreviewDraft.new(
+  subject: null,
+  html: null,
+  text: null,
+  mjml_source: null,
+  from_name: null,
+  reply_to: null
+)
+```
+

data/docs/AuthEmailTemplatePreviewRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **variables** | **Hash<String, Object>** | Variables to interpolate. If omitted, sample values are used. | [optional] |
+| **draft** | [**AuthEmailTemplatePreviewDraft**](AuthEmailTemplatePreviewDraft.md) |  | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'zyphr'
 
 instance = Zyphr::AuthEmailTemplatePreviewRequest.new(
-  variables: null
+  variables: null,
+  draft: null
 )
 ```
 

data/lib/zyphr/models/auth_email_template_preview_draft.rb

@@ -0,0 +1,272 @@
+=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
+  # In-flight editor values. When provided, the preview is rendered against these instead of the persisted template. Useful for live-preview while editing. 
+  class AuthEmailTemplatePreviewDraft
+    attr_accessor :subject
+
+    attr_accessor :html
+
+    attr_accessor :text
+
+    attr_accessor :mjml_source
+
+    attr_accessor :from_name
+
+    attr_accessor :reply_to
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'subject' => :'subject',
+        :'html' => :'html',
+        :'text' => :'text',
+        :'mjml_source' => :'mjml_source',
+        :'from_name' => :'from_name',
+        :'reply_to' => :'reply_to'
+      }
+    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
+      {
+        :'subject' => :'String',
+        :'html' => :'String',
+        :'text' => :'String',
+        :'mjml_source' => :'String',
+        :'from_name' => :'String',
+        :'reply_to' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'subject',
+        :'html',
+        :'text',
+        :'mjml_source',
+        :'from_name',
+        :'reply_to'
+      ])
+    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::AuthEmailTemplatePreviewDraft` 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::AuthEmailTemplatePreviewDraft`. 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?(:'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?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'reply_to')
+        self.reply_to = attributes[:'reply_to']
+      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'
+      true
+    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 &&
+          subject == o.subject &&
+          html == o.html &&
+          text == o.text &&
+          mjml_source == o.mjml_source &&
+          from_name == o.from_name &&
+          reply_to == o.reply_to
+    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
+      [subject, html, text, mjml_source, from_name, reply_to].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/auth_email_template_preview_request.rb

@@ -18,10 +18,13 @@ module Zyphr
     # Variables to interpolate. If omitted, sample values are used.
     attr_accessor :variables
 
+    attr_accessor :draft
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'variables' => :'variables'
+        :'variables' => :'variables',
+        :'draft' => :'draft'
       }
     end
 
@@ -38,7 +41,8 @@ module Zyphr
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'variables' => :'Hash<String, Object>'
+        :'variables' => :'Hash<String, Object>',
+        :'draft' => :'AuthEmailTemplatePreviewDraft'
       }
     end
 
@@ -69,6 +73,10 @@ module Zyphr
           self.variables = value
         end
       end
+
+      if attributes.key?(:'draft')
+        self.draft = attributes[:'draft']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -91,7 +99,8 @@ module Zyphr
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          variables == o.variables
+          variables == o.variables &&
+          draft == o.draft
     end
 
     # @see the `==` method
@@ -103,7 +112,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [variables].hash
+      [variables, draft].hash
     end
 
     # Builds the object from hash

data/lib/zyphr/models/auth_email_template_preview_result.rb

@@ -60,7 +60,6 @@ module Zyphr
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'text',
         :'from_name',
         :'reply_to'
       ])

data/lib/zyphr.rb

@@ -27,6 +27,7 @@ require 'zyphr/models/auth_email_template_default_response'
 require 'zyphr/models/auth_email_template_delete_response'
 require 'zyphr/models/auth_email_template_delete_response_data'
 require 'zyphr/models/auth_email_template_list_response'
+require 'zyphr/models/auth_email_template_preview_draft'
 require 'zyphr/models/auth_email_template_preview_request'
 require 'zyphr/models/auth_email_template_preview_response'
 require 'zyphr/models/auth_email_template_preview_result'

data/spec/models/auth_email_template_preview_draft_spec.rb

@@ -0,0 +1,66 @@
+=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'
+require 'date'
+
+# Unit tests for Zyphr::AuthEmailTemplatePreviewDraft
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zyphr::AuthEmailTemplatePreviewDraft do
+  let(:instance) { Zyphr::AuthEmailTemplatePreviewDraft.new }
+
+  describe 'test an instance of AuthEmailTemplatePreviewDraft' do
+    it 'should create an instance of AuthEmailTemplatePreviewDraft' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zyphr::AuthEmailTemplatePreviewDraft)
+    end
+  end
+
+  describe 'test attribute "subject"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "html"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "text"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "mjml_source"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "from_name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "reply_to"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/auth_email_template_preview_request_spec.rb

@@ -33,4 +33,10 @@ describe Zyphr::AuthEmailTemplatePreviewRequest do
     end
   end
 
+  describe 'test attribute "draft"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/zyphr.gemspec

@@ -17,7 +17,7 @@ require "zyphr/version"
 
 Gem::Specification.new do |s|
   s.name        = "zyphr"
-  s.version = '0.1.20'
+  s.version = '0.1.21'
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Zyphr"]
   s.email       = ["support@zyphr.dev"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zyphr
 version: !ruby/object:Gem::Version
-  version: 0.1.20
+  version: 0.1.21
 platform: ruby
 authors:
 - Zyphr
@@ -98,6 +98,7 @@ files:
 - docs/AuthEmailTemplateDeleteResponse.md
 - docs/AuthEmailTemplateDeleteResponseData.md
 - docs/AuthEmailTemplateListResponse.md
+- docs/AuthEmailTemplatePreviewDraft.md
 - docs/AuthEmailTemplatePreviewRequest.md
 - docs/AuthEmailTemplatePreviewResponse.md
 - docs/AuthEmailTemplatePreviewResult.md
@@ -534,6 +535,7 @@ files:
 - lib/zyphr/models/auth_email_template_delete_response.rb
 - lib/zyphr/models/auth_email_template_delete_response_data.rb
 - lib/zyphr/models/auth_email_template_list_response.rb
+- lib/zyphr/models/auth_email_template_preview_draft.rb
 - lib/zyphr/models/auth_email_template_preview_request.rb
 - lib/zyphr/models/auth_email_template_preview_response.rb
 - lib/zyphr/models/auth_email_template_preview_result.rb
@@ -935,6 +937,7 @@ files:
 - spec/models/auth_email_template_delete_response_data_spec.rb
 - spec/models/auth_email_template_delete_response_spec.rb
 - spec/models/auth_email_template_list_response_spec.rb
+- spec/models/auth_email_template_preview_draft_spec.rb
 - spec/models/auth_email_template_preview_request_spec.rb
 - spec/models/auth_email_template_preview_response_spec.rb
 - spec/models/auth_email_template_preview_result_spec.rb
@@ -1382,6 +1385,7 @@ test_files:
 - spec/models/request_meta_spec.rb
 - spec/models/bulk_retry_webhook_deliveries_request_spec.rb
 - spec/models/mark_all_inbox_read_request_spec.rb
+- spec/models/auth_email_template_preview_draft_spec.rb
 - spec/models/auth_email_template_delete_response_spec.rb
 - spec/models/web_authn_credential_list_response_spec.rb
 - spec/models/webhook_secret_rotate_response_data_spec.rb