pingram 1.0.38 → 1.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ec5493d49a8f9bab8f71746b3ba6d89b6482b3e045559785ee29f4f50381d2b
-  data.tar.gz: dd077466c0bb462e879e3c896eda7e5c54b66bbaa709213913b703ee1716469b
+  metadata.gz: 3521645359a81dc82e84e9f12ae5d019dce125e556cb5661cd04eb924cc7bc9a
+  data.tar.gz: 12080816cec42686dd955540577e9ba52b07b4f82cab9fcbc3cca78cd3c8e8c0
 SHA512:
-  metadata.gz: 970e33fa4adff43a013129f394901bad68a9377a9c9923e02ac03aa37b950906dbc5c39719f8d1ff90af151e5d92474890caaca4fa9ff6108a4b2cf65251fb9a
-  data.tar.gz: 791e8d54009c3084df6156930552da132df8901a08f75795ff0167b719262683af36f3e06e9e7ffce9e7560d1db236fa795fcef288f20aec0b11c4caf66b6c94
+  metadata.gz: d8a97c832a2bd1a1d643f4730b1928cea3282c08c061d9d9d39c860202112576fd42c9ef10797064759d857f8403fa74df7b4de40a5e7a91e7f891df684e7e22
+  data.tar.gz: 8abc49f3658f4c83b5d046a3429eb03dbe0ed36c4b302c01a9cdaf70fb9b3e226de7c193da3ca674f5e64e4db9667279340cfbbf13b389fb4f217b158e44f8b6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.38)
+    pingram (1.0.39)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/lib/pingram/api/logs_api.rb

@@ -19,6 +19,67 @@ module Pingram
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Look up email and SMS delivery status for up to 25 tracking IDs. Each entry is the tracking id, channel (EMAIL or SMS), status, and the time that status was recorded. The result does not include recipients, phone numbers, user ids, request bodies, IP addresses, account ids, or user-agent data. Unknown tracking ids are omitted. Other channels are not included.
+    # @param tracking_ids [String] Comma-separated tracking IDs (URL encoded, max 25)
+    # @param [Hash] opts the optional parameters
+    # @return [LogsDeliveryStatusResponse]
+    def logs_get_delivery_status(tracking_ids, opts = {})
+      data, _status_code, _headers = logs_get_delivery_status_with_http_info(tracking_ids, opts)
+      data
+    end
+
+    # Look up email and SMS delivery status for up to 25 tracking IDs. Each entry is the tracking id, channel (EMAIL or SMS), status, and the time that status was recorded. The result does not include recipients, phone numbers, user ids, request bodies, IP addresses, account ids, or user-agent data. Unknown tracking ids are omitted. Other channels are not included.
+    # @param tracking_ids [String] Comma-separated tracking IDs (URL encoded, max 25)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LogsDeliveryStatusResponse, Integer, Hash)>] LogsDeliveryStatusResponse data, response status code and response headers
+    def logs_get_delivery_status_with_http_info(tracking_ids, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LogsApi.logs_get_delivery_status ...'
+      end
+      # verify the required parameter 'tracking_ids' is set
+      if @api_client.config.client_side_validation && tracking_ids.nil?
+        fail ArgumentError, "Missing the required parameter 'tracking_ids' when calling LogsApi.logs_get_delivery_status"
+      end
+      # resource path
+      local_var_path = '/logs/status/{trackingIds}'.sub('{' + 'trackingIds' + '}', CGI.escape(tracking_ids.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LogsDeliveryStatusResponse'
+
+      # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
+      auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']
+
+      new_options = opts.merge(
+        :operation => :"LogsApi.logs_get_delivery_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: LogsApi#logs_get_delivery_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get log retention period in days for the account
     # @param [Hash] opts the optional parameters
     # @return [LogsRetentionResponse]
@@ -135,7 +196,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get logs by tracking IDs (comma-separated, max 25 IDs). Use after sending email or SMS to look up delivery status.
+    # Get logs by tracking IDs (comma-separated, max 25 IDs). Returns full log objects with personally identifiable information (recipients, user ids, phone numbers, and request details). For a simple delivery check, use Get Delivery Status.
     # @param tracking_ids [String] Comma-separated tracking IDs (URL encoded)
     # @param [Hash] opts the optional parameters
     # @return [LogsGetResponse]
@@ -144,7 +205,7 @@ module Pingram
       data
     end
 
-    # Get logs by tracking IDs (comma-separated, max 25 IDs). Use after sending email or SMS to look up delivery status.
+    # Get logs by tracking IDs (comma-separated, max 25 IDs). Returns full log objects with personally identifiable information (recipients, user ids, phone numbers, and request details). For a simple delivery check, use Get Delivery Status.
     # @param tracking_ids [String] Comma-separated tracking IDs (URL encoded)
     # @param [Hash] opts the optional parameters
     # @return [Array<(LogsGetResponse, Integer, Hash)>] LogsGetResponse data, response status code and response headers

data/lib/pingram/api_client.rb

@@ -32,7 +32,7 @@ module Pingram
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "pingram-ruby/1.0.38"
+      @user_agent = "pingram-ruby/1.0.39"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/models/logs_delivery_status_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
+  # Response type for GET /logs/status/{trackingIds}. Unknown tracking ids are omitted. A log that is still ingesting is omitted until it can be read.
+  class LogsDeliveryStatusResponse < ApiModelBase
+    # Delivery outcomes for the requested tracking ids.
+    attr_accessor :statuses
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'statuses' => :'statuses'
+      }
+    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
+      {
+        :'statuses' => :'Array<LogsDeliveryStatusResponseStatusesInner>'
+      }
+    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::LogsDeliveryStatusResponse` 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::LogsDeliveryStatusResponse`. 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?(:'statuses')
+        if (value = attributes[:'statuses']).is_a?(Array)
+          self.statuses = value
+        end
+      else
+        self.statuses = 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 @statuses.nil?
+        invalid_properties.push('invalid value for "statuses", statuses 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 @statuses.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] statuses Value to be assigned
+    def statuses=(statuses)
+      if statuses.nil?
+        fail ArgumentError, 'statuses cannot be nil'
+      end
+
+      @statuses = statuses
+    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 &&
+          statuses == o.statuses
+    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
+      [statuses].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/logs_delivery_status_response_statuses_inner.rb

@@ -0,0 +1,266 @@
+=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
+  # One delivery outcome. Fields are limited to the tracking id, channel, status, and the time that status was recorded. `channel` is omitted when the outcome is for the whole request, before a channel was chosen.
+  class LogsDeliveryStatusResponseStatusesInner < ApiModelBase
+    # Opaque id returned when the notification was accepted.
+    attr_accessor :tracking_id
+
+    # Channel named on a delivery-status row. Email and SMS only. Coarse labels: no address or provider id.
+    attr_accessor :channel
+
+    # Delivery outcome for one request or one channel. These are the same states shown in the dashboard status column.
+    attr_accessor :status
+
+    # ISO 8601 time this outcome was recorded.
+    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
+      {
+        :'tracking_id' => :'trackingId',
+        :'channel' => :'channel',
+        :'status' => :'status',
+        :'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
+      {
+        :'tracking_id' => :'String',
+        :'channel' => :'String',
+        :'status' => :'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::LogsDeliveryStatusResponseStatusesInner` 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::LogsDeliveryStatusResponseStatusesInner`. 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?(:'tracking_id')
+        self.tracking_id = attributes[:'tracking_id']
+      else
+        self.tracking_id = nil
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = 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 @tracking_id.nil?
+        invalid_properties.push('invalid value for "tracking_id", tracking_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @tracking_id.nil?
+      channel_validator = EnumAttributeValidator.new('String', ["EMAIL", "SMS"])
+      return false unless channel_validator.valid?(@channel)
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["PROCESSING", "FAILED", "IGNORED", "SCHEDULED", "UNSCHEDULED", "BATCHED", "SENT", "DELIVERED", "BOUNCED", "COMPLAINT", "THROTTLED", "DEDUPLICATED", "OPENED", "CLICKED", "INBOUND", "AUTO_REPLY"])
+      return false unless status_validator.valid?(@status)
+      return false if @updated_at.nil?
+      true
+    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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["EMAIL", "SMS"])
+      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 checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["PROCESSING", "FAILED", "IGNORED", "SCHEDULED", "UNSCHEDULED", "BATCHED", "SENT", "DELIVERED", "BOUNCED", "COMPLAINT", "THROTTLED", "DEDUPLICATED", "OPENED", "CLICKED", "INBOUND", "AUTO_REPLY"])
+      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 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 &&
+          tracking_id == o.tracking_id &&
+          channel == o.channel &&
+          status == o.status &&
+          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
+      [tracking_id, channel, status, 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/version.rb

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

data/lib/pingram.rb

@@ -205,6 +205,8 @@ require 'pingram/models/list_voice_calls_response'
 require 'pingram/models/list_voice_calls_response_calls_inner'
 require 'pingram/models/log_query_post_body'
 require 'pingram/models/logs_bulk_request'
+require 'pingram/models/logs_delivery_status_response'
+require 'pingram/models/logs_delivery_status_response_statuses_inner'
 require 'pingram/models/logs_get_response'
 require 'pingram/models/logs_get_response_logs_inner'
 require 'pingram/models/logs_query_response'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pingram
 version: !ruby/object:Gem::Version
-  version: 1.0.38
+  version: 1.0.39
 platform: ruby
 authors:
 - Pingram
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-08 00:00:00.000000000 Z
+date: 2026-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -281,6 +281,8 @@ files:
 - lib/pingram/models/list_voice_calls_response_calls_inner.rb
 - lib/pingram/models/log_query_post_body.rb
 - lib/pingram/models/logs_bulk_request.rb
+- lib/pingram/models/logs_delivery_status_response.rb
+- lib/pingram/models/logs_delivery_status_response_statuses_inner.rb
 - lib/pingram/models/logs_get_response.rb
 - lib/pingram/models/logs_get_response_logs_inner.rb
 - lib/pingram/models/logs_query_response.rb