pingram 0.1.4 → 0.1.5

data/lib/pingram/models/sender_post_body_call.rb

@@ -0,0 +1,166 @@
+=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
+  # Inline call content (message).
+  class SenderPostBodyCall < ApiModelBase
+    # Text to speak (TTS).
+    attr_accessor :message
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'message' => :'message'
+      }
+    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
+      {
+        :'message' => :'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::SenderPostBodyCall` 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::SenderPostBodyCall`. 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?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      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 @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 @message.nil?
+      true
+    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 &&
+          message == o.message
+    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
+      [message].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_email.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,15 +14,21 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Inline email content (subject, html). Use when not using templates.
   class SenderPostBodyEmail < ApiModelBase
+    # Email subject line.
     attr_accessor :subject
 
+    # HTML body content.
     attr_accessor :html
 
+    # Preview/snippet text shown in inbox.
     attr_accessor :preview_text
 
+    # Display name of sender.
     attr_accessor :sender_name
 
+    # Sender email address.
     attr_accessor :sender_email
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/sender_post_body_inapp.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Inline in-app content (title, url, image).
   class SenderPostBodyInapp < ApiModelBase
+    # Notification title.
     attr_accessor :title
 
+    # URL to open when clicked.
     attr_accessor :url
 
+    # Image URL.
     attr_accessor :image
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/sender_post_body_mobile_push.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Inline mobile push content (title, message).
   class SenderPostBodyMobilePush < ApiModelBase
+    # Notification title.
     attr_accessor :title
 
+    # Body text.
     attr_accessor :message
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/sender_post_body_options.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Per-channel overrides for send options (email, APN, FCM).
   class SenderPostBodyOptions < ApiModelBase
     attr_accessor :email
 

data/lib/pingram/models/sender_post_body_options_apn.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,19 +14,27 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Apple Push Notification (APN) overrides.
   class SenderPostBodyOptionsApn < ApiModelBase
+    # Seconds until the notification expires.
     attr_accessor :expiry
 
+    # Delivery priority (10 = immediate, 5 = power-saving).
     attr_accessor :priority
 
+    # Group notifications with the same ID (replaces previous).
     attr_accessor :collapse_id
 
+    # Thread identifier for grouping notifications.
     attr_accessor :thread_id
 
+    # Badge count on app icon.
     attr_accessor :badge
 
+    # Sound file name.
     attr_accessor :sound
 
+    # Silent background notification (no alert).
     attr_accessor :content_available
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/sender_post_body_options_email.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,19 +14,27 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Email-specific overrides.
   class SenderPostBodyOptionsEmail < ApiModelBase
+    # Reply-to addresses for the email.
     attr_accessor :reply_to_addresses
 
+    # CC recipients.
     attr_accessor :cc_addresses
 
+    # BCC recipients.
     attr_accessor :bcc_addresses
 
+    # Override sender email address.
     attr_accessor :from_address
 
+    # Override sender display name.
     attr_accessor :from_name
 
+    # File attachments (by URL or inline base64 content).
     attr_accessor :attachments
 
+    # Conditional expression for when to send (e.g. merge tag logic).
     attr_accessor :condition
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/sender_post_body_options_email_attachments_inner.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/sender_post_body_options_email_attachments_inner_any_of.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/sender_post_body_options_email_attachments_inner_any_of1.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/sender_post_body_options_fcm.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Firebase Cloud Messaging (FCM) overrides.
   class SenderPostBodyOptionsFcm < ApiModelBase
     attr_accessor :android
 

data/lib/pingram/models/sender_post_body_options_fcm_android.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,13 +14,18 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Android-specific FCM options.
   class SenderPostBodyOptionsFcmAndroid < ApiModelBase
+    # Collapse key for grouping messages.
     attr_accessor :collapse_key
 
+    # Delivery priority.
     attr_accessor :priority
 
+    # Time to live in seconds.
     attr_accessor :ttl
 
+    # Restrict delivery to a specific package.
     attr_accessor :restricted_package_name
 
     class EnumAttributeValidator

data/lib/pingram/models/sender_post_body_slack.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,27 +14,39 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Inline Slack content (text, blocks, etc.).
   class SenderPostBodySlack < ApiModelBase
+    # Fallback plain text (required when using blocks).
     attr_accessor :text
 
+    # Slack Block Kit blocks.
     attr_accessor :blocks
 
+    # Override bot username.
     attr_accessor :username
 
+    # Icon: emoji (e.g. \":smile:\") or URL. Default: bot's icon.
     attr_accessor :icon
 
+    # Parent message `ts` to post in a thread.
     attr_accessor :thread_ts
 
+    # When true with thread_ts, broadcasts reply to channel. Default: false.
     attr_accessor :reply_broadcast
 
+    # URL parsing: \"full\" (clickable links) or \"none\". Default: \"none\".
     attr_accessor :parse
 
+    # Convert channel and username refs to Slack links. Default: false.
     attr_accessor :link_names
 
+    # Enable Slack markup (*bold*, _italic_, `code`). Default: true.
     attr_accessor :mrkdwn
 
+    # Unfurl link previews. Default: true.
     attr_accessor :unfurl_links
 
+    # Unfurl media previews. Default: true.
     attr_accessor :unfurl_media
 
     attr_accessor :metadata

data/lib/pingram/models/sender_post_body_sms.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Inline SMS content (message, autoReply).
   class SenderPostBodySms < ApiModelBase
+    # SMS body text.
     attr_accessor :message
 
     attr_accessor :auto_reply

data/lib/pingram/models/sender_post_body_sms_auto_reply.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -15,6 +15,7 @@ require 'time'
 
 module Pingram
   class SenderPostBodySmsAutoReply < ApiModelBase
+    # Auto-reply message to send when user texts in.
     attr_accessor :message
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/sender_post_body_to.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,17 +14,24 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Recipient user. Provide `id`, `email`, or `number` to identify the user.
   class SenderPostBodyTo < ApiModelBase
+    # Unique user identifier. Required.
     attr_accessor :id
 
+    # User's email address for email notifications.
     attr_accessor :email
 
+    # User's phone number for SMS/call notifications.
     attr_accessor :number
 
+    # Mobile push tokens (FCM, APN) for push notifications.
     attr_accessor :push_tokens
 
+    # Web push subscription config from the browser.
     attr_accessor :web_push_tokens
 
+    # User's timezone (e.g. \"America/New_York\") for scheduling.
     attr_accessor :timezone
 
     # The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. \"test\" - Channel name with # prefix, e.g. \"#test\" - Channel ID, e.g. \"C1234567890\" - User ID for DM, e.g. \"U1234567890\" - Username with @ prefix, e.g. \"@test\"
@@ -32,10 +39,13 @@ module Pingram
 
     attr_accessor :slack_token
 
+    # Last activity timestamp. Updated automatically. Read-only.
     attr_accessor :last_seen_time
 
+    # Last update timestamp. Read-only.
     attr_accessor :updated_at
 
+    # Creation timestamp. Read-only.
     attr_accessor :created_at
 
     attr_accessor :email_suppression_status

data/lib/pingram/models/sender_post_body_user.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -15,16 +15,22 @@ require 'time'
 
 module Pingram
   class SenderPostBodyUser < ApiModelBase
+    # Unique user identifier. Required.
     attr_accessor :id
 
+    # User's email address for email notifications.
     attr_accessor :email
 
+    # User's phone number for SMS/call notifications.
     attr_accessor :number
 
+    # Mobile push tokens (FCM, APN) for push notifications.
     attr_accessor :push_tokens
 
+    # Web push subscription config from the browser.
     attr_accessor :web_push_tokens
 
+    # User's timezone (e.g. \"America/New_York\") for scheduling.
     attr_accessor :timezone
 
     # The destination channel of slack notifications sent to this user. Can be either of the following: - Channel name, e.g. \"test\" - Channel name with # prefix, e.g. \"#test\" - Channel ID, e.g. \"C1234567890\" - User ID for DM, e.g. \"U1234567890\" - Username with @ prefix, e.g. \"@test\"
@@ -32,10 +38,13 @@ module Pingram
 
     attr_accessor :slack_token
 
+    # Last activity timestamp. Updated automatically. Read-only.
     attr_accessor :last_seen_time
 
+    # Last update timestamp. Read-only.
     attr_accessor :updated_at
 
+    # Creation timestamp. Read-only.
     attr_accessor :created_at
 
     attr_accessor :email_suppression_status

data/lib/pingram/models/sender_post_body_web_push.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 
@@ -14,13 +14,18 @@ require 'date'
 require 'time'
 
 module Pingram
+  # Inline web push content (title, message, icon, url).
   class SenderPostBodyWebPush < ApiModelBase
+    # Notification title.
     attr_accessor :title
 
+    # Body text.
     attr_accessor :message
 
+    # Icon URL.
     attr_accessor :icon
 
+    # URL to open when clicked.
     attr_accessor :url
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/pingram/models/sender_post_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/set_default_template_request.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/slack_interactivity_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/slack_oauth_request.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/success_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/supabase_configure_request.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/supabase_configure_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/supabase_o_auth_request.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/supabase_o_auth_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/supabase_projects_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/supabase_projects_response_projects_inner.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management
 

data/lib/pingram/models/supabase_status_response.rb

@@ -1,5 +1,5 @@
 =begin
-#NotificationAPI
+#Pingram
 
 #Internal API for notification delivery and management