pingram 0.1.0

data/lib/pingram/models/template_patch_request_any_of1_instant.rb

@@ -0,0 +1,184 @@
+=begin
+#NotificationAPI
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  # In-app instant delivery: title, redirect URL, and image URL shown when the notification is delivered in real time.
+  class TemplatePatchRequestAnyOf1Instant < ApiModelBase
+    attr_accessor :title
+
+    attr_accessor :redirect_url
+
+    # Required for instant. Image URL shown in the in-app notification.
+    attr_accessor :image_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'title' => :'title',
+        :'redirect_url' => :'redirectURL',
+        :'image_url' => :'imageURL'
+      }
+    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
+      {
+        :'title' => :'String',
+        :'redirect_url' => :'String',
+        :'image_url' => :'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 `Pingram::TemplatePatchRequestAnyOf1Instant` 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 `Pingram::TemplatePatchRequestAnyOf1Instant`. 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?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      else
+        self.image_url = 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 @image_url.nil?
+        invalid_properties.push('invalid value for "image_url", image_url 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 @image_url.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] image_url Value to be assigned
+    def image_url=(image_url)
+      if image_url.nil?
+        fail ArgumentError, 'image_url cannot be nil'
+      end
+
+      @image_url = image_url
+    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 &&
+          title == o.title &&
+          redirect_url == o.redirect_url &&
+          image_url == o.image_url
+    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
+      [title, redirect_url, image_url].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/pingram/models/template_post_request.rb

@@ -0,0 +1,346 @@
+=begin
+#NotificationAPI
+
+#Internal API for notification delivery and management
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Pingram
+  # Request body for creating a template. Include templateId (required) plus any channel-specific fields for the channel in the path. Which fields apply depends on the channel (EMAIL, INAPP_WEB, SMS, PUSH, etc.).
+  class TemplatePostRequest < ApiModelBase
+    # Unique ID for this template within the notification and channel. Required.
+    attr_accessor :template_id
+
+    # HTML body of the email.
+    attr_accessor :html
+
+    # Preview text (e.g. for inbox).
+    attr_accessor :preview_text
+
+    # Internal editor representation of the email content (e.g. Bee or Redactor JSON). Used for editing and component embedding; the actual email sent to recipients uses the html field.
+    attr_accessor :internal
+
+    # Email subject line.
+    attr_accessor :subject
+
+    # Sender display name.
+    attr_accessor :sender_name
+
+    # Sender email address.
+    attr_accessor :sender_email
+
+    # Migration metadata (e.g. from template migration).
+    attr_accessor :migration
+
+    # Notification title (in-app).
+    attr_accessor :title
+
+    # URL to open when the user taps the notification.
+    attr_accessor :redirect_url
+
+    # Image URL shown in the in-app notification.
+    attr_accessor :image_url
+
+    attr_accessor :instant
+
+    attr_accessor :batch
+
+    # Message text (SMS or call).
+    attr_accessor :text
+
+    # Push notification body text. (title is shared with INAPP_WEB above.)
+    attr_accessor :message
+
+    # Web push: icon URL. Slack: bot icon (emoji or URL).
+    attr_accessor :icon
+
+    # Web push: URL to open when the notification is clicked.
+    attr_accessor :url
+
+    # Slack message blocks (optional).
+    attr_accessor :blocks
+
+    # Slack bot username.
+    attr_accessor :username
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'template_id' => :'templateId',
+        :'html' => :'html',
+        :'preview_text' => :'previewText',
+        :'internal' => :'internal',
+        :'subject' => :'subject',
+        :'sender_name' => :'senderName',
+        :'sender_email' => :'senderEmail',
+        :'migration' => :'migration',
+        :'title' => :'title',
+        :'redirect_url' => :'redirectURL',
+        :'image_url' => :'imageURL',
+        :'instant' => :'instant',
+        :'batch' => :'batch',
+        :'text' => :'text',
+        :'message' => :'message',
+        :'icon' => :'icon',
+        :'url' => :'url',
+        :'blocks' => :'blocks',
+        :'username' => :'username'
+      }
+    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
+      {
+        :'template_id' => :'String',
+        :'html' => :'String',
+        :'preview_text' => :'String',
+        :'internal' => :'String',
+        :'subject' => :'String',
+        :'sender_name' => :'String',
+        :'sender_email' => :'String',
+        :'migration' => :'String',
+        :'title' => :'String',
+        :'redirect_url' => :'String',
+        :'image_url' => :'String',
+        :'instant' => :'TemplatePostRequestInstant',
+        :'batch' => :'TemplatePostRequestBatch',
+        :'text' => :'String',
+        :'message' => :'String',
+        :'icon' => :'String',
+        :'url' => :'String',
+        :'blocks' => :'Array<Hash<String, Object>>',
+        :'username' => :'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 `Pingram::TemplatePostRequest` 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 `Pingram::TemplatePostRequest`. 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?(:'template_id')
+        self.template_id = attributes[:'template_id']
+      else
+        self.template_id = nil
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
+      if attributes.key?(:'preview_text')
+        self.preview_text = attributes[:'preview_text']
+      end
+
+      if attributes.key?(:'internal')
+        self.internal = attributes[:'internal']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'sender_name')
+        self.sender_name = attributes[:'sender_name']
+      end
+
+      if attributes.key?(:'sender_email')
+        self.sender_email = attributes[:'sender_email']
+      end
+
+      if attributes.key?(:'migration')
+        self.migration = attributes[:'migration']
+      end
+
+      if attributes.key?(:'title')
+        self.title = attributes[:'title']
+      end
+
+      if attributes.key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      end
+
+      if attributes.key?(:'image_url')
+        self.image_url = attributes[:'image_url']
+      end
+
+      if attributes.key?(:'instant')
+        self.instant = attributes[:'instant']
+      end
+
+      if attributes.key?(:'batch')
+        self.batch = attributes[:'batch']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      end
+
+      if attributes.key?(:'icon')
+        self.icon = attributes[:'icon']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'blocks')
+        if (value = attributes[:'blocks']).is_a?(Array)
+          self.blocks = value
+        end
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      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 @template_id.nil?
+        invalid_properties.push('invalid value for "template_id", template_id 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 @template_id.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] template_id Value to be assigned
+    def template_id=(template_id)
+      if template_id.nil?
+        fail ArgumentError, 'template_id cannot be nil'
+      end
+
+      @template_id = template_id
+    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 &&
+          template_id == o.template_id &&
+          html == o.html &&
+          preview_text == o.preview_text &&
+          internal == o.internal &&
+          subject == o.subject &&
+          sender_name == o.sender_name &&
+          sender_email == o.sender_email &&
+          migration == o.migration &&
+          title == o.title &&
+          redirect_url == o.redirect_url &&
+          image_url == o.image_url &&
+          instant == o.instant &&
+          batch == o.batch &&
+          text == o.text &&
+          message == o.message &&
+          icon == o.icon &&
+          url == o.url &&
+          blocks == o.blocks &&
+          username == o.username
+    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
+      [template_id, html, preview_text, internal, subject, sender_name, sender_email, migration, title, redirect_url, image_url, instant, batch, text, message, icon, url, blocks, username].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