pingram 0.1.0

data/lib/pingram/api_model_base.rb

@@ -0,0 +1,88 @@
+=begin
+#NotificationAPI
+
+#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
+
+module Pingram
+  class ApiModelBase
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Pingram.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/pingram/client_wrapper.rb

@@ -0,0 +1,212 @@
+# 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/Pingram.rb.mustache instead
+
+require_relative 'api_client'
+require_relative 'configuration'
+
+require_relative 'api/account_api'
+
+require_relative 'api/addresses_api'
+
+require_relative 'api/components_api'
+
+require_relative 'api/default_api'
+
+require_relative 'api/domains_api'
+
+require_relative 'api/editor_api'
+
+require_relative 'api/environments_api'
+
+require_relative 'api/health_api'
+
+require_relative 'api/insights_api'
+
+require_relative 'api/keys_api'
+
+require_relative 'api/logs_api'
+
+require_relative 'api/members_api'
+
+require_relative 'api/sender_api'
+
+require_relative 'api/templates_api'
+
+require_relative 'api/types_api'
+
+require_relative 'api/user_api'
+
+require_relative 'api/users_api'
+
+
+module Pingram
+  # High-level Pingram client: holds API key and base URL, exposes tag APIs and +send+.
+  class Client
+    # @return [String] API key (e.g. pingram_sk_...)
+    attr_reader :api_key
+
+    # @return [String, nil] Override base URL (default from Configuration)
+    attr_reader :base_url
+
+    # @param api_key [String] API key (e.g. pingram_sk_...) or JWT
+    # @param base_url [String, nil] Optional override for base URL (e.g. https://api.pingram.io)
+    def initialize(api_key:, base_url: nil)
+      @api_key = api_key
+      @base_url = base_url
+      @config = Pingram::Configuration.default.dup
+      @config.access_token = api_key
+      @config.host = base_url.to_s.sub(%r{/$}, '') if base_url && !base_url.to_s.empty?
+      @api_client = Pingram::ApiClient.new(@config)
+
+      @account = Pingram::AccountApi.new(@api_client)
+
+      @addresses = Pingram::AddressesApi.new(@api_client)
+
+      @components = Pingram::ComponentsApi.new(@api_client)
+
+      @default_api = Pingram::DefaultApi.new(@api_client)
+
+      @domains = Pingram::DomainsApi.new(@api_client)
+
+      @editor = Pingram::EditorApi.new(@api_client)
+
+      @environments = Pingram::EnvironmentsApi.new(@api_client)
+
+      @health = Pingram::HealthApi.new(@api_client)
+
+      @insights = Pingram::InsightsApi.new(@api_client)
+
+      @keys = Pingram::KeysApi.new(@api_client)
+
+      @logs = Pingram::LogsApi.new(@api_client)
+
+      @members = Pingram::MembersApi.new(@api_client)
+
+      @sender = Pingram::SenderApi.new(@api_client)
+
+      @templates = Pingram::TemplatesApi.new(@api_client)
+
+      @types = Pingram::TypesApi.new(@api_client)
+
+      @user = Pingram::UserApi.new(@api_client)
+
+      @users = Pingram::UsersApi.new(@api_client)
+
+    end
+
+
+    # @return [Pingram::AccountApi]
+    def account
+      @account
+    end
+
+
+    # @return [Pingram::AddressesApi]
+    def addresses
+      @addresses
+    end
+
+
+    # @return [Pingram::ComponentsApi]
+    def components
+      @components
+    end
+
+
+    # @return [Pingram::DefaultApi]
+    def default_api
+      @default_api
+    end
+
+
+    # @return [Pingram::DomainsApi]
+    def domains
+      @domains
+    end
+
+
+    # @return [Pingram::EditorApi]
+    def editor
+      @editor
+    end
+
+
+    # @return [Pingram::EnvironmentsApi]
+    def environments
+      @environments
+    end
+
+
+    # @return [Pingram::HealthApi]
+    def health
+      @health
+    end
+
+
+    # @return [Pingram::InsightsApi]
+    def insights
+      @insights
+    end
+
+
+    # @return [Pingram::KeysApi]
+    def keys
+      @keys
+    end
+
+
+    # @return [Pingram::LogsApi]
+    def logs
+      @logs
+    end
+
+
+    # @return [Pingram::MembersApi]
+    def members
+      @members
+    end
+
+
+    # @return [Pingram::SenderApi]
+    def sender
+      @sender
+    end
+
+
+    # @return [Pingram::TemplatesApi]
+    def templates
+      @templates
+    end
+
+
+    # @return [Pingram::TypesApi]
+    def types
+      @types
+    end
+
+
+    # @return [Pingram::UserApi]
+    def user
+      @user
+    end
+
+
+    # @return [Pingram::UsersApi]
+    def users
+      @users
+    end
+
+
+
+    # Send a notification. Delegates to DefaultApi#call_send (Ruby renames +send+ to +call_send+).
+    # @param body [Object] Request body (e.g. Pingram::SenderPostBody or Hash)
+    # @return [Object] Response (e.g. Pingram::SenderPostResponse)
+    def send(body)
+      @default_api.call_send(body)
+    end
+
+  end
+end

data/lib/pingram/configuration.rb

@@ -0,0 +1,330 @@
+=begin
+#NotificationAPI
+
+#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
+
+module Pingram
+  class Configuration
+    # Defines url scheme
+    attr_accessor :scheme
+
+    # Defines url host
+    attr_accessor :host
+
+    # Defines url base path
+    attr_accessor :base_path
+
+    # Define server configuration index
+    attr_accessor :server_index
+
+    # Define server operation configuration index
+    attr_accessor :server_operation_index
+
+    # Default server variables
+    attr_accessor :server_variables
+
+    # Default server operation variables
+    attr_accessor :server_operation_variables
+
+    # Defines API keys used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: parameter value (API key)
+    #
+    # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
+    #   config.api_key['api_key'] = 'xxx'
+    attr_accessor :api_key
+
+    # Defines API key prefixes used with API Key authentications.
+    #
+    # @return [Hash] key: parameter name, value: API key prefix
+    #
+    # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
+    #   config.api_key_prefix['api_key'] = 'Token'
+    attr_accessor :api_key_prefix
+
+    # Defines the username used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :username
+
+    # Defines the password used with HTTP basic authentication.
+    #
+    # @return [String]
+    attr_accessor :password
+
+    # Defines the access token (Bearer) used with OAuth2.
+    attr_accessor :access_token
+
+    # Defines a Proc used to fetch or refresh access tokens (Bearer) used with OAuth2.
+    # Overrides the access_token if set
+    # @return [Proc]
+    attr_accessor :access_token_getter
+
+    # Set this to return data as binary instead of downloading a temp file. When enabled (set to true)
+    # HTTP responses with return type `File` will be returned as a stream of binary data.
+    # Default to false.
+    attr_accessor :return_binary_data
+
+    # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
+    # details will be logged with `logger.debug` (see the `logger` attribute).
+    # Default to false.
+    #
+    # @return [true, false]
+    attr_accessor :debugging
+
+    # Set this to ignore operation servers for the API client. This is useful when you need to
+    # send requests to a different server than the one specified in the OpenAPI document.
+    # Will default to the base url defined in the spec but can be overridden by setting
+    # `scheme`, `host`, `base_path` directly.
+    # Default to false.
+    # @return [true, false]
+    attr_accessor :ignore_operation_servers
+
+    # Defines the logger used for debugging.
+    # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
+    #
+    # @return [#debug]
+    attr_accessor :logger
+
+    # Defines the temporary folder to store downloaded files
+    # (for API endpoints that have file response).
+    # Default to use `Tempfile`.
+    #
+    # @return [String]
+    attr_accessor :temp_folder_path
+
+    # The time limit for HTTP request in seconds.
+    # Default to 0 (never times out).
+    attr_accessor :timeout
+
+    # Set this to false to skip client side validation in the operation.
+    # Default to true.
+    # @return [true, false]
+    attr_accessor :client_side_validation
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL certificate when calling API from https server.
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl
+
+    ### TLS/SSL setting
+    # Set this to false to skip verifying SSL host name
+    # Default to true.
+    #
+    # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
+    #
+    # @return [true, false]
+    attr_accessor :verify_ssl_host
+
+    ### TLS/SSL setting
+    # Set this to customize the certificate file to verify the peer.
+    #
+    # @return [String] the path to the certificate file
+    #
+    # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
+    # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
+    attr_accessor :ssl_ca_cert
+
+    ### TLS/SSL setting
+    # Client certificate file (for client certificate)
+    attr_accessor :cert_file
+
+    ### TLS/SSL setting
+    # Client private key file (for client certificate)
+    attr_accessor :key_file
+
+    # Set this to customize parameters encoding of array parameter with multi collectionFormat.
+    # Default to nil.
+    #
+    # @see The params_encoding option of Ethon. Related source code:
+    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
+    attr_accessor :params_encoding
+
+
+    attr_accessor :inject_format
+
+    attr_accessor :force_ending_format
+
+    def initialize
+      @scheme = 'https'
+      @host = 'api.notificationapi.com'
+      @base_path = ''
+      @server_index = nil
+      @server_operation_index = {}
+      @server_variables = {}
+      @server_operation_variables = {}
+      @api_key = {}
+      @api_key_prefix = {}
+      @client_side_validation = true
+      @verify_ssl = true
+      @verify_ssl_host = true
+      @cert_file = nil
+      @key_file = nil
+      @timeout = 0
+      @params_encoding = nil
+      @debugging = false
+      @ignore_operation_servers = false
+      @inject_format = false
+      @force_ending_format = false
+      @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
+
+      yield(self) if block_given?
+    end
+
+    # The default Configuration object.
+    def self.default
+      @@default ||= Configuration.new
+    end
+
+    def configure
+      yield(self) if block_given?
+    end
+
+    def scheme=(scheme)
+      # remove :// from scheme
+      @scheme = scheme.sub(/:\/\//, '')
+    end
+
+    def host=(host)
+      # remove http(s):// and anything after a slash
+      @host = host.sub(/https?:\/\//, '').split('/').first
+    end
+
+    def base_path=(base_path)
+      # Add leading and trailing slashes to base_path
+      @base_path = "/#{base_path}".gsub(/\/+/, '/')
+      @base_path = '' if @base_path == '/'
+    end
+
+    # Returns base URL for specified operation based on server settings
+    def base_url(operation = nil)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if ignore_operation_servers
+      if operation_server_settings.key?(operation) then
+        index = server_operation_index.fetch(operation, server_index)
+        server_url(index.nil? ? 0 : index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
+      else
+        server_index.nil? ? "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') : server_url(server_index, server_variables, nil)
+      end
+    end
+
+    # Gets API key (with prefix if set).
+    # @param [String] param_name the parameter name of API key auth
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
+      if @api_key_prefix[param_name]
+        "#{@api_key_prefix[param_name]} #{key}"
+      else
+        key
+      end
+    end
+
+    # Gets access_token using access_token_getter or uses the static access_token
+    def access_token_with_refresh
+      return access_token if access_token_getter.nil?
+      access_token_getter.call
+    end
+
+    # Gets Basic Auth token string
+    def basic_auth_token
+      'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
+    end
+
+    # Returns Auth Settings hash for api client.
+    def auth_settings
+      {
+        'apiKey' =>
+          {
+            type: 'bearer',
+            in: 'header',
+            format: 'JWT',
+            key: 'Authorization',
+            value: "Bearer #{access_token_with_refresh}"
+          },
+        'clientCredentials' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
+        'endUser' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
+        'endUserHashed' =>
+          {
+            type: 'basic',
+            in: 'header',
+            key: 'Authorization',
+            value: basic_auth_token
+          },
+      }
+    end
+
+    # Returns an array of Server setting
+    def server_settings
+      [
+        {
+          url: "https://api.notificationapi.com",
+          description: "Production",
+        }
+      ]
+    end
+
+    def operation_server_settings
+      {
+      }
+    end
+
+    # Returns URL based on server settings
+    #
+    # @param index array index of the server settings
+    # @param variables hash of variable and the corresponding value
+    def server_url(index, variables = {}, servers = nil)
+      servers = server_settings if servers == nil
+
+      # check array index out of bound
+      if (index.nil? || index < 0 || index >= servers.size)
+        fail ArgumentError, "Invalid index #{index} when selecting the server. Must not be nil and must be less than #{servers.size}"
+      end
+
+      server = servers[index]
+      url = server[:url]
+
+      return url unless server.key? :variables
+
+      # go through variable and assign a value
+      server[:variables].each do |name, variable|
+        if variables.key?(name)
+          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
+            url.gsub! "{" + name.to_s + "}", variables[name]
+          else
+            fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
+          end
+        else
+          # use default value
+          url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
+        end
+      end
+
+      url
+    end
+
+
+  end
+end