pingram 1.0.7 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2abf3a6897d1cdfe767b66c5889a9dd10607eb87001dc3637e55e429be76c5f
-  data.tar.gz: fa86061d2712c5edef7988300309984004e0a37618e6433a213ac52985dbdc38
+  metadata.gz: 4d92a9fe59994579dcbcbec394a85c59560372c79ab5d15877ec3ea99839b2ad
+  data.tar.gz: 336dd2cd85ca02c0e02f10e4458c677e39222a5b605b93213e9620c04d2757d5
 SHA512:
-  metadata.gz: c566371e3c23b72669c6bcace4dd146172c19099d88fe7cbf7d202c863cd08134fc8690c8d7f10d5280ca0eb896aa5878f9f89e0349d7b214b6b2cca9243d3da
-  data.tar.gz: d77b8904a84992b84011e4380291cd61e066029c925a0ffea96a10e3ff2355a7dc55dc574c676544e5ac807832ad9255dc0dce302d37ffdab486368c902bb45c
+  metadata.gz: e04f8ef0c4a9ad04331b0cd121e3777c20873b238b7628edf460ccf46ae5fd851b205da356bfda173b030b7fd40336d50194014c65775c5345d10f687f79ba2a
+  data.tar.gz: 9ed3841babe3555369e40d9b8e40f1494225b2fbd14b8f100d70fc0026757ffa37b3c54865d18ea0437b41790621c97150ea20a23e63770f4c16ab44b5f65879

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.7)
+    pingram (1.0.9)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -32,7 +32,7 @@ GEM
     pry-byebug (3.12.0)
       byebug (~> 13.0)
       pry (>= 0.13, < 0.17)
-    psych (5.3.1)
+    psych (5.4.0)
       date
       stringio
     racc (1.8.1)

data/lib/pingram/api/components_api.rb

@@ -114,6 +114,8 @@ module Pingram
 
       # 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] || {}

data/lib/pingram/api/email_api.rb

@@ -0,0 +1,88 @@
+=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 'cgi'
+
+module Pingram
+  class EmailApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Send an email notification directly without templates
+    # @param send_email_request [SendEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendEmailApiResponse]
+    def email_send(send_email_request, opts = {})
+      data, _status_code, _headers = email_send_with_http_info(send_email_request, opts)
+      data
+    end
+
+    # Send an email notification directly without templates
+    # @param send_email_request [SendEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendEmailApiResponse, Integer, Hash)>] SendEmailApiResponse data, response status code and response headers
+    def email_send_with_http_info(send_email_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailApi.email_send ...'
+      end
+      # verify the required parameter 'send_email_request' is set
+      if @api_client.config.client_side_validation && send_email_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_email_request' when calling EmailApi.email_send"
+      end
+      # resource path
+      local_var_path = '/email'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(send_email_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendEmailApiResponse'
+
+      # 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 => :"EmailApi.email_send",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EmailApi#email_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pingram/api/numbers_api.rb

@@ -74,7 +74,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Purchase a Telnyx phone number for the authenticated account
+    # Purchase a phone number for the authenticated account
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [OrderPhoneNumberResponse]
@@ -83,7 +83,7 @@ module Pingram
       data
     end
 
-    # Purchase a Telnyx phone number for the authenticated account
+    # Purchase a phone number for the authenticated account
     # @param order_phone_number_request [OrderPhoneNumberRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(OrderPhoneNumberResponse, Integer, Hash)>] OrderPhoneNumberResponse data, response status code and response headers
@@ -140,7 +140,7 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Search for available Telnyx phone numbers
+    # Search for available phone numbers
     # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :features Comma-separated
@@ -152,7 +152,7 @@ module Pingram
       data
     end
 
-    # Search for available Telnyx phone numbers
+    # Search for available phone numbers
     # @param country_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA)
     # @param [Hash] opts the optional parameters
     # @option opts [String] :features Comma-separated

data/lib/pingram/api/push_settings_api.rb

@@ -42,6 +42,8 @@ module Pingram
 
       # 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] || {}
@@ -95,6 +97,8 @@ module Pingram
 
       # 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] || {}

data/lib/pingram/api/sms_api.rb

@@ -0,0 +1,88 @@
+=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 'cgi'
+
+module Pingram
+  class SmsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Send an SMS notification directly without templates
+    # @param send_sms_request [SendSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SendSmsResponse]
+    def sms_send(send_sms_request, opts = {})
+      data, _status_code, _headers = sms_send_with_http_info(send_sms_request, opts)
+      data
+    end
+
+    # Send an SMS notification directly without templates
+    # @param send_sms_request [SendSmsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SendSmsResponse, Integer, Hash)>] SendSmsResponse data, response status code and response headers
+    def sms_send_with_http_info(send_sms_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SmsApi.sms_send ...'
+      end
+      # verify the required parameter 'send_sms_request' is set
+      if @api_client.config.client_side_validation && send_sms_request.nil?
+        fail ArgumentError, "Missing the required parameter 'send_sms_request' when calling SmsApi.sms_send"
+      end
+      # resource path
+      local_var_path = '/sms'
+
+      # 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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(send_sms_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SendSmsResponse'
+
+      # 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 => :"SmsApi.sms_send",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SmsApi#sms_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pingram/api/templates_api.rb

@@ -138,6 +138,8 @@ module Pingram
 
       # 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] || {}

data/lib/pingram/api/types_api.rb

@@ -114,6 +114,8 @@ module Pingram
 
       # 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] || {}

data/lib/pingram/api/user_api.rb

@@ -54,6 +54,8 @@ module Pingram
 
       # 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']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json'])
       if !content_type.nil?
@@ -173,6 +175,8 @@ module Pingram
 
       # 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] || {}

data/lib/pingram/api/webhooks_api.rb

@@ -42,6 +42,8 @@ module Pingram
 
       # 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] || {}

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.7"
+      @user_agent = "pingram-ruby/1.0.9"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/pingram/api_error.rb

@@ -11,9 +11,39 @@ Generator version: 7.19.0
 =end
 
 module Pingram
+  require 'json'
   class ApiError < StandardError
     attr_reader :code, :response_headers, :response_body
 
+    def self.extract_api_error_detail(payload)
+      return nil if payload.nil?
+
+      raw = payload.is_a?(String) ? payload : payload.to_s
+      return nil if raw.strip.empty?
+
+      begin
+        h = JSON.parse(raw)
+      rescue JSON::ParserError
+        return nil
+      end
+      return nil unless h.is_a?(Hash)
+
+      err = h['error'] || h[:error]
+      if err.is_a?(Hash)
+        m = err['message'] || err[:message]
+        return m.to_s if m && !m.to_s.strip.empty?
+      end
+      m = h['message'] || h[:message]
+      return m.to_s if m && !m.to_s.strip.empty?
+      msgs = h['messages'] || h[:messages]
+      if msgs.is_a?(Array) && !msgs.empty?
+        first = msgs[0]
+        return first.to_s if first && !first.to_s.strip.empty?
+      end
+
+      nil
+    end
+
     # Usage examples:
     #   ApiError.new
     #   ApiError.new("message")
@@ -42,10 +72,16 @@ module Pingram
     end
 
     def message
-      if @message.nil?
-        msg = "Error message: the server returns an error"
-      else
-        msg = @message
+      detail = self.class.extract_api_error_detail(@response_body)
+      msg = nil
+      msg = detail if detail && !detail.strip.empty?
+
+      if msg.nil?
+        if @message.nil?
+          msg = 'Error message: the server returns an error'
+        else
+          msg = @message.to_s
+        end
       end
 
       msg += "\nHTTP status code: #{code}" if code

data/lib/pingram/client_wrapper.rb

@@ -19,6 +19,8 @@ require_relative 'api/domains_api'
 
 require_relative 'api/editor_api'
 
+require_relative 'api/email_api'
+
 require_relative 'api/environments_api'
 
 require_relative 'api/health_api'
@@ -41,6 +43,8 @@ require_relative 'api/push_settings_api'
 
 require_relative 'api/sender_api'
 
+require_relative 'api/sms_api'
+
 require_relative 'api/templates_api'
 
 require_relative 'api/types_api'
@@ -83,6 +87,8 @@ module Pingram
 
       @editor = Pingram::EditorApi.new(@api_client)
 
+      @email = Pingram::EmailApi.new(@api_client)
+
       @environments = Pingram::EnvironmentsApi.new(@api_client)
 
       @health = Pingram::HealthApi.new(@api_client)
@@ -105,6 +111,8 @@ module Pingram
 
       @sender = Pingram::SenderApi.new(@api_client)
 
+      @sms = Pingram::SmsApi.new(@api_client)
+
       @templates = Pingram::TemplatesApi.new(@api_client)
 
       @types = Pingram::TypesApi.new(@api_client)
@@ -154,6 +162,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::EmailApi]
+    def email
+      @email
+    end
+
+
     # @return [Pingram::EnvironmentsApi]
     def environments
       @environments
@@ -220,6 +234,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::SmsApi]
+    def sms
+      @sms
+    end
+
+
     # @return [Pingram::TemplatesApi]
     def templates
       @templates

data/lib/pingram/models/api_error_body.rb

@@ -0,0 +1,223 @@
+=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
+  # Structured error details for API error responses.
+  class ApiErrorBody < ApiModelBase
+    # Machine-readable error code.
+    attr_accessor :code
+
+    # Human-readable error message.
+    attr_accessor :message
+
+    # Actionable hint for fixing the error.
+    attr_accessor :fix
+
+    # Provider that caused the error (e.g. telnyx, ses).
+    attr_accessor :provider
+
+    # Provider-specific error code.
+    attr_accessor :provider_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'code',
+        :'message' => :'message',
+        :'fix' => :'fix',
+        :'provider' => :'provider',
+        :'provider_code' => :'providerCode'
+      }
+    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
+      {
+        :'code' => :'String',
+        :'message' => :'String',
+        :'fix' => :'String',
+        :'provider' => :'String',
+        :'provider_code' => :'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::ApiErrorBody` 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::ApiErrorBody`. 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?(:'code')
+        self.code = attributes[:'code']
+      else
+        self.code = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'fix')
+        self.fix = attributes[:'fix']
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      end
+
+      if attributes.key?(:'provider_code')
+        self.provider_code = attributes[:'provider_code']
+      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 @code.nil?
+        invalid_properties.push('invalid value for "code", code cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message 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 @code.nil?
+      return false if @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if code.nil?
+        fail ArgumentError, 'code cannot be nil'
+      end
+
+      @code = code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    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 &&
+          code == o.code &&
+          message == o.message &&
+          fix == o.fix &&
+          provider == o.provider &&
+          provider_code == o.provider_code
+    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
+      [code, message, fix, provider, provider_code].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