notifo-io-easierlife 1.0.0

data/lib/notifo/models/user_dto.rb

@@ -0,0 +1,381 @@
+=begin
+#Notifo API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module Notifo
+  class UserDto
+    # The id of the user.
+    attr_accessor :id
+
+    # The unique api key for the user.
+    attr_accessor :api_key
+
+    # The full name of the user.
+    attr_accessor :full_name
+
+    # The email of the user.
+    attr_accessor :email_address
+
+    # The phone number.
+    attr_accessor :phone_number
+
+    # The preferred language of the user.
+    attr_accessor :preferred_language
+
+    # The timezone of the user.
+    attr_accessor :preferred_timezone
+
+    # True when only whitelisted topic are allowed.
+    attr_accessor :requires_whitelisted_topics
+
+    # Notification settings per channel.
+    attr_accessor :settings
+
+    # The statistics counters.
+    attr_accessor :counters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'api_key' => :'apiKey',
+        :'full_name' => :'fullName',
+        :'email_address' => :'emailAddress',
+        :'phone_number' => :'phoneNumber',
+        :'preferred_language' => :'preferredLanguage',
+        :'preferred_timezone' => :'preferredTimezone',
+        :'requires_whitelisted_topics' => :'requiresWhitelistedTopics',
+        :'settings' => :'settings',
+        :'counters' => :'counters'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'api_key' => :'String',
+        :'full_name' => :'String',
+        :'email_address' => :'String',
+        :'phone_number' => :'String',
+        :'preferred_language' => :'String',
+        :'preferred_timezone' => :'String',
+        :'requires_whitelisted_topics' => :'Boolean',
+        :'settings' => :'Hash<String, NotificationSettingDto>',
+        :'counters' => :'Hash<String, Integer>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'full_name',
+        :'email_address',
+        :'phone_number',
+        :'preferred_language',
+        :'preferred_timezone',
+      ])
+    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 `Notifo::UserDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Notifo::UserDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'api_key')
+        self.api_key = attributes[:'api_key']
+      end
+
+      if attributes.key?(:'full_name')
+        self.full_name = attributes[:'full_name']
+      end
+
+      if attributes.key?(:'email_address')
+        self.email_address = attributes[:'email_address']
+      end
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      end
+
+      if attributes.key?(:'preferred_language')
+        self.preferred_language = attributes[:'preferred_language']
+      end
+
+      if attributes.key?(:'preferred_timezone')
+        self.preferred_timezone = attributes[:'preferred_timezone']
+      end
+
+      if attributes.key?(:'requires_whitelisted_topics')
+        self.requires_whitelisted_topics = attributes[:'requires_whitelisted_topics']
+      end
+
+      if attributes.key?(:'settings')
+        if (value = attributes[:'settings']).is_a?(Hash)
+          self.settings = value
+        end
+      end
+
+      if attributes.key?(:'counters')
+        if (value = attributes[:'counters']).is_a?(Hash)
+          self.counters = value
+        end
+      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
+      invalid_properties = Array.new
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @id.to_s.length < 1
+        invalid_properties.push('invalid value for "id", the character length must be great than or equal to 1.')
+      end
+
+      if @api_key.nil?
+        invalid_properties.push('invalid value for "api_key", api_key cannot be nil.')
+      end
+
+      if @api_key.to_s.length < 1
+        invalid_properties.push('invalid value for "api_key", the character length must be great than or equal to 1.')
+      end
+
+      if @requires_whitelisted_topics.nil?
+        invalid_properties.push('invalid value for "requires_whitelisted_topics", requires_whitelisted_topics cannot be nil.')
+      end
+
+      if @settings.nil?
+        invalid_properties.push('invalid value for "settings", settings cannot be nil.')
+      end
+
+      if @counters.nil?
+        invalid_properties.push('invalid value for "counters", counters 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?
+      return false if @id.nil?
+      return false if @id.to_s.length < 1
+      return false if @api_key.nil?
+      return false if @api_key.to_s.length < 1
+      return false if @requires_whitelisted_topics.nil?
+      return false if @settings.nil?
+      return false if @counters.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
+
+      if id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "id", the character length must be great than or equal to 1.'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] api_key Value to be assigned
+    def api_key=(api_key)
+      if api_key.nil?
+        fail ArgumentError, 'api_key cannot be nil'
+      end
+
+      if api_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "api_key", the character length must be great than or equal to 1.'
+      end
+
+      @api_key = api_key
+    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 &&
+          api_key == o.api_key &&
+          full_name == o.full_name &&
+          email_address == o.email_address &&
+          phone_number == o.phone_number &&
+          preferred_language == o.preferred_language &&
+          preferred_timezone == o.preferred_timezone &&
+          requires_whitelisted_topics == o.requires_whitelisted_topics &&
+          settings == o.settings &&
+          counters == o.counters
+    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, api_key, full_name, email_address, phone_number, preferred_language, preferred_timezone, requires_whitelisted_topics, settings, counters].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)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _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 = Notifo.const_get(type)
+        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/notifo/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Notifo API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+module Notifo
+  VERSION = '1.0.0'
+end

data/notifo.gemspec

@@ -0,0 +1,38 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Notifo API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "notifo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "notifo-io-easierlife"
+  s.version     = Notifo::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Squidex UG"]
+  s.email       = [""]
+  s.homepage    = "https://app.notifo.io"
+  s.summary     = ""
+  s.description = "Notifo is a multi-channel notification service for collaboration tools, e-commerce, news, magazines and everybody who wants to notify their users."
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.4"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/spec/api/apps_api_spec.rb

@@ -0,0 +1,151 @@
+=begin
+#Notifo API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Notifo::AppsApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'AppsApi' do
+  before do
+    # run before each test
+    @api_instance = Notifo::AppsApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of AppsApi' do
+    it 'should create an instance of AppsApi' do
+      expect(@api_instance).to be_instance_of(Notifo::AppsApi)
+    end
+  end
+
+  # unit tests for apps_delete_contributor
+  # Delete an app contributor.
+  # @param app_id The id of the app.
+  # @param contributor_id The contributor to remove.
+  # @param [Hash] opts the optional parameters
+  # @return [AppDetailsDto]
+  describe 'apps_delete_contributor test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_delete_email_template
+  # Delete an app email template.
+  # @param app_id The id of the app where the email templates belong to.
+  # @param language The language.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'apps_delete_email_template test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_get_app
+  # Get app by id.
+  # @param app_id The id of the app.
+  # @param [Hash] opts the optional parameters
+  # @return [AppDetailsDto]
+  describe 'apps_get_app test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_get_apps
+  # Get the user apps.
+  # @param [Hash] opts the optional parameters
+  # @return [Array<AppDto>]
+  describe 'apps_get_apps test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_get_email_templates
+  # Get the app email templates.
+  # @param app_id The id of the app where the email templates belong to.
+  # @param [Hash] opts the optional parameters
+  # @return [Hash<String, EmailTemplateDto>]
+  describe 'apps_get_email_templates test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_post_app
+  # Create an app.
+  # @param upsert_app_dto The request object.
+  # @param [Hash] opts the optional parameters
+  # @return [AppDto]
+  describe 'apps_post_app test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_post_contributor
+  # Add an app contributor.
+  # @param app_id The id of the app.
+  # @param add_contributor_dto The request object.
+  # @param [Hash] opts the optional parameters
+  # @return [AppDetailsDto]
+  describe 'apps_post_contributor test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_post_email_template
+  # Create an app email template.
+  # @param app_id The id of the app where the email templates belong to.
+  # @param create_email_template_dto The request object.
+  # @param [Hash] opts the optional parameters
+  # @return [EmailTemplateDto]
+  describe 'apps_post_email_template test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_put_app
+  # Update an app.
+  # @param app_id The app id to update.
+  # @param upsert_app_dto The request object.
+  # @param [Hash] opts the optional parameters
+  # @return [AppDetailsDto]
+  describe 'apps_put_app test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for apps_put_email_template
+  # Update an app email template.
+  # @param app_id The id of the app where the email templates belong to.
+  # @param language The language.
+  # @param email_template_dto The request object.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'apps_put_email_template test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end