pingram 1.0.31 → 1.0.32

data/lib/pingram/api/library_api.rb

@@ -0,0 +1,161 @@
+=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 LibraryApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+    # @param use_case [String] Library use-case
+    # @param create_library_request [CreateLibraryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateLibraryResponse]
+    def library_create(use_case, create_library_request, opts = {})
+      data, _status_code, _headers = library_create_with_http_info(use_case, create_library_request, opts)
+      data
+    end
+
+    # Create an upload slot in the account library. PUT the file to the returned uploadUrl with the same Content-Type, then use the returned url in emails and the editor.
+    # @param use_case [String] Library use-case
+    # @param create_library_request [CreateLibraryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateLibraryResponse, Integer, Hash)>] CreateLibraryResponse data, response status code and response headers
+    def library_create_with_http_info(use_case, create_library_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LibraryApi.library_create ...'
+      end
+      # verify the required parameter 'use_case' is set
+      if @api_client.config.client_side_validation && use_case.nil?
+        fail ArgumentError, "Missing the required parameter 'use_case' when calling LibraryApi.library_create"
+      end
+      # verify the required parameter 'create_library_request' is set
+      if @api_client.config.client_side_validation && create_library_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_library_request' when calling LibraryApi.library_create"
+      end
+      # resource path
+      local_var_path = '/library/{useCase}'.sub('{' + 'useCase' + '}', CGI.escape(use_case.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']
+      # 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(create_library_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateLibraryResponse'
+
+      # 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 => :"LibraryApi.library_create",
+        :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: LibraryApi#library_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List files in the account library for a use-case, newest first. Paginate with limit (default 50, max 100) and nextToken.
+    # @param use_case [String] Library use-case
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Max items to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [ListLibraryResponse]
+    def library_list(use_case, opts = {})
+      data, _status_code, _headers = library_list_with_http_info(use_case, opts)
+      data
+    end
+
+    # List files in the account library for a use-case, newest first. Paginate with limit (default 50, max 100) and nextToken.
+    # @param use_case [String] Library use-case
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Max items to return (default 50)
+    # @option opts [String] :next_token Pagination token
+    # @return [Array<(ListLibraryResponse, Integer, Hash)>] ListLibraryResponse data, response status code and response headers
+    def library_list_with_http_info(use_case, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LibraryApi.library_list ...'
+      end
+      # verify the required parameter 'use_case' is set
+      if @api_client.config.client_side_validation && use_case.nil?
+        fail ArgumentError, "Missing the required parameter 'use_case' when calling LibraryApi.library_list"
+      end
+      # resource path
+      local_var_path = '/library/{useCase}'.sub('{' + 'useCase' + '}', CGI.escape(use_case.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?
+
+      # 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] || 'ListLibraryResponse'
+
+      # 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 => :"LibraryApi.library_list",
+        :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: LibraryApi#library_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

data/lib/pingram/client_wrapper.rb

@@ -14,6 +14,8 @@ require_relative 'api/accounts_api'
 
 require_relative 'api/addresses_api'
 
+require_relative 'api/broadcasts_api'
+
 require_relative 'api/components_api'
 
 require_relative 'api/default_api'
@@ -32,6 +34,8 @@ require_relative 'api/insights_api'
 
 require_relative 'api/keys_api'
 
+require_relative 'api/library_api'
+
 require_relative 'api/logs_api'
 
 require_relative 'api/members_api'
@@ -92,6 +96,8 @@ module Pingram
 
       @addresses = Pingram::AddressesApi.new(@api_client)
 
+      @broadcasts = Pingram::BroadcastsApi.new(@api_client)
+
       @components = Pingram::ComponentsApi.new(@api_client)
 
       @default_api = Pingram::DefaultApi.new(@api_client)
@@ -110,6 +116,8 @@ module Pingram
 
       @keys = Pingram::KeysApi.new(@api_client)
 
+      @library = Pingram::LibraryApi.new(@api_client)
+
       @logs = Pingram::LogsApi.new(@api_client)
 
       @members = Pingram::MembersApi.new(@api_client)
@@ -157,6 +165,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::BroadcastsApi]
+    def broadcasts
+      @broadcasts
+    end
+
+
     # @return [Pingram::ComponentsApi]
     def components
       @components
@@ -211,6 +225,12 @@ module Pingram
     end
 
 
+    # @return [Pingram::LibraryApi]
+    def library
+      @library
+    end
+
+
     # @return [Pingram::LogsApi]
     def logs
       @logs

data/lib/pingram/models/broadcast_metrics_response.rb

@@ -0,0 +1,480 @@
+=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
+  # Live send metrics. Counters are flattened at the top level.
+  class BroadcastMetricsResponse < ApiModelBase
+    attr_accessor :total
+
+    attr_accessor :sent
+
+    attr_accessor :delivered
+
+    attr_accessor :opened
+
+    attr_accessor :clicked
+
+    attr_accessor :bounced
+
+    attr_accessor :complained
+
+    attr_accessor :unsubscribed
+
+    attr_accessor :skipped
+
+    attr_accessor :failed
+
+    # Lifecycle status of an email broadcast.
+    attr_accessor :status
+
+    attr_accessor :paused_reason
+
+    attr_accessor :schedule_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
+      {
+        :'total' => :'total',
+        :'sent' => :'sent',
+        :'delivered' => :'delivered',
+        :'opened' => :'opened',
+        :'clicked' => :'clicked',
+        :'bounced' => :'bounced',
+        :'complained' => :'complained',
+        :'unsubscribed' => :'unsubscribed',
+        :'skipped' => :'skipped',
+        :'failed' => :'failed',
+        :'status' => :'status',
+        :'paused_reason' => :'pausedReason',
+        :'schedule_at' => :'scheduleAt'
+      }
+    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
+      {
+        :'total' => :'Float',
+        :'sent' => :'Float',
+        :'delivered' => :'Float',
+        :'opened' => :'Float',
+        :'clicked' => :'Float',
+        :'bounced' => :'Float',
+        :'complained' => :'Float',
+        :'unsubscribed' => :'Float',
+        :'skipped' => :'Float',
+        :'failed' => :'Float',
+        :'status' => :'String',
+        :'paused_reason' => :'String',
+        :'schedule_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::BroadcastMetricsResponse` 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::BroadcastMetricsResponse`. 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?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      end
+
+      if attributes.key?(:'sent')
+        self.sent = attributes[:'sent']
+      else
+        self.sent = nil
+      end
+
+      if attributes.key?(:'delivered')
+        self.delivered = attributes[:'delivered']
+      else
+        self.delivered = nil
+      end
+
+      if attributes.key?(:'opened')
+        self.opened = attributes[:'opened']
+      else
+        self.opened = nil
+      end
+
+      if attributes.key?(:'clicked')
+        self.clicked = attributes[:'clicked']
+      else
+        self.clicked = nil
+      end
+
+      if attributes.key?(:'bounced')
+        self.bounced = attributes[:'bounced']
+      else
+        self.bounced = nil
+      end
+
+      if attributes.key?(:'complained')
+        self.complained = attributes[:'complained']
+      else
+        self.complained = nil
+      end
+
+      if attributes.key?(:'unsubscribed')
+        self.unsubscribed = attributes[:'unsubscribed']
+      else
+        self.unsubscribed = nil
+      end
+
+      if attributes.key?(:'skipped')
+        self.skipped = attributes[:'skipped']
+      else
+        self.skipped = nil
+      end
+
+      if attributes.key?(:'failed')
+        self.failed = attributes[:'failed']
+      else
+        self.failed = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'paused_reason')
+        self.paused_reason = attributes[:'paused_reason']
+      end
+
+      if attributes.key?(:'schedule_at')
+        self.schedule_at = attributes[:'schedule_at']
+      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 @total.nil?
+        invalid_properties.push('invalid value for "total", total cannot be nil.')
+      end
+
+      if @sent.nil?
+        invalid_properties.push('invalid value for "sent", sent cannot be nil.')
+      end
+
+      if @delivered.nil?
+        invalid_properties.push('invalid value for "delivered", delivered cannot be nil.')
+      end
+
+      if @opened.nil?
+        invalid_properties.push('invalid value for "opened", opened cannot be nil.')
+      end
+
+      if @clicked.nil?
+        invalid_properties.push('invalid value for "clicked", clicked cannot be nil.')
+      end
+
+      if @bounced.nil?
+        invalid_properties.push('invalid value for "bounced", bounced cannot be nil.')
+      end
+
+      if @complained.nil?
+        invalid_properties.push('invalid value for "complained", complained cannot be nil.')
+      end
+
+      if @unsubscribed.nil?
+        invalid_properties.push('invalid value for "unsubscribed", unsubscribed cannot be nil.')
+      end
+
+      if @skipped.nil?
+        invalid_properties.push('invalid value for "skipped", skipped cannot be nil.')
+      end
+
+      if @failed.nil?
+        invalid_properties.push('invalid value for "failed", failed cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status 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 @total.nil?
+      return false if @sent.nil?
+      return false if @delivered.nil?
+      return false if @opened.nil?
+      return false if @clicked.nil?
+      return false if @bounced.nil?
+      return false if @complained.nil?
+      return false if @unsubscribed.nil?
+      return false if @skipped.nil?
+      return false if @failed.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["draft", "scheduled", "sending", "sent", "paused", "canceled"])
+      return false unless status_validator.valid?(@status)
+      paused_reason_validator = EnumAttributeValidator.new('String', ["PAUSED_BY_USER", "REPUTATION_GUARD", "PLAN_EXCEEDED", "PENDING_VERIFICATION", "AUDIENCE_LIMITS_EXCEEDED", "UNVERIFIED_DOMAIN", "SPAM_CONTENT"])
+      return false unless paused_reason_validator.valid?(@paused_reason)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total Value to be assigned
+    def total=(total)
+      if total.nil?
+        fail ArgumentError, 'total cannot be nil'
+      end
+
+      @total = total
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sent Value to be assigned
+    def sent=(sent)
+      if sent.nil?
+        fail ArgumentError, 'sent cannot be nil'
+      end
+
+      @sent = sent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] delivered Value to be assigned
+    def delivered=(delivered)
+      if delivered.nil?
+        fail ArgumentError, 'delivered cannot be nil'
+      end
+
+      @delivered = delivered
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] opened Value to be assigned
+    def opened=(opened)
+      if opened.nil?
+        fail ArgumentError, 'opened cannot be nil'
+      end
+
+      @opened = opened
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] clicked Value to be assigned
+    def clicked=(clicked)
+      if clicked.nil?
+        fail ArgumentError, 'clicked cannot be nil'
+      end
+
+      @clicked = clicked
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] bounced Value to be assigned
+    def bounced=(bounced)
+      if bounced.nil?
+        fail ArgumentError, 'bounced cannot be nil'
+      end
+
+      @bounced = bounced
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] complained Value to be assigned
+    def complained=(complained)
+      if complained.nil?
+        fail ArgumentError, 'complained cannot be nil'
+      end
+
+      @complained = complained
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unsubscribed Value to be assigned
+    def unsubscribed=(unsubscribed)
+      if unsubscribed.nil?
+        fail ArgumentError, 'unsubscribed cannot be nil'
+      end
+
+      @unsubscribed = unsubscribed
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] skipped Value to be assigned
+    def skipped=(skipped)
+      if skipped.nil?
+        fail ArgumentError, 'skipped cannot be nil'
+      end
+
+      @skipped = skipped
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] failed Value to be assigned
+    def failed=(failed)
+      if failed.nil?
+        fail ArgumentError, 'failed cannot be nil'
+      end
+
+      @failed = failed
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["draft", "scheduled", "sending", "sent", "paused", "canceled"])
+      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 checking allowed values (enum).
+    # @param [Object] paused_reason Object to be assigned
+    def paused_reason=(paused_reason)
+      validator = EnumAttributeValidator.new('String', ["PAUSED_BY_USER", "REPUTATION_GUARD", "PLAN_EXCEEDED", "PENDING_VERIFICATION", "AUDIENCE_LIMITS_EXCEEDED", "UNVERIFIED_DOMAIN", "SPAM_CONTENT"])
+      unless validator.valid?(paused_reason)
+        fail ArgumentError, "invalid value for \"paused_reason\", must be one of #{validator.allowable_values}."
+      end
+      @paused_reason = paused_reason
+    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 &&
+          total == o.total &&
+          sent == o.sent &&
+          delivered == o.delivered &&
+          opened == o.opened &&
+          clicked == o.clicked &&
+          bounced == o.bounced &&
+          complained == o.complained &&
+          unsubscribed == o.unsubscribed &&
+          skipped == o.skipped &&
+          failed == o.failed &&
+          status == o.status &&
+          paused_reason == o.paused_reason &&
+          schedule_at == o.schedule_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
+      [total, sent, delivered, opened, clicked, bounced, complained, unsubscribed, skipped, failed, status, paused_reason, schedule_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