pingram 1.0.30 → 1.0.32

data/lib/pingram/models/sender_post_body_user.rb

@@ -38,6 +38,9 @@ module Pingram
 
     attr_accessor :slack_token
 
+    # Custom key-value properties synced by the developer, used for audience segmentation (e.g. broadcast filters on user.properties.plan). Incremental identify calls shallow-merge keys (unset keys are preserved). Limits: max 25 keys, key length <= 64, string values <= 256 chars, serialized size <= 1KB.
+    attr_accessor :properties
+
     # Last activity timestamp. Updated automatically. Read-only.
     attr_accessor :last_seen_time
 
@@ -60,6 +63,7 @@ module Pingram
         :'timezone' => :'timezone',
         :'slack_channel' => :'slackChannel',
         :'slack_token' => :'slackToken',
+        :'properties' => :'properties',
         :'last_seen_time' => :'lastSeenTime',
         :'updated_at' => :'updatedAt',
         :'created_at' => :'createdAt',
@@ -88,6 +92,7 @@ module Pingram
         :'timezone' => :'String',
         :'slack_channel' => :'String',
         :'slack_token' => :'GetUsersResponseUsersInnerSlackToken',
+        :'properties' => :'Hash<String, GetUsersResponseUsersInnerPropertiesValue>',
         :'last_seen_time' => :'String',
         :'updated_at' => :'String',
         :'created_at' => :'String',
@@ -155,6 +160,12 @@ module Pingram
         self.slack_token = attributes[:'slack_token']
       end
 
+      if attributes.key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Hash)
+          self.properties = value
+        end
+      end
+
       if attributes.key?(:'last_seen_time')
         self.last_seen_time = attributes[:'last_seen_time']
       end
@@ -215,6 +226,7 @@ module Pingram
           timezone == o.timezone &&
           slack_channel == o.slack_channel &&
           slack_token == o.slack_token &&
+          properties == o.properties &&
           last_seen_time == o.last_seen_time &&
           updated_at == o.updated_at &&
           created_at == o.created_at &&
@@ -230,7 +242,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, number, push_tokens, web_push_tokens, timezone, slack_channel, slack_token, last_seen_time, updated_at, created_at, email_suppression_status].hash
+      [id, email, number, push_tokens, web_push_tokens, timezone, slack_channel, slack_token, properties, last_seen_time, updated_at, created_at, email_suppression_status].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/update_broadcast_request.rb

@@ -0,0 +1,264 @@
+=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
+  class UpdateBroadcastRequest < ApiModelBase
+    attr_accessor :name
+
+    attr_accessor :type
+
+    attr_accessor :channel
+
+    attr_accessor :audience
+
+    attr_accessor :from_name
+
+    attr_accessor :from_address
+
+    # Omit to leave unchanged. Empty string clears Reply-To.
+    attr_accessor :reply_to_address
+
+    attr_accessor :subject
+
+    attr_accessor :html
+
+    # Optional visual-editor source. Can be updated only when the broadcast was created with it; cannot be added to an html-only broadcast. Pair with html.
+    attr_accessor :internal_template
+
+    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
+      {
+        :'name' => :'name',
+        :'type' => :'type',
+        :'channel' => :'channel',
+        :'audience' => :'audience',
+        :'from_name' => :'fromName',
+        :'from_address' => :'fromAddress',
+        :'reply_to_address' => :'replyToAddress',
+        :'subject' => :'subject',
+        :'html' => :'html',
+        :'internal_template' => :'internalTemplate'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'type' => :'String',
+        :'channel' => :'String',
+        :'audience' => :'BroadcastResponseAudience',
+        :'from_name' => :'String',
+        :'from_address' => :'String',
+        :'reply_to_address' => :'String',
+        :'subject' => :'String',
+        :'html' => :'String',
+        :'internal_template' => :'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::UpdateBroadcastRequest` 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::UpdateBroadcastRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'audience')
+        self.audience = attributes[:'audience']
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'from_address')
+        self.from_address = attributes[:'from_address']
+      end
+
+      if attributes.key?(:'reply_to_address')
+        self.reply_to_address = attributes[:'reply_to_address']
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      end
+
+      if attributes.key?(:'internal_template')
+        self.internal_template = attributes[:'internal_template']
+      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'
+      channel_validator = EnumAttributeValidator.new('String', ["email"])
+      return false unless channel_validator.valid?(@channel)
+      true
+    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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          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
+    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
+      [name, type, channel, audience, from_name, from_address, reply_to_address, subject, html, internal_template].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/user.rb

@@ -38,6 +38,9 @@ module Pingram
 
     attr_accessor :slack_token
 
+    # Custom key-value properties synced by the developer, used for audience segmentation (e.g. broadcast filters on user.properties.plan). Incremental identify calls shallow-merge keys (unset keys are preserved). Limits: max 25 keys, key length <= 64, string values <= 256 chars, serialized size <= 1KB.
+    attr_accessor :properties
+
     # Last activity timestamp. Updated automatically. Read-only.
     attr_accessor :last_seen_time
 
@@ -60,6 +63,7 @@ module Pingram
         :'timezone' => :'timezone',
         :'slack_channel' => :'slackChannel',
         :'slack_token' => :'slackToken',
+        :'properties' => :'properties',
         :'last_seen_time' => :'lastSeenTime',
         :'updated_at' => :'updatedAt',
         :'created_at' => :'createdAt',
@@ -88,6 +92,7 @@ module Pingram
         :'timezone' => :'String',
         :'slack_channel' => :'String',
         :'slack_token' => :'GetUsersResponseUsersInnerSlackToken',
+        :'properties' => :'Hash<String, GetUsersResponseUsersInnerPropertiesValue>',
         :'last_seen_time' => :'String',
         :'updated_at' => :'String',
         :'created_at' => :'String',
@@ -155,6 +160,12 @@ module Pingram
         self.slack_token = attributes[:'slack_token']
       end
 
+      if attributes.key?(:'properties')
+        if (value = attributes[:'properties']).is_a?(Hash)
+          self.properties = value
+        end
+      end
+
       if attributes.key?(:'last_seen_time')
         self.last_seen_time = attributes[:'last_seen_time']
       end
@@ -215,6 +226,7 @@ module Pingram
           timezone == o.timezone &&
           slack_channel == o.slack_channel &&
           slack_token == o.slack_token &&
+          properties == o.properties &&
           last_seen_time == o.last_seen_time &&
           updated_at == o.updated_at &&
           created_at == o.created_at &&
@@ -230,7 +242,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, number, push_tokens, web_push_tokens, timezone, slack_channel, slack_token, last_seen_time, updated_at, created_at, email_suppression_status].hash
+      [id, email, number, push_tokens, web_push_tokens, timezone, slack_channel, slack_token, properties, last_seen_time, updated_at, created_at, email_suppression_status].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/{events_webhook_response.rb → webhook_endpoint.rb}

@@ -14,15 +14,15 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Events webhook configuration returned by the API.
-  class EventsWebhookResponse < ApiModelBase
-    # Storage key in the format accountId:envId (currently accountId:accountId for account-scoped usage).
-    attr_accessor :webhook_id
+  # Destination URL that receives signed event payloads for a set of subscribed events.
+  class WebhookEndpoint < ApiModelBase
+    # Unique identifier for this endpoint within the account.
+    attr_accessor :id
 
     # Destination URL that receives webhook event payloads.
     attr_accessor :webhook
 
-    # List of subscribed event types for this webhook configuration.
+    # List of subscribed event types for this endpoint.
     attr_accessor :events
 
     # HMAC secret for verifying webhook signatures. Use this with your X-Pingram-Signature verification.
@@ -53,7 +53,7 @@ module Pingram
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'webhook_id' => :'webhookId',
+        :'id' => :'id',
         :'webhook' => :'webhook',
         :'events' => :'events',
         :'secret' => :'secret'
@@ -73,7 +73,7 @@ module Pingram
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'webhook_id' => :'String',
+        :'id' => :'String',
         :'webhook' => :'String',
         :'events' => :'Array<String>',
         :'secret' => :'String'
@@ -90,22 +90,22 @@ module Pingram
     # @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::EventsWebhookResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::WebhookEndpoint` 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::EventsWebhookResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::WebhookEndpoint`. 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?(:'webhook_id')
-        self.webhook_id = attributes[:'webhook_id']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       else
-        self.webhook_id = nil
+        self.id = nil
       end
 
       if attributes.key?(:'webhook')
@@ -134,8 +134,8 @@ module Pingram
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @webhook_id.nil?
-        invalid_properties.push('invalid value for "webhook_id", webhook_id cannot be nil.')
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
       if @webhook.nil?
@@ -157,7 +157,7 @@ module Pingram
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @webhook_id.nil?
+      return false if @id.nil?
       return false if @webhook.nil?
       return false if @events.nil?
       return false if @secret.nil?
@@ -165,13 +165,13 @@ module Pingram
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] webhook_id Value to be assigned
-    def webhook_id=(webhook_id)
-      if webhook_id.nil?
-        fail ArgumentError, 'webhook_id cannot be nil'
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
       end
 
-      @webhook_id = webhook_id
+      @id = id
     end
 
     # Custom attribute writer method with validation
@@ -199,7 +199,7 @@ module Pingram
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          webhook_id == o.webhook_id &&
+          id == o.id &&
           webhook == o.webhook &&
           events == o.events &&
           secret == o.secret
@@ -214,7 +214,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [webhook_id, webhook, events, secret].hash
+      [id, webhook, events, secret].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/{events_webhook_upsert_request.rb → webhook_endpoint_upsert_request.rb}

@@ -14,8 +14,8 @@ require 'date'
 require 'time'
 
 module Pingram
-  # Request body for creating or updating the events webhook configuration.
-  class EventsWebhookUpsertRequest < ApiModelBase
+  # Request body for creating or updating an events webhook endpoint.
+  class WebhookEndpointUpsertRequest < ApiModelBase
     # Destination URL that receives webhook event payloads. Must be a valid http(s) URL.
     attr_accessor :webhook
 
@@ -80,14 +80,14 @@ module Pingram
     # @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::EventsWebhookUpsertRequest` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::WebhookEndpointUpsertRequest` 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::EventsWebhookUpsertRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::WebhookEndpointUpsertRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }

data/lib/pingram/models/webhook_endpoints_response.rb

@@ -0,0 +1,168 @@
+=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
+  # Events webhook endpoints configured for the current account.
+  class WebhookEndpointsResponse < ApiModelBase
+    # Configured webhook endpoints. Empty when none exist.
+    attr_accessor :endpoints
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'endpoints' => :'endpoints'
+      }
+    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
+      {
+        :'endpoints' => :'Array<WebhookEndpointsResponseEndpointsInner>'
+      }
+    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::WebhookEndpointsResponse` 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::WebhookEndpointsResponse`. 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?(:'endpoints')
+        if (value = attributes[:'endpoints']).is_a?(Array)
+          self.endpoints = value
+        end
+      else
+        self.endpoints = 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 @endpoints.nil?
+        invalid_properties.push('invalid value for "endpoints", endpoints 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 @endpoints.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] endpoints Value to be assigned
+    def endpoints=(endpoints)
+      if endpoints.nil?
+        fail ArgumentError, 'endpoints cannot be nil'
+      end
+
+      @endpoints = endpoints
+    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 &&
+          endpoints == o.endpoints
+    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
+      [endpoints].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