pingram 1.0.10 → 1.0.12

data/lib/pingram/models/webhook_event.rb

@@ -0,0 +1,328 @@
+=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
+  # Webhook event payload sent to customer endpoints. Use this type with SDK webhook verification methods (e.g., verify from 'pingram/webhooks').
+  class WebhookEvent < ApiModelBase
+    attr_accessor :event_type
+
+    attr_accessor :channel
+
+    # User ID the notification was sent to.
+    attr_accessor :user_id
+
+    # Notification type ID.
+    attr_accessor :notification_id
+
+    # Unique tracking ID for this notification instance.
+    attr_accessor :tracking_id
+
+    # Failure code for *_FAILED events.
+    attr_accessor :failure_code
+
+    # Clicked URL for EMAIL_CLICK events.
+    attr_accessor :clicked_link
+
+    # Link tags for EMAIL_CLICK events.
+    attr_accessor :clicked_link_tags
+
+    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
+      {
+        :'event_type' => :'eventType',
+        :'channel' => :'channel',
+        :'user_id' => :'userId',
+        :'notification_id' => :'notificationId',
+        :'tracking_id' => :'trackingId',
+        :'failure_code' => :'failureCode',
+        :'clicked_link' => :'clickedLink',
+        :'clicked_link_tags' => :'clickedLinkTags'
+      }
+    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
+      {
+        :'event_type' => :'String',
+        :'channel' => :'ChannelsEnum',
+        :'user_id' => :'String',
+        :'notification_id' => :'String',
+        :'tracking_id' => :'String',
+        :'failure_code' => :'String',
+        :'clicked_link' => :'String',
+        :'clicked_link_tags' => :'Hash<String, 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::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 `Pingram::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?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      else
+        self.event_type = nil
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      else
+        self.channel = nil
+      end
+
+      if attributes.key?(:'user_id')
+        self.user_id = attributes[:'user_id']
+      else
+        self.user_id = nil
+      end
+
+      if attributes.key?(:'notification_id')
+        self.notification_id = attributes[:'notification_id']
+      else
+        self.notification_id = nil
+      end
+
+      if attributes.key?(:'tracking_id')
+        self.tracking_id = attributes[:'tracking_id']
+      else
+        self.tracking_id = nil
+      end
+
+      if attributes.key?(:'failure_code')
+        self.failure_code = attributes[:'failure_code']
+      end
+
+      if attributes.key?(:'clicked_link')
+        self.clicked_link = attributes[:'clicked_link']
+      end
+
+      if attributes.key?(:'clicked_link_tags')
+        if (value = attributes[:'clicked_link_tags']).is_a?(Hash)
+          self.clicked_link_tags = 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
+      if @event_type.nil?
+        invalid_properties.push('invalid value for "event_type", event_type cannot be nil.')
+      end
+
+      if @channel.nil?
+        invalid_properties.push('invalid value for "channel", channel cannot be nil.')
+      end
+
+      if @user_id.nil?
+        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
+      end
+
+      if @notification_id.nil?
+        invalid_properties.push('invalid value for "notification_id", notification_id cannot be nil.')
+      end
+
+      if @tracking_id.nil?
+        invalid_properties.push('invalid value for "tracking_id", tracking_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 @event_type.nil?
+      event_type_validator = EnumAttributeValidator.new('String', ["EMAIL_OPEN", "EMAIL_CLICK", "EMAIL_FAILED", "EMAIL_DELIVERED", "EMAIL_UNSUBSCRIBE", "EMAIL_INBOUND", "INAPP_WEB_FAILED", "INAPP_WEB_UNSUBSCRIBE", "SMS_DELIVERED", "SMS_FAILED", "SMS_UNSUBSCRIBE", "SMS_SUBSCRIBE", "SMS_INBOUND", "PUSH_FAILED", "PUSH_UNSUBSCRIBE", "CALL_FAILED", "CALL_UNSUBSCRIBE", "WEB_PUSH_FAILED", "WEB_PUSH_UNSUBSCRIBE", "SLACK_FAILED", "SLACK_UNSUBSCRIBE", "VOICE_INBOUND"])
+      return false unless event_type_validator.valid?(@event_type)
+      return false if @channel.nil?
+      return false if @user_id.nil?
+      return false if @notification_id.nil?
+      return false if @tracking_id.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] event_type Object to be assigned
+    def event_type=(event_type)
+      validator = EnumAttributeValidator.new('String', ["EMAIL_OPEN", "EMAIL_CLICK", "EMAIL_FAILED", "EMAIL_DELIVERED", "EMAIL_UNSUBSCRIBE", "EMAIL_INBOUND", "INAPP_WEB_FAILED", "INAPP_WEB_UNSUBSCRIBE", "SMS_DELIVERED", "SMS_FAILED", "SMS_UNSUBSCRIBE", "SMS_SUBSCRIBE", "SMS_INBOUND", "PUSH_FAILED", "PUSH_UNSUBSCRIBE", "CALL_FAILED", "CALL_UNSUBSCRIBE", "WEB_PUSH_FAILED", "WEB_PUSH_UNSUBSCRIBE", "SLACK_FAILED", "SLACK_UNSUBSCRIBE", "VOICE_INBOUND"])
+      unless validator.valid?(event_type)
+        fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
+      end
+      @event_type = event_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] channel Value to be assigned
+    def channel=(channel)
+      if channel.nil?
+        fail ArgumentError, 'channel cannot be nil'
+      end
+
+      @channel = channel
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_id Value to be assigned
+    def user_id=(user_id)
+      if user_id.nil?
+        fail ArgumentError, 'user_id cannot be nil'
+      end
+
+      @user_id = user_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] notification_id Value to be assigned
+    def notification_id=(notification_id)
+      if notification_id.nil?
+        fail ArgumentError, 'notification_id cannot be nil'
+      end
+
+      @notification_id = notification_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracking_id Value to be assigned
+    def tracking_id=(tracking_id)
+      if tracking_id.nil?
+        fail ArgumentError, 'tracking_id cannot be nil'
+      end
+
+      @tracking_id = tracking_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 &&
+          event_type == o.event_type &&
+          channel == o.channel &&
+          user_id == o.user_id &&
+          notification_id == o.notification_id &&
+          tracking_id == o.tracking_id &&
+          failure_code == o.failure_code &&
+          clicked_link == o.clicked_link &&
+          clicked_link_tags == o.clicked_link_tags
+    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
+      [event_type, channel, user_id, notification_id, tracking_id, failure_code, clicked_link, clicked_link_tags].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/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Pingram
-  VERSION = '1.0.10'
+  VERSION = '1.0.12'
 end

data/lib/pingram/webhooks.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# This file is auto-generated by tools/sdk-codegen/generate-ruby-wrapper.ts
+# DO NOT EDIT MANUALLY - changes will be overwritten
+# Edit sdks/ruby/templates/webhooks.rb.mustache instead
+
+require 'json'
+require 'openssl'
+require_relative 'models/webhook_event'
+
+module Pingram
+  # Error raised when webhook signature verification fails.
+  class WebhookSignatureError < StandardError; end
+
+  # Error raised when webhook timestamp is outside tolerance.
+  class WebhookTimestampError < StandardError; end
+
+  # Verifies HMAC signatures on webhook payloads. Call class methods on {WebhookVerification}.
+  class WebhookVerification
+    # Default timestamp tolerance in seconds (5 minutes)
+    DEFAULT_TOLERANCE_SECONDS = 300
+
+    class << self
+      # Verify webhook signature and return the parsed event.
+      def construct_event(payload:, message_id:, signature:, timestamp:, secret:, tolerance: DEFAULT_TOLERANCE_SECONDS)
+        begin
+          timestamp_ms = Integer(timestamp)
+        rescue ArgumentError, TypeError
+          raise WebhookTimestampError, 'Invalid timestamp format'
+        end
+
+        now_ms = (Time.now.to_f * 1000).to_i
+        age = (now_ms - timestamp_ms).abs / 1000.0
+        if age > tolerance
+          raise WebhookTimestampError, "Webhook timestamp is outside tolerance (#{age.to_i}s > #{tolerance}s)"
+        end
+
+        raw_signature = parse_signature(signature)
+        expected_signature = compute_signature(payload, secret, timestamp, message_id)
+
+        unless secure_compare(expected_signature, raw_signature)
+          raise WebhookSignatureError, 'Invalid webhook signature'
+        end
+
+        begin
+          data = JSON.parse(payload)
+          WebhookEvent.build_from_hash(data)
+        rescue JSON::ParserError => e
+          raise WebhookSignatureError, "Invalid JSON payload: #{e.message}"
+        end
+      end
+
+      def verify(payload:, message_id:, signature:, timestamp:, secret:, tolerance: DEFAULT_TOLERANCE_SECONDS)
+        construct_event(
+          payload: payload,
+          message_id: message_id,
+          signature: signature,
+          timestamp: timestamp,
+          secret: secret,
+          tolerance: tolerance
+        )
+      end
+
+      private
+
+      def parse_signature(signature)
+        parts = signature.split(',', 2)
+        raise WebhookSignatureError, 'Invalid signature format' unless parts.length == 2 && parts[0] == 'v1'
+        parts[1]
+      end
+
+      def compute_signature(payload, secret, timestamp, message_id)
+        signed_payload = "#{message_id}.#{timestamp}.#{payload}"
+        OpenSSL::HMAC.hexdigest('SHA256', secret, signed_payload)
+      end
+
+      def secure_compare(a, b)
+        return false unless a.bytesize == b.bytesize
+
+        if OpenSSL.respond_to?(:secure_compare)
+          OpenSSL.secure_compare(a, b)
+        else
+          l = a.unpack('C*')
+          r = 0
+          i = -1
+          b.each_byte { |v| r |= v ^ l[i += 1] }
+          r == 0
+        end
+      end
+    end
+  end
+
+  def self.webhooks
+    Webhooks
+  end
+end

data/lib/pingram.rb

@@ -17,8 +17,12 @@ require 'pingram/api_model_base'
 require 'pingram/version'
 require 'pingram/configuration'
 require 'pingram/client_wrapper'
+require 'pingram/webhooks'
 
 # Models
+require 'pingram/models/a2p_registration'
+require 'pingram/models/a2p_registration_create_request'
+require 'pingram/models/a2p_registration_update_request'
 require 'pingram/models/apn_config'
 require 'pingram/models/accept_invite_request'
 require 'pingram/models/accept_invite_response'
@@ -42,6 +46,7 @@ require 'pingram/models/create_account_response'
 require 'pingram/models/create_address_request'
 require 'pingram/models/create_key_request'
 require 'pingram/models/create_key_response'
+require 'pingram/models/create_organization_response'
 require 'pingram/models/delete_key_response'
 require 'pingram/models/delete_user_response'
 require 'pingram/models/email_auth_token_post_request'
@@ -219,6 +224,7 @@ require 'pingram/models/template_post_request'
 require 'pingram/models/update_address_request'
 require 'pingram/models/user'
 require 'pingram/models/user_suppression_delete_response'
+require 'pingram/models/webhook_event'
 require 'pingram/models/webhook_response'
 
 # APIs

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pingram
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.0.12
 platform: ruby
 authors:
 - Pingram
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-03 00:00:00.000000000 Z
+date: 2026-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -92,6 +92,9 @@ files:
 - lib/pingram/api_model_base.rb
 - lib/pingram/client_wrapper.rb
 - lib/pingram/configuration.rb
+- lib/pingram/models/a2p_registration.rb
+- lib/pingram/models/a2p_registration_create_request.rb
+- lib/pingram/models/a2p_registration_update_request.rb
 - lib/pingram/models/accept_invite_request.rb
 - lib/pingram/models/accept_invite_response.rb
 - lib/pingram/models/account_addresses_response.rb
@@ -115,6 +118,7 @@ files:
 - lib/pingram/models/create_address_request.rb
 - lib/pingram/models/create_key_request.rb
 - lib/pingram/models/create_key_response.rb
+- lib/pingram/models/create_organization_response.rb
 - lib/pingram/models/delete_key_response.rb
 - lib/pingram/models/delete_user_response.rb
 - lib/pingram/models/email_auth_token_post_request.rb
@@ -292,8 +296,10 @@ files:
 - lib/pingram/models/update_address_request.rb
 - lib/pingram/models/user.rb
 - lib/pingram/models/user_suppression_delete_response.rb
+- lib/pingram/models/webhook_event.rb
 - lib/pingram/models/webhook_response.rb
 - lib/pingram/version.rb
+- lib/pingram/webhooks.rb
 - pingram.gemspec
 - vendor/bundle/ruby/3.2.0/bin/byebug
 - vendor/bundle/ruby/3.2.0/bin/coderay