pingram 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c951aa3cd438ee832684fd8f74b0f390ec1e7f53cc4e70f858227c2cbbafe63
-  data.tar.gz: bf75873543f652a29338ab32953f3634bd43ee37f1678ef481198967a68415ef
+  metadata.gz: 42272e0e1ca8a80a084cc5f4f089689bb2444fa67cd0bf99fa1c9abc6d7548ee
+  data.tar.gz: 3b0e60679b46b106fa7f06492cc39aa46408923e31112180fdec4b4cb3fd178e
 SHA512:
-  metadata.gz: 791ddbbde1279750fb20c0cac0619a65d07cbee88f419ac6d8def2f85eb856e09ac4f693646ae28b13d482740494d3d43a69c758b3b0bbbf0fa0796db1eaf5cd
-  data.tar.gz: af6dbb081bac9426f3dfdb67a613b981269fc9ffca2497b14f0673337a7729d3695e4237bbb50a5358de7ef488726ba6057aff61f89d375a1e726799f7e5580f
+  metadata.gz: adb92ebea1d3ba20b16bf5e0f8bbac8aeacc0918564f7b87010afb5d02338e5079fae712a360c29deb8a7be88501f12ed34a27be9e66266457d6c7b2327b5041
+  data.tar.gz: '082590c797d513da21b88d422f5c7f165f12a9ab8c9814222c3f4bfa16e0bcaf81952b127160bc08b531df296b9fae807624409a2821ea77ae65f620b09aef6a'

data/README.md

@@ -1,11 +1,11 @@
-# pingram
+# Pingram Ruby SDK
 
 Official Ruby SDK for Pingram. Send notifications via Email, SMS, Push, In-App, and more from your server-side Ruby code.
 
 ## Requirements
 
 - Ruby 2.4+
-- Dependencies: see the gem for details (e.g. faraday).
+- Dependencies: `faraday` (or configured HTTP library); see generated gem for details.
 
 ## Installation
 
@@ -37,7 +37,7 @@ body = Pingram::SenderPostBody.new(
 )
 response = client.send(body)
 
-# Or use namespaced APIs: client.default_api, client.account, client.sender, ...
+# Or use namespaced APIs: client.default_api, client.sender_api, client.account_api, ...
 ```
 
 You can override the base URL: `Pingram::Client.new(api_key: '...', base_url: 'https://api.example.com')`.
@@ -45,9 +45,21 @@ You can override the base URL: `Pingram::Client.new(api_key: '...', base_url: 'h
 ## What can I call?
 
 - **`client.send(body)`** – send a notification (high-level).
-- **`client.domains`**, **`client.account`**, **`client.sender`**, etc. – low-level API objects with methods like `domains_list_domains`, `account_get_account_details`, `sender_test_email`, and so on.
+- **`client.domains`**, **`client.account`**, **`client.sender`**, etc. – low-level API objects. Each has methods like `domains_list_domains`, `account_get_account_details`, `sender_test_email`, and so on.
 
-For the full list of methods, see **API_REFERENCE.md** in the gem or [documentation](https://docs.pingram.io).
+For the full list of methods on each API, see **[API_REFERENCE.md](API_REFERENCE.md)** (in this directory). It is generated from the OpenAPI spec when you run codegen.
+
+## Generating the SDK
+
+From the `serverless/` directory (or repo root with correct paths):
+
+```bash
+npm run codegen:sdk
+```
+
+This generates the OpenAPI spec and all SDKs, including Ruby, into `sdks/ruby/generated/`.
+
+**Adding new endpoints:** You do **not** need to change the Ruby wrapper or generator. Update the OpenAPI spec (new paths and tags), then run `npm run codegen:sdk`. The wrapper and `API_REFERENCE.md` are derived from the spec (tags) and generated API files, so new APIs and methods appear automatically.
 
 ## Links
 

data/lib/pingram/api/templates_api.rb

@@ -168,6 +168,79 @@ module Pingram
       return data, status_code, headers
     end
 
+    # Get a single template by ID
+    # @param notification_id [String] Notification ID
+    # @param channel [String] Channel type
+    # @param template_id [String] Template ID
+    # @param [Hash] opts the optional parameters
+    # @return [GetTemplatesResponse]
+    def templates_get_template(notification_id, channel, template_id, opts = {})
+      data, _status_code, _headers = templates_get_template_with_http_info(notification_id, channel, template_id, opts)
+      data
+    end
+
+    # Get a single template by ID
+    # @param notification_id [String] Notification ID
+    # @param channel [String] Channel type
+    # @param template_id [String] Template ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetTemplatesResponse, Integer, Hash)>] GetTemplatesResponse data, response status code and response headers
+    def templates_get_template_with_http_info(notification_id, channel, template_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TemplatesApi.templates_get_template ...'
+      end
+      # verify the required parameter 'notification_id' is set
+      if @api_client.config.client_side_validation && notification_id.nil?
+        fail ArgumentError, "Missing the required parameter 'notification_id' when calling TemplatesApi.templates_get_template"
+      end
+      # verify the required parameter 'channel' is set
+      if @api_client.config.client_side_validation && channel.nil?
+        fail ArgumentError, "Missing the required parameter 'channel' when calling TemplatesApi.templates_get_template"
+      end
+      # verify the required parameter 'template_id' is set
+      if @api_client.config.client_side_validation && template_id.nil?
+        fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.templates_get_template"
+      end
+      # resource path
+      local_var_path = '/notifications/{notificationId}/{channel}/templates/{templateId}'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s)).sub('{' + 'channel' + '}', CGI.escape(channel.to_s)).sub('{' + 'templateId' + '}', CGI.escape(template_id.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] || 'GetTemplatesResponse'
+
+      # 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 => :"TemplatesApi.templates_get_template",
+        :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: TemplatesApi#templates_get_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Initiate AI-powered template migration from complex to simple HTML
     # @param notification_id [String] Notification ID
     # @param channel [String] Channel type
@@ -241,24 +314,22 @@ module Pingram
       return data, status_code, headers
     end
 
-    # Get template(s) for a notification
+    # List all templates for a notification and channel
     # @param notification_id [String] Notification ID
     # @param channel [String] Channel type
-    # @param template_id [String] Template ID (optional for listing all)
     # @param [Hash] opts the optional parameters
-    # @return [GetTemplatesResponse]
-    def templates_list_templates(notification_id, channel, template_id, opts = {})
-      data, _status_code, _headers = templates_list_templates_with_http_info(notification_id, channel, template_id, opts)
+    # @return [Array<GetTemplatesListResponseInner>]
+    def templates_list_templates(notification_id, channel, opts = {})
+      data, _status_code, _headers = templates_list_templates_with_http_info(notification_id, channel, opts)
       data
     end
 
-    # Get template(s) for a notification
+    # List all templates for a notification and channel
     # @param notification_id [String] Notification ID
     # @param channel [String] Channel type
-    # @param template_id [String] Template ID (optional for listing all)
     # @param [Hash] opts the optional parameters
-    # @return [Array<(GetTemplatesResponse, Integer, Hash)>] GetTemplatesResponse data, response status code and response headers
-    def templates_list_templates_with_http_info(notification_id, channel, template_id, opts = {})
+    # @return [Array<(Array<GetTemplatesListResponseInner>, Integer, Hash)>] Array<GetTemplatesListResponseInner> data, response status code and response headers
+    def templates_list_templates_with_http_info(notification_id, channel, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TemplatesApi.templates_list_templates ...'
       end
@@ -270,12 +341,8 @@ module Pingram
       if @api_client.config.client_side_validation && channel.nil?
         fail ArgumentError, "Missing the required parameter 'channel' when calling TemplatesApi.templates_list_templates"
       end
-      # verify the required parameter 'template_id' is set
-      if @api_client.config.client_side_validation && template_id.nil?
-        fail ArgumentError, "Missing the required parameter 'template_id' when calling TemplatesApi.templates_list_templates"
-      end
       # resource path
-      local_var_path = '/notifications/{notificationId}/{channel}/templates/{templateId}'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s)).sub('{' + 'channel' + '}', CGI.escape(channel.to_s)).sub('{' + 'templateId' + '}', CGI.escape(template_id.to_s))
+      local_var_path = '/notifications/{notificationId}/{channel}/templates'.sub('{' + 'notificationId' + '}', CGI.escape(notification_id.to_s)).sub('{' + 'channel' + '}', CGI.escape(channel.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -292,7 +359,7 @@ module Pingram
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'GetTemplatesResponse'
+      return_type = opts[:debug_return_type] || 'Array<GetTemplatesListResponseInner>'
 
       # auth_names (apiKey last so Bearer wins when multiple schemes set Authorization)
       auth_names = opts[:debug_auth_names] || ['endUserHashed', 'endUser', 'clientCredentials', 'apiKey']

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

data/lib/pingram/models/get_templates_list_response_inner.rb

@@ -0,0 +1,108 @@
+=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
+
+require 'date'
+require 'time'
+
+module Pingram
+  # Union of all channel-specific template types. Used for API responses that can return any template type.
+  module GetTemplatesListResponseInner
+    class << self
+      # List of class defined in anyOf (OpenAPI v3)
+      def openapi_any_of
+        [
+          :'GetTemplatesListResponseInnerAnyOf',
+          :'GetTemplatesListResponseInnerAnyOf1',
+          :'GetTemplatesListResponseInnerAnyOf2',
+          :'GetTemplatesListResponseInnerAnyOf3',
+          :'GetTemplatesListResponseInnerAnyOf4',
+          :'GetTemplatesListResponseInnerAnyOf5'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of anyOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of anyOf items and attempt to identify the appropriate one.
+        # Note:
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_any_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_any_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Pingram.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_any_of) # nested anyOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end