pingram 1.0.6 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e4c8f5eaa4554d081edda85a3a512cd529bf433cc58c6f8d08282a51914f5d4
-  data.tar.gz: 4318d13e710336127a0b13d0a47296e4ff1f889ef2b9f2c7c26b2098f869b651
+  metadata.gz: 4d92a9fe59994579dcbcbec394a85c59560372c79ab5d15877ec3ea99839b2ad
+  data.tar.gz: 336dd2cd85ca02c0e02f10e4458c677e39222a5b605b93213e9620c04d2757d5
 SHA512:
-  metadata.gz: ef0521c2d19294c45dbc0adf73ad71a1c71229ade16a2f9a49cc9cf3f4ed0311ab275f563b21fba7a63fef8750a5a8f9d2b0a9ccc02b4fbe4be99060c8b38265
-  data.tar.gz: f0e4eff10e4173c072bfd217d4c3f50b8bee7fe96fd2fbdcec1064f49a1aa4256d9e3552e21358b074244e1f69862439e5c55dec1d3274c12fcab7cb441f6227
+  metadata.gz: e04f8ef0c4a9ad04331b0cd121e3777c20873b238b7628edf460ccf46ae5fd851b205da356bfda173b030b7fd40336d50194014c65775c5345d10f687f79ba2a
+  data.tar.gz: 9ed3841babe3555369e40d9b8e40f1494225b2fbd14b8f100d70fc0026757ffa37b3c54865d18ea0437b41790621c97150ea20a23e63770f4c16ab44b5f65879

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pingram (1.0.6)
+    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/profile_api.rb

@@ -0,0 +1,154 @@
+=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 ProfileApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Accept a team invitation using a token
+    # @param accept_invite_request [AcceptInviteRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AcceptInviteResponse]
+    def profile_accept_invite(accept_invite_request, opts = {})
+      data, _status_code, _headers = profile_accept_invite_with_http_info(accept_invite_request, opts)
+      data
+    end
+
+    # Accept a team invitation using a token
+    # @param accept_invite_request [AcceptInviteRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AcceptInviteResponse, Integer, Hash)>] AcceptInviteResponse data, response status code and response headers
+    def profile_accept_invite_with_http_info(accept_invite_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_accept_invite ...'
+      end
+      # verify the required parameter 'accept_invite_request' is set
+      if @api_client.config.client_side_validation && accept_invite_request.nil?
+        fail ArgumentError, "Missing the required parameter 'accept_invite_request' when calling ProfileApi.profile_accept_invite"
+      end
+      # resource path
+      local_var_path = '/profile/accept_invite'
+
+      # 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(accept_invite_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AcceptInviteResponse'
+
+      # 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 => :"ProfileApi.profile_accept_invite",
+        :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: ProfileApi#profile_accept_invite\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Change the email address of the authenticated user
+    # @param change_email_request [ChangeEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessResponse]
+    def profile_change_email(change_email_request, opts = {})
+      data, _status_code, _headers = profile_change_email_with_http_info(change_email_request, opts)
+      data
+    end
+
+    # Change the email address of the authenticated user
+    # @param change_email_request [ChangeEmailRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessResponse, Integer, Hash)>] SuccessResponse data, response status code and response headers
+    def profile_change_email_with_http_info(change_email_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProfileApi.profile_change_email ...'
+      end
+      # verify the required parameter 'change_email_request' is set
+      if @api_client.config.client_side_validation && change_email_request.nil?
+        fail ArgumentError, "Missing the required parameter 'change_email_request' when calling ProfileApi.profile_change_email"
+      end
+      # resource path
+      local_var_path = '/profile/change-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(change_email_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessResponse'
+
+      # 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 => :"ProfileApi.profile_change_email",
+        :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: ProfileApi#profile_change_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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.6"
+      @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'
@@ -35,10 +37,14 @@ require_relative 'api/numbers_api'
 
 require_relative 'api/organization_api'
 
+require_relative 'api/profile_api'
+
 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'
@@ -81,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)
@@ -97,10 +105,14 @@ module Pingram
 
       @organization = Pingram::OrganizationApi.new(@api_client)
 
-      @push_settings = Pingram::PushsettingsApi.new(@api_client)
+      @profile = Pingram::ProfileApi.new(@api_client)
+
+      @push_settings = Pingram::PushSettingsApi.new(@api_client)
 
       @sender = Pingram::SenderApi.new(@api_client)
 
+      @sms = Pingram::SmsApi.new(@api_client)
+
       @templates = Pingram::TemplatesApi.new(@api_client)
 
       @types = Pingram::TypesApi.new(@api_client)
@@ -150,6 +162,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::EmailApi]
+    def email
+      @email
+    end
+
+
     # @return [Pingram::EnvironmentsApi]
     def environments
       @environments
@@ -198,7 +216,13 @@ module Pingram
     end
 
 
-    # @return [Pingram::PushsettingsApi]
+    # @return [Pingram::ProfileApi]
+    def profile
+      @profile
+    end
+
+
+    # @return [Pingram::PushSettingsApi]
     def push_settings
       @push_settings
     end
@@ -210,6 +234,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::SmsApi]
+    def sms
+      @sms
+    end
+
+
     # @return [Pingram::TemplatesApi]
     def templates
       @templates