parlo-sdk 1.0.0 → 1.1.0

data/lib/parlo-sdk/models/list_meta.rb

@@ -0,0 +1,240 @@
+=begin
+#Parlo API
+
+#The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
+
+The version of the OpenAPI document: 1.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module Parlo
+  class ListMeta < ApiModelBase
+    attr_accessor :current_page
+
+    attr_accessor :next_page
+
+    attr_accessor :prev_page
+
+    attr_accessor :total_pages
+
+    attr_accessor :total_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'current_page' => :'current_page',
+        :'next_page' => :'next_page',
+        :'prev_page' => :'prev_page',
+        :'total_pages' => :'total_pages',
+        :'total_count' => :'total_count'
+      }
+    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
+      {
+        :'current_page' => :'Integer',
+        :'next_page' => :'Integer',
+        :'prev_page' => :'Integer',
+        :'total_pages' => :'Integer',
+        :'total_count' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'next_page',
+        :'prev_page',
+      ])
+    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 `Parlo::ListMeta` 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 `Parlo::ListMeta`. 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?(:'current_page')
+        self.current_page = attributes[:'current_page']
+      else
+        self.current_page = nil
+      end
+
+      if attributes.key?(:'next_page')
+        self.next_page = attributes[:'next_page']
+      else
+        self.next_page = nil
+      end
+
+      if attributes.key?(:'prev_page')
+        self.prev_page = attributes[:'prev_page']
+      else
+        self.prev_page = nil
+      end
+
+      if attributes.key?(:'total_pages')
+        self.total_pages = attributes[:'total_pages']
+      else
+        self.total_pages = nil
+      end
+
+      if attributes.key?(:'total_count')
+        self.total_count = attributes[:'total_count']
+      else
+        self.total_count = 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 @current_page.nil?
+        invalid_properties.push('invalid value for "current_page", current_page cannot be nil.')
+      end
+
+      if @total_pages.nil?
+        invalid_properties.push('invalid value for "total_pages", total_pages cannot be nil.')
+      end
+
+      if @total_count.nil?
+        invalid_properties.push('invalid value for "total_count", total_count 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 @current_page.nil?
+      return false if @total_pages.nil?
+      return false if @total_count.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] current_page Value to be assigned
+    def current_page=(current_page)
+      if current_page.nil?
+        fail ArgumentError, 'current_page cannot be nil'
+      end
+
+      @current_page = current_page
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_pages Value to be assigned
+    def total_pages=(total_pages)
+      if total_pages.nil?
+        fail ArgumentError, 'total_pages cannot be nil'
+      end
+
+      @total_pages = total_pages
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_count Value to be assigned
+    def total_count=(total_count)
+      if total_count.nil?
+        fail ArgumentError, 'total_count cannot be nil'
+      end
+
+      @total_count = total_count
+    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 &&
+          current_page == o.current_page &&
+          next_page == o.next_page &&
+          prev_page == o.prev_page &&
+          total_pages == o.total_pages &&
+          total_count == o.total_count
+    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
+      [current_page, next_page, prev_page, total_pages, total_count].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
+
+    # 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
+
+  end
+
+end

data/lib/parlo-sdk/models/send_email_request.rb

@@ -3,7 +3,7 @@
 
 #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.1.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.24.0-SNAPSHOT
@@ -37,7 +37,7 @@ module Parlo
     # Values substituted into [placeholder] tokens in subject/html/text.
     attr_accessor :data
 
-    # Arbitrary string key/value pairs attached to the message.
+    # Key/value labels stored with the message and attached to its delivery events. Filter on them later with `GET /emails?tags[key]=value`.  Keys and values accept only ASCII letters, digits, underscores and dashes, up to 256 characters each — this matches the constraint of the underlying delivery provider's message tags. Anything else is rejected with `422 invalid` at send time rather than failing later. 
     attr_accessor :tags
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/parlo-sdk/models/send_email_request_cc.rb

@@ -3,7 +3,7 @@
 
 #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.1.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.24.0-SNAPSHOT

data/lib/parlo-sdk/models/send_email_request_to.rb

@@ -3,7 +3,7 @@
 
 #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.1.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.24.0-SNAPSHOT

data/lib/parlo-sdk/models/webhook_event.rb

@@ -0,0 +1,268 @@
+=begin
+#Parlo API
+
+#The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
+
+The version of the OpenAPI document: 1.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module Parlo
+  # The envelope Parlo POSTs to your configured webhook endpoint.
+  class WebhookEvent < ApiModelBase
+    # Unique per event and stable across delivery retries — dedupe on it. 
+    attr_accessor :id
+
+    attr_accessor :type
+
+    attr_accessor :created_at
+
+    attr_accessor :data
+
+    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
+      {
+        :'id' => :'id',
+        :'type' => :'type',
+        :'created_at' => :'created_at',
+        :'data' => :'data'
+      }
+    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',
+        :'type' => :'String',
+        :'created_at' => :'Time',
+        :'data' => :'Email'
+      }
+    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 `Parlo::WebhookEvent` 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 `Parlo::WebhookEvent`. 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']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @id.nil?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["email.delivered", "email.bounced", "email.complained", "email.opened", "email.clicked", "email.failed"])
+      return false unless type_validator.valid?(@type)
+      return false if @created_at.nil?
+      return false if @data.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
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["email.delivered", "email.bounced", "email.complained", "email.opened", "email.clicked", "email.failed"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          type == o.type &&
+          created_at == o.created_at &&
+          data == o.data
+    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, type, created_at, data].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
+
+    # 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
+
+  end
+
+end

data/lib/parlo-sdk/version.rb

@@ -3,7 +3,7 @@
 
 #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.1.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.24.0-SNAPSHOT
@@ -11,5 +11,5 @@ Generator version: 7.24.0-SNAPSHOT
 =end
 
 module Parlo
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/lib/parlo-sdk.rb

@@ -3,7 +3,7 @@
 
 #The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 1.1.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.24.0-SNAPSHOT
@@ -29,11 +29,15 @@ require 'parlo-sdk/models/domain'
 require 'parlo-sdk/models/domain_summary'
 require 'parlo-sdk/models/email'
 require 'parlo-sdk/models/email_created'
+require 'parlo-sdk/models/email_list'
+require 'parlo-sdk/models/email_summary'
 require 'parlo-sdk/models/error'
 require 'parlo-sdk/models/list_domains200_response'
+require 'parlo-sdk/models/list_meta'
 require 'parlo-sdk/models/send_email_request'
 require 'parlo-sdk/models/send_email_request_cc'
 require 'parlo-sdk/models/send_email_request_to'
+require 'parlo-sdk/models/webhook_event'
 
 # APIs
 require 'parlo-sdk/api/domains_api'

data/spec/models/email_list_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#Parlo API
+
+#The Parlo API sends transactional email and manages the sending domains it authenticates from. Marketing campaigns (audiences, templates, broadcasts) are designed and sent from the Parlo dashboard, not this API — the API is transactional-only at launch.  All requests authenticate with a company API key as an HTTP bearer token: `Authorization: Bearer parlo_live_xxx`. Errors return a JSON body of the shape `{ \"message\": string, \"code\": string }`. 
+
+The version of the OpenAPI document: 1.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Parlo::EmailList
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Parlo::EmailList do
+  #let(:instance) { Parlo::EmailList.new }
+
+  describe 'test an instance of EmailList' do
+    it 'should create an instance of EmailList' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Parlo::EmailList)
+    end
+  end
+
+  describe 'test attribute "emails"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "meta"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end