zyphr 0.1.4 → 0.1.8

data/lib/zyphr/models/push_message_detail_all_of_action_buttons.rb

@@ -0,0 +1,247 @@
+=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 PushMessageDetailAllOfActionButtons
+    attr_accessor :id
+
+    attr_accessor :title
+
+    attr_accessor :action
+
+    attr_accessor :deep_link
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'title' => :'title',
+        :'action' => :'action',
+        :'deep_link' => :'deep_link'
+      }
+    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',
+        :'title' => :'String',
+        :'action' => :'String',
+        :'deep_link' => :'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::PushMessageDetailAllOfActionButtons` 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::PushMessageDetailAllOfActionButtons`. 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']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.key?(:'deep_link')
+        self.deep_link = attributes[:'deep_link']
+      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 &&
+          id == o.id &&
+          title == o.title &&
+          action == o.action &&
+          deep_link == o.deep_link
+    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, title, action, deep_link].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/register_device_request.rb

@@ -15,25 +15,16 @@ require 'time'
 
 module Zyphr
   class RegisterDeviceRequest
-    attr_accessor :subscriber_id
-
-    # External ID to look up subscriber
-    attr_accessor :external_user_id
+    # User or subscriber ID to associate with the device
+    attr_accessor :user_id
 
     attr_accessor :platform
 
     # Push notification token from the device
     attr_accessor :token
 
-    attr_accessor :app_version
-
-    attr_accessor :device_model
-
-    attr_accessor :os_version
-
-    attr_accessor :timezone
-
-    attr_accessor :locale
+    # Additional device metadata
+    attr_accessor :metadata
 
     class EnumAttributeValidator
       attr_reader :datatype
@@ -60,15 +51,10 @@ module Zyphr
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'subscriber_id' => :'subscriber_id',
-        :'external_user_id' => :'external_user_id',
+        :'user_id' => :'user_id',
         :'platform' => :'platform',
         :'token' => :'token',
-        :'app_version' => :'app_version',
-        :'device_model' => :'device_model',
-        :'os_version' => :'os_version',
-        :'timezone' => :'timezone',
-        :'locale' => :'locale'
+        :'metadata' => :'metadata'
       }
     end
 
@@ -85,15 +71,10 @@ module Zyphr
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'subscriber_id' => :'String',
-        :'external_user_id' => :'String',
+        :'user_id' => :'String',
         :'platform' => :'String',
         :'token' => :'String',
-        :'app_version' => :'String',
-        :'device_model' => :'String',
-        :'os_version' => :'String',
-        :'timezone' => :'String',
-        :'locale' => :'String'
+        :'metadata' => :'Hash<String, Object>'
       }
     end
 
@@ -119,12 +100,10 @@ module Zyphr
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'subscriber_id')
-        self.subscriber_id = attributes[:'subscriber_id']
-      end
-
-      if attributes.key?(:'external_user_id')
-        self.external_user_id = attributes[:'external_user_id']
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      else
+        self.user_id = nil
       end
 
       if attributes.key?(:'platform')
@@ -139,24 +118,10 @@ module Zyphr
         self.token = nil
       end
 
-      if attributes.key?(:'app_version')
-        self.app_version = attributes[:'app_version']
-      end
-
-      if attributes.key?(:'device_model')
-        self.device_model = attributes[:'device_model']
-      end
-
-      if attributes.key?(:'os_version')
-        self.os_version = attributes[:'os_version']
-      end
-
-      if attributes.key?(:'timezone')
-        self.timezone = attributes[:'timezone']
-      end
-
-      if attributes.key?(:'locale')
-        self.locale = attributes[:'locale']
+      if attributes.key?(:'metadata')
+        if (value = attributes[:'metadata']).is_a?(Hash)
+          self.metadata = value
+        end
       end
     end
 
@@ -165,6 +130,10 @@ module Zyphr
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
       if @platform.nil?
         invalid_properties.push('invalid value for "platform", platform cannot be nil.')
       end
@@ -173,6 +142,10 @@ module Zyphr
         invalid_properties.push('invalid value for "token", token cannot be nil.')
       end
 
+      if @token.to_s.length > 4096
+        invalid_properties.push('invalid value for "token", the character length must be smaller than or equal to 4096.')
+      end
+
       invalid_properties
     end
 
@@ -180,13 +153,25 @@ module Zyphr
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @user_id.nil?
       return false if @platform.nil?
       platform_validator = EnumAttributeValidator.new('String', ["ios", "android", "web"])
       return false unless platform_validator.valid?(@platform)
       return false if @token.nil?
+      return false if @token.to_s.length > 4096
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] user_id Value to be assigned
+    def user_id=(user_id)
+      if user_id.nil?
+        fail ArgumentError, 'user_id cannot be nil'
+      end
+
+      @user_id = user_id
+    end
+
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] platform Object to be assigned
     def platform=(platform)
@@ -204,6 +189,10 @@ module Zyphr
         fail ArgumentError, 'token cannot be nil'
       end
 
+      if token.to_s.length > 4096
+        fail ArgumentError, 'invalid value for "token", the character length must be smaller than or equal to 4096.'
+      end
+
       @token = token
     end
 
@@ -212,15 +201,10 @@ module Zyphr
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          subscriber_id == o.subscriber_id &&
-          external_user_id == o.external_user_id &&
+          user_id == o.user_id &&
           platform == o.platform &&
           token == o.token &&
-          app_version == o.app_version &&
-          device_model == o.device_model &&
-          os_version == o.os_version &&
-          timezone == o.timezone &&
-          locale == o.locale
+          metadata == o.metadata
     end
 
     # @see the `==` method
@@ -232,7 +216,7 @@ module Zyphr
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [subscriber_id, external_user_id, platform, token, app_version, device_model, os_version, timezone, locale].hash
+      [user_id, platform, token, metadata].hash
     end
 
     # Builds the object from hash