pingram 1.0.6 → 1.0.9

data/lib/pingram/models/send_email_request.rb

@@ -0,0 +1,335 @@
+=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
+  # Request body for `POST /email` (send email without a template).
+  class SendEmailRequest < ApiModelBase
+    # The notification type to send.
+    attr_accessor :type
+
+    # The email address of the recipient.
+    attr_accessor :to
+
+    # The subject of the email.
+    attr_accessor :subject
+
+    # The HTML body of the email.
+    attr_accessor :html
+
+    # The display name of the sender.
+    attr_accessor :from_name
+
+    # The email address of the sender.
+    attr_accessor :from_address
+
+    # The preview text of the email.
+    attr_accessor :preview_text
+
+    # The reply-to addresses of the email.
+    attr_accessor :reply_to_addresses
+
+    # The CC addresses of the email.
+    attr_accessor :cc_addresses
+
+    # The BCC addresses of the email.
+    attr_accessor :bcc_addresses
+
+    # The attachments of the email.
+    attr_accessor :attachments
+
+    # The ISO 8601 datetime to schedule the email.
+    attr_accessor :schedule
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'to' => :'to',
+        :'subject' => :'subject',
+        :'html' => :'html',
+        :'from_name' => :'fromName',
+        :'from_address' => :'fromAddress',
+        :'preview_text' => :'previewText',
+        :'reply_to_addresses' => :'replyToAddresses',
+        :'cc_addresses' => :'ccAddresses',
+        :'bcc_addresses' => :'bccAddresses',
+        :'attachments' => :'attachments',
+        :'schedule' => :'schedule'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'to' => :'String',
+        :'subject' => :'String',
+        :'html' => :'String',
+        :'from_name' => :'String',
+        :'from_address' => :'String',
+        :'preview_text' => :'String',
+        :'reply_to_addresses' => :'Array<String>',
+        :'cc_addresses' => :'Array<String>',
+        :'bcc_addresses' => :'Array<String>',
+        :'attachments' => :'Array<SendEmailRequestAttachmentsInner>',
+        :'schedule' => :'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::SendEmailRequest` 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::SendEmailRequest`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'subject')
+        self.subject = attributes[:'subject']
+      else
+        self.subject = nil
+      end
+
+      if attributes.key?(:'html')
+        self.html = attributes[:'html']
+      else
+        self.html = nil
+      end
+
+      if attributes.key?(:'from_name')
+        self.from_name = attributes[:'from_name']
+      end
+
+      if attributes.key?(:'from_address')
+        self.from_address = attributes[:'from_address']
+      end
+
+      if attributes.key?(:'preview_text')
+        self.preview_text = attributes[:'preview_text']
+      end
+
+      if attributes.key?(:'reply_to_addresses')
+        if (value = attributes[:'reply_to_addresses']).is_a?(Array)
+          self.reply_to_addresses = value
+        end
+      end
+
+      if attributes.key?(:'cc_addresses')
+        if (value = attributes[:'cc_addresses']).is_a?(Array)
+          self.cc_addresses = value
+        end
+      end
+
+      if attributes.key?(:'bcc_addresses')
+        if (value = attributes[:'bcc_addresses']).is_a?(Array)
+          self.bcc_addresses = value
+        end
+      end
+
+      if attributes.key?(:'attachments')
+        if (value = attributes[:'attachments']).is_a?(Array)
+          self.attachments = value
+        end
+      end
+
+      if attributes.key?(:'schedule')
+        self.schedule = attributes[:'schedule']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to cannot be nil.')
+      end
+
+      if @subject.nil?
+        invalid_properties.push('invalid value for "subject", subject cannot be nil.')
+      end
+
+      if @html.nil?
+        invalid_properties.push('invalid value for "html", html 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 @type.nil?
+      return false if @to.nil?
+      return false if @subject.nil?
+      return false if @html.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      @to = to
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subject Value to be assigned
+    def subject=(subject)
+      if subject.nil?
+        fail ArgumentError, 'subject cannot be nil'
+      end
+
+      @subject = subject
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] html Value to be assigned
+    def html=(html)
+      if html.nil?
+        fail ArgumentError, 'html cannot be nil'
+      end
+
+      @html = html
+    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 &&
+          type == o.type &&
+          to == o.to &&
+          subject == o.subject &&
+          html == o.html &&
+          from_name == o.from_name &&
+          from_address == o.from_address &&
+          preview_text == o.preview_text &&
+          reply_to_addresses == o.reply_to_addresses &&
+          cc_addresses == o.cc_addresses &&
+          bcc_addresses == o.bcc_addresses &&
+          attachments == o.attachments &&
+          schedule == o.schedule
+    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
+      [type, to, subject, html, from_name, from_address, preview_text, reply_to_addresses, cc_addresses, bcc_addresses, attachments, schedule].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

data/lib/pingram/models/{sender_post_body_options_email_attachments_inner_any_of1.rb → send_email_request_attachments_inner.rb}

@@ -14,19 +14,16 @@ require 'date'
 require 'time'
 
 module Pingram
-  class SenderPostBodyOptionsEmailAttachmentsInnerAnyOf1 < ApiModelBase
+  class SendEmailRequestAttachmentsInner < ApiModelBase
     attr_accessor :filename
 
-    attr_accessor :content
-
-    attr_accessor :content_type
+    attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'filename' => :'filename',
-        :'content' => :'content',
-        :'content_type' => :'contentType'
+        :'url' => :'url'
       }
     end
 
@@ -44,8 +41,7 @@ module Pingram
     def self.openapi_types
       {
         :'filename' => :'String',
-        :'content' => :'String',
-        :'content_type' => :'String'
+        :'url' => :'String'
       }
     end
 
@@ -59,14 +55,14 @@ module Pingram
     # @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::SenderPostBodyOptionsEmailAttachmentsInnerAnyOf1` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Pingram::SendEmailRequestAttachmentsInner` 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::SenderPostBodyOptionsEmailAttachmentsInnerAnyOf1`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Pingram::SendEmailRequestAttachmentsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -77,14 +73,10 @@ module Pingram
         self.filename = nil
       end
 
-      if attributes.key?(:'content')
-        self.content = attributes[:'content']
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
       else
-        self.content = nil
-      end
-
-      if attributes.key?(:'content_type')
-        self.content_type = attributes[:'content_type']
+        self.url = nil
       end
     end
 
@@ -97,8 +89,8 @@ module Pingram
         invalid_properties.push('invalid value for "filename", filename cannot be nil.')
       end
 
-      if @content.nil?
-        invalid_properties.push('invalid value for "content", content cannot be nil.')
+      if @url.nil?
+        invalid_properties.push('invalid value for "url", url cannot be nil.')
       end
 
       invalid_properties
@@ -109,7 +101,7 @@ module Pingram
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if @filename.nil?
-      return false if @content.nil?
+      return false if @url.nil?
       true
     end
 
@@ -124,13 +116,13 @@ module Pingram
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] content Value to be assigned
-    def content=(content)
-      if content.nil?
-        fail ArgumentError, 'content cannot be nil'
+    # @param [Object] url Value to be assigned
+    def url=(url)
+      if url.nil?
+        fail ArgumentError, 'url cannot be nil'
       end
 
-      @content = content
+      @url = url
     end
 
     # Checks equality by comparing each attribute.
@@ -139,8 +131,7 @@ module Pingram
       return true if self.equal?(o)
       self.class == o.class &&
           filename == o.filename &&
-          content == o.content &&
-          content_type == o.content_type
+          url == o.url
     end
 
     # @see the `==` method
@@ -152,7 +143,7 @@ module Pingram
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [filename, content, content_type].hash
+      [filename, url].hash
     end
 
     # Builds the object from hash

data/lib/pingram/models/send_sms_request.rb

@@ -0,0 +1,249 @@
+=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
+  # Request body for `POST /sms` (send SMS without a template).
+  class SendSmsRequest < ApiModelBase
+    # The notification type to send.
+    attr_accessor :type
+
+    # The phone number of the recipient.
+    attr_accessor :to
+
+    # The message of the SMS notification.
+    attr_accessor :message
+
+    # The ISO 8601 datetime to schedule the SMS notification.
+    attr_accessor :schedule
+
+    # Override the sender phone number. Must be a verified number in your Telnyx account.
+    attr_accessor :from
+
+    attr_accessor :auto_reply
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'type' => :'type',
+        :'to' => :'to',
+        :'message' => :'message',
+        :'schedule' => :'schedule',
+        :'from' => :'from',
+        :'auto_reply' => :'autoReply'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'to' => :'String',
+        :'message' => :'String',
+        :'schedule' => :'String',
+        :'from' => :'String',
+        :'auto_reply' => :'SenderPostBodySmsAutoReply'
+      }
+    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::SendSmsRequest` 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::SendSmsRequest`. 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?(:'type')
+        self.type = attributes[:'type']
+      else
+        self.type = nil
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      else
+        self.to = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'schedule')
+        self.schedule = attributes[:'schedule']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'auto_reply')
+        self.auto_reply = attributes[:'auto_reply']
+      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 @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @to.nil?
+        invalid_properties.push('invalid value for "to", to 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 @type.nil?
+      return false if @to.nil?
+      return false if @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type Value to be assigned
+    def type=(type)
+      if type.nil?
+        fail ArgumentError, 'type cannot be nil'
+      end
+
+      @type = type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] to Value to be assigned
+    def to=(to)
+      if to.nil?
+        fail ArgumentError, 'to cannot be nil'
+      end
+
+      @to = to
+    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 &&
+          type == o.type &&
+          to == o.to &&
+          message == o.message &&
+          schedule == o.schedule &&
+          from == o.from &&
+          auto_reply == o.auto_reply
+    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
+      [type, to, message, schedule, from, auto_reply].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