pingram 1.0.31 → 1.0.32

data/lib/pingram/models/broadcast_response.rb

@@ -0,0 +1,525 @@
+=begin
+#Pingram
+
+#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
+  # Broadcast as returned by the API (html + optional internalTemplate on single-get only).
+  class BroadcastResponse < ApiModelBase
+    # UUIDv7 (time-ordered).
+    attr_accessor :broadcast_id
+
+    attr_accessor :name
+
+    # Lifecycle status of an email broadcast.
+    attr_accessor :status
+
+    attr_accessor :paused_reason
+
+    # Notification type id. Required before send or schedule.
+    attr_accessor :type
+
+    # Email-only in v1; forward-compatible field.
+    attr_accessor :channel
+
+    attr_accessor :audience
+
+    attr_accessor :from_name
+
+    attr_accessor :from_address
+
+    attr_accessor :reply_to_address
+
+    attr_accessor :subject
+
+    # Send-ready HTML body.
+    attr_accessor :html
+
+    # Optional visual-editor source. Can only be set at create time and must stay paired with html.
+    attr_accessor :internal_template
+
+    # ISO datetime for scheduled broadcasts.
+    attr_accessor :schedule_at
+
+    # Set when the user archives the broadcast; hidden from the default list.
+    attr_accessor :archived_at
+
+    attr_accessor :created_at
+
+    attr_accessor :updated_at
+
+    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
+      {
+        :'broadcast_id' => :'broadcastId',
+        :'name' => :'name',
+        :'status' => :'status',
+        :'paused_reason' => :'pausedReason',
+        :'type' => :'type',
+        :'channel' => :'channel',
+        :'audience' => :'audience',
+        :'from_name' => :'fromName',
+        :'from_address' => :'fromAddress',
+        :'reply_to_address' => :'replyToAddress',
+        :'subject' => :'subject',
+        :'html' => :'html',
+        :'internal_template' => :'internalTemplate',
+        :'schedule_at' => :'scheduleAt',
+        :'archived_at' => :'archivedAt',
+        :'created_at' => :'createdAt',
+        :'updated_at' => :'updatedAt'
+      }
+    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
+      {
+        :'broadcast_id' => :'String',
+        :'name' => :'String',
+        :'status' => :'String',
+        :'paused_reason' => :'String',
+        :'type' => :'String',
+        :'channel' => :'String',
+        :'audience' => :'BroadcastResponseAudience',
+        :'from_name' => :'String',
+        :'from_address' => :'String',
+        :'reply_to_address' => :'String',
+        :'subject' => :'String',
+        :'html' => :'String',
+        :'internal_template' => :'String',
+        :'schedule_at' => :'String',
+        :'archived_at' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'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::BroadcastResponse` 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::BroadcastResponse`. 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?(:'broadcast_id')
+        self.broadcast_id = attributes[:'broadcast_id']
+      else
+        self.broadcast_id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'paused_reason')
+        self.paused_reason = attributes[:'paused_reason']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      else
+        self.channel = nil
+      end
+
+      if attributes.key?(:'audience')
+        self.audience = attributes[:'audience']
+      else
+        self.audience = nil
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      else
+        self.from_name = nil
+      end
+
+      if attributes.key?(:'from_address')
+        self.from_address = attributes[:'from_address']
+      else
+        self.from_address = nil
+      end
+
+      if attributes.key?(:'reply_to_address')
+        self.reply_to_address = attributes[:'reply_to_address']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      else
+        self.subject = nil
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      else
+        self.html = nil
+      end
+
+      if attributes.key?(:'internal_template')
+        self.internal_template = attributes[:'internal_template']
+      end
+
+      if attributes.key?(:'schedule_at')
+        self.schedule_at = attributes[:'schedule_at']
+      end
+
+      if attributes.key?(:'archived_at')
+        self.archived_at = attributes[:'archived_at']
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      else
+        self.updated_at = 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 @broadcast_id.nil?
+        invalid_properties.push('invalid value for "broadcast_id", broadcast_id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @channel.nil?
+        invalid_properties.push('invalid value for "channel", channel cannot be nil.')
+      end
+
+      if @audience.nil?
+        invalid_properties.push('invalid value for "audience", audience cannot be nil.')
+      end
+
+      if @from_name.nil?
+        invalid_properties.push('invalid value for "from_name", from_name cannot be nil.')
+      end
+
+      if @from_address.nil?
+        invalid_properties.push('invalid value for "from_address", from_address cannot be nil.')
+      end
+
+      if @subject.nil?
+        invalid_properties.push('invalid value for "subject", subject cannot be nil.')
+      end
+
+      if @html.nil?
+        invalid_properties.push('invalid value for "html", html cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push('invalid value for "updated_at", updated_at 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 @broadcast_id.nil?
+      return false if @name.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["draft", "scheduled", "sending", "sent", "paused", "canceled"])
+      return false unless status_validator.valid?(@status)
+      paused_reason_validator = EnumAttributeValidator.new('String', ["PAUSED_BY_USER", "REPUTATION_GUARD", "PLAN_EXCEEDED", "PENDING_VERIFICATION", "AUDIENCE_LIMITS_EXCEEDED", "UNVERIFIED_DOMAIN", "SPAM_CONTENT"])
+      return false unless paused_reason_validator.valid?(@paused_reason)
+      return false if @channel.nil?
+      channel_validator = EnumAttributeValidator.new('String', ["email"])
+      return false unless channel_validator.valid?(@channel)
+      return false if @audience.nil?
+      return false if @from_name.nil?
+      return false if @from_address.nil?
+      return false if @subject.nil?
+      return false if @html.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] broadcast_id Value to be assigned
+    def broadcast_id=(broadcast_id)
+      if broadcast_id.nil?
+        fail ArgumentError, 'broadcast_id cannot be nil'
+      end
+
+      @broadcast_id = broadcast_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["draft", "scheduled", "sending", "sent", "paused", "canceled"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] paused_reason Object to be assigned
+    def paused_reason=(paused_reason)
+      validator = EnumAttributeValidator.new('String', ["PAUSED_BY_USER", "REPUTATION_GUARD", "PLAN_EXCEEDED", "PENDING_VERIFICATION", "AUDIENCE_LIMITS_EXCEEDED", "UNVERIFIED_DOMAIN", "SPAM_CONTENT"])
+      unless validator.valid?(paused_reason)
+        fail ArgumentError, "invalid value for \"paused_reason\", must be one of #{validator.allowable_values}."
+      end
+      @paused_reason = paused_reason
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["email"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] audience Value to be assigned
+    def audience=(audience)
+      if audience.nil?
+        fail ArgumentError, 'audience cannot be nil'
+      end
+
+      @audience = audience
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_name Value to be assigned
+    def from_name=(from_name)
+      if from_name.nil?
+        fail ArgumentError, 'from_name cannot be nil'
+      end
+
+      @from_name = from_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] from_address Value to be assigned
+    def from_address=(from_address)
+      if from_address.nil?
+        fail ArgumentError, 'from_address cannot be nil'
+      end
+
+      @from_address = from_address
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subject Value to be assigned
+    def subject=(subject)
+      if subject.nil?
+        fail ArgumentError, 'subject cannot be nil'
+      end
+
+      @subject = subject
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] html Value to be assigned
+    def html=(html)
+      if html.nil?
+        fail ArgumentError, 'html cannot be nil'
+      end
+
+      @html = html
+    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] updated_at Value to be assigned
+    def updated_at=(updated_at)
+      if updated_at.nil?
+        fail ArgumentError, 'updated_at cannot be nil'
+      end
+
+      @updated_at = updated_at
+    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 &&
+          broadcast_id == o.broadcast_id &&
+          name == o.name &&
+          status == o.status &&
+          paused_reason == o.paused_reason &&
+          type == o.type &&
+          channel == o.channel &&
+          audience == o.audience &&
+          from_name == o.from_name &&
+          from_address == o.from_address &&
+          reply_to_address == o.reply_to_address &&
+          subject == o.subject &&
+          html == o.html &&
+          internal_template == o.internal_template &&
+          schedule_at == o.schedule_at &&
+          archived_at == o.archived_at &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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
+      [broadcast_id, name, status, paused_reason, type, channel, audience, from_name, from_address, reply_to_address, subject, html, internal_template, schedule_at, archived_at, created_at, updated_at].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/broadcast_response_audience.rb

@@ -0,0 +1,161 @@
+=begin
+#Pingram
+
+#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
+  # Broadcast audience: exactly one of `filter` (Mongo-style query evaluated against synced user objects) or `emails` (raw list, max 10,000 addresses; for larger audiences use filter after syncing users via the Users API).
+  class BroadcastResponseAudience < ApiModelBase
+    attr_accessor :filter
+
+    attr_accessor :emails
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filter' => :'filter',
+        :'emails' => :'emails'
+      }
+    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
+      {
+        :'filter' => :'Hash<String, Object>',
+        :'emails' => :'Array<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::BroadcastResponseAudience` 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::BroadcastResponseAudience`. 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?(:'filter')
+        if (value = attributes[:'filter']).is_a?(Hash)
+          self.filter = value
+        end
+      end
+
+      if attributes.key?(:'emails')
+        if (value = attributes[:'emails']).is_a?(Array)
+          self.emails = 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
+      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 &&
+          filter == o.filter &&
+          emails == o.emails
+    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
+      [filter, emails].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