late-sdk 0.0.871 → 0.0.873

data/lib/zernio-sdk/models/conversation.rb

@@ -0,0 +1,334 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api  Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal.  Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  class Conversation < ApiModelBase
+    # Internal conversation ID
+    attr_accessor :id
+
+    attr_accessor :platform
+
+    attr_accessor :platform_conversation_id
+
+    # Contact's platform identifier (IGSID, PSID, wa_id, etc.)
+    attr_accessor :participant_id
+
+    attr_accessor :participant_name
+
+    # Contact's handle when the platform exposes one
+    attr_accessor :participant_username
+
+    attr_accessor :participant_picture
+
+    attr_accessor :status
+
+    # Zernio CRM Contact ID for the participant, when one exists. Resolved by joining `participantId` to the ContactChannel collection (same join used by message.*, reaction.received, and call.* webhooks). Best-effort: omitted when no channel matches or `participantId` is absent. Lets integrators seed the CRM straight from `conversation.started` without waiting for the first `message.*` event. 
+    attr_accessor :contact_id
+
+    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
+      {
+        :'id' => :'id',
+        :'platform' => :'platform',
+        :'platform_conversation_id' => :'platformConversationId',
+        :'participant_id' => :'participantId',
+        :'participant_name' => :'participantName',
+        :'participant_username' => :'participantUsername',
+        :'participant_picture' => :'participantPicture',
+        :'status' => :'status',
+        :'contact_id' => :'contactId'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'platform' => :'String',
+        :'platform_conversation_id' => :'String',
+        :'participant_id' => :'String',
+        :'participant_name' => :'String',
+        :'participant_username' => :'String',
+        :'participant_picture' => :'String',
+        :'status' => :'String',
+        :'contact_id' => :'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 `Zernio::Conversation` 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 `Zernio::Conversation`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      else
+        self.platform = nil
+      end
+
+      if attributes.key?(:'platform_conversation_id')
+        self.platform_conversation_id = attributes[:'platform_conversation_id']
+      else
+        self.platform_conversation_id = nil
+      end
+
+      if attributes.key?(:'participant_id')
+        self.participant_id = attributes[:'participant_id']
+      end
+
+      if attributes.key?(:'participant_name')
+        self.participant_name = attributes[:'participant_name']
+      else
+        self.participant_name = nil
+      end
+
+      if attributes.key?(:'participant_username')
+        self.participant_username = attributes[:'participant_username']
+      end
+
+      if attributes.key?(:'participant_picture')
+        self.participant_picture = attributes[:'participant_picture']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'contact_id')
+        self.contact_id = attributes[:'contact_id']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @platform.nil?
+        invalid_properties.push('invalid value for "platform", platform cannot be nil.')
+      end
+
+      if @platform_conversation_id.nil?
+        invalid_properties.push('invalid value for "platform_conversation_id", platform_conversation_id cannot be nil.')
+      end
+
+      if @participant_name.nil?
+        invalid_properties.push('invalid value for "participant_name", participant_name 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 @id.nil?
+      return false if @platform.nil?
+      platform_validator = EnumAttributeValidator.new('String', ["instagram", "facebook", "telegram", "whatsapp", "twitter", "reddit", "bluesky", "sms", "slack"])
+      return false unless platform_validator.valid?(@platform)
+      return false if @platform_conversation_id.nil?
+      return false if @participant_name.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["active", "archived"])
+      return false unless status_validator.valid?(@status)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] platform Object to be assigned
+    def platform=(platform)
+      validator = EnumAttributeValidator.new('String', ["instagram", "facebook", "telegram", "whatsapp", "twitter", "reddit", "bluesky", "sms", "slack"])
+      unless validator.valid?(platform)
+        fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
+      end
+      @platform = platform
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] platform_conversation_id Value to be assigned
+    def platform_conversation_id=(platform_conversation_id)
+      if platform_conversation_id.nil?
+        fail ArgumentError, 'platform_conversation_id cannot be nil'
+      end
+
+      @platform_conversation_id = platform_conversation_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] participant_name Value to be assigned
+    def participant_name=(participant_name)
+      if participant_name.nil?
+        fail ArgumentError, 'participant_name cannot be nil'
+      end
+
+      @participant_name = participant_name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "archived"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    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 &&
+          id == o.id &&
+          platform == o.platform &&
+          platform_conversation_id == o.platform_conversation_id &&
+          participant_id == o.participant_id &&
+          participant_name == o.participant_name &&
+          participant_username == o.participant_username &&
+          participant_picture == o.participant_picture &&
+          status == o.status &&
+          contact_id == o.contact_id
+    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
+      [id, platform, platform_conversation_id, participant_id, participant_name, participant_username, participant_picture, status, contact_id].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/zernio-sdk/models/conversion_destination.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Zernio
-  # A discoverable conversion destination on an ad platform — a Meta pixel, Google conversion action, or LinkedIn conversion rule. Returned by `listConversionDestinations`, `getConversionDestination`, `createConversionDestination`, and `updateConversionDestination`. 
+  # A discoverable conversion destination on an ad platform: a Meta pixel, Google conversion action, or LinkedIn conversion rule. Returned by `listConversionDestinations`, `getConversionDestination`, `createConversionDestination`, and `updateConversionDestination`. 
   class ConversionDestination < ApiModelBase
     # Platform-native identifier. Pass back as `destinationId` on event send and as the path segment on CRUD endpoints. 
     attr_accessor :id

data/lib/zernio-sdk/models/conversion_event.rb

@@ -16,7 +16,7 @@ require 'time'
 module Zernio
   # A single conversion event to relay to the ad platform. All PII fields (email, phone, names) are hashed with SHA-256 server-side using each platform's normalization rules before they leave Zernio. Callers send plaintext. 
   class ConversionEvent < ApiModelBase
-    # Standard event name (Purchase, Lead, CompleteRegistration, AddToCart, InitiateCheckout, AddPaymentInfo, Subscribe, StartTrial, ViewContent, Search, Contact, SubmitApplication, Schedule) or a custom string (only supported on platforms that accept custom events — Meta and OpenAI Ads).  Per-platform behavior: - Meta: free-form; standard names match Meta's built-ins. - Google: ignored — the conversion action's category determines the type. - LinkedIn: ignored — the conversion rule's `type` is locked to the destination. - OpenAI Ads: a fixed subset of standard names (Purchase, Lead, AddToCart, ViewContent, InitiateCheckout, CompleteRegistration, Subscribe, StartTrial, Schedule) maps 1:1 onto OpenAI's own event-type enum; anything else is sent as a custom event with the name preserved. 
+    # Standard event name (Purchase, Lead, CompleteRegistration, AddToCart, InitiateCheckout, AddPaymentInfo, Subscribe, StartTrial, ViewContent, Search, Contact, SubmitApplication, Schedule) or a custom string (only supported on platforms that accept custom events: Meta and OpenAI Ads).  Per-platform behavior: - Meta: free-form; standard names match Meta's built-ins. - Google: ignored. The conversion action's category determines the type. - LinkedIn: ignored. The conversion rule's `type` is locked to the destination. - OpenAI Ads: a fixed subset of standard names (Purchase, Lead, AddToCart, ViewContent, InitiateCheckout, CompleteRegistration, Subscribe, StartTrial, Schedule) maps 1:1 onto OpenAI's own event-type enum; anything else is sent as a custom event with the name preserved. 
     attr_accessor :event_name
 
     # When the conversion happened, in unix seconds.

data/lib/zernio-sdk/models/create_ad_campaign_request.rb

@@ -28,7 +28,7 @@ module Zernio
 
     attr_accessor :special_ad_categories
 
-    # Campaign-level (CBO) budget in WHOLE currency units (USD: 50 = $50.00), NOT cents — Meta's own Marketing API takes this same number in minor units, so it is an easy and expensive mix-up. Requires budgetType.
+    # Campaign-level (CBO) budget in WHOLE currency units (USD: 50 = $50.00), NOT cents. Meta's own Marketing API takes this same number in minor units, so it is an easy and expensive mix-up. Requires budgetType.
     attr_accessor :budget_amount
 
     attr_accessor :budget_type

data/lib/zernio-sdk/models/create_ad_creative_request.rb

@@ -48,7 +48,7 @@ module Zernio
     # Advantage+ creative enhancements: partial map of Meta creative feature keys (snake_case) to enroll status, forwarded as degrees_of_freedom_spec.creative_features_spec. Unspecified features default to OPT_OUT.
     attr_accessor :creative_features
 
-    # Meta only. Multi-advertiser ads: whether Meta may show this ad alongside other advertisers' in one unit. Meta auto-enrols since Aug 2024, so send OPT_OUT to leave. It is a top-level creative field, NOT a `creativeFeatures` key — Meta rejects it there.
+    # Meta only. Multi-advertiser ads: whether Meta may show this ad alongside other advertisers' in one unit. Meta auto-enrols since Aug 2024, so send OPT_OUT to leave. It is a top-level creative field, NOT a `creativeFeatures` key, and Meta rejects it there.
     attr_accessor :multi_advertiser
 
     class EnumAttributeValidator

data/lib/zernio-sdk/models/create_api_key_request.rb

@@ -29,7 +29,7 @@ module Zernio
     # 'read-write' allows all operations (default), 'read' restricts to GET requests only
     attr_accessor :permission
 
-    # Resource groups to DISABLE on this key (opt-out denylist). Omit for a legacy full-access key. A key with any group disabled mints with the zrk_ prefix, gets 403 with code=insufficient_permissions and required_group on operations in disabled groups (each operation's group is published as x-resource-group), and can never manage API keys, invites, or member identity. With 'messages' disabled, the key cannot read or send private messages through any API surface and cannot create or edit a webhook subscription broader than itself. Subscriptions that already exist are governed by their own `disabledResourceGroups`, not by this key's. OAuth connector tokens resolve against the same registry, but their groups are not settable yet.
+    # Resource groups to DISABLE on this key (opt-out denylist). Omit for a legacy full-access key. A key with any group disabled mints with the zrk_ prefix, gets 403 with code=insufficient_permissions and required_group on operations in disabled groups (each operation's group is published as x-resource-group), and can never manage API keys, invites, or member identity. With 'messages' disabled, the key cannot read or send direct messages through any API surface and cannot create or edit a webhook subscription broader than itself. Subscriptions that already exist are governed by their own `disabledResourceGroups`, not by this key's. OAuth connector tokens resolve against the same registry, but their groups are not settable yet.
     attr_accessor :disabled_resource_groups
 
     class EnumAttributeValidator

data/lib/zernio-sdk/models/create_inbox_conversation201_response_data.rb

@@ -21,13 +21,13 @@ module Zernio
     # Platform conversation ID (dm_conversation_id). For WhatsApp, this is Zernio's internal conversation id (24-character hex) which matches the id returned by the list-conversations endpoint and the conversationId in the message.received and conversation.started webhooks; use it to correlate the created thread with inbound events.
     attr_accessor :conversation_id
 
-    # Twitter numeric user ID of the recipient
+    # X numeric user ID of the recipient
     attr_accessor :participant_id
 
     # Display name of the recipient
     attr_accessor :participant_name
 
-    # Twitter username of the recipient
+    # X username of the recipient
     attr_accessor :participant_username
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/zernio-sdk/models/create_inbox_conversation_request.rb

@@ -15,19 +15,19 @@ require 'time'
 
 module Zernio
   class CreateInboxConversationRequest < ApiModelBase
-    # The social account ID to send from
+    # The account ID to send from
     attr_accessor :account_id
 
     # Recipient identifier. For X this is the numeric user ID; for WhatsApp and SMS, the recipient phone number in international format (digits, country code included); for Slack, the workspace member id (e.g. U01ABCDEF). Provide either this or participantUsername.
     attr_accessor :participant_id
 
-    # Recipient handle/username — an X or Bluesky handle (with or without @) or a Reddit username (with or without u/). Resolved via lookup. Provide either this or participantId.
+    # Recipient handle/username, an X or Bluesky handle (with or without @) or a Reddit username (with or without u/). Resolved via lookup. Provide either this or participantId.
     attr_accessor :participant_username
 
     # Text content of the message. At least one of message, attachment, or (for WhatsApp) templateName is required. Required when category is set (a Direct Send utility message is a text message).
     attr_accessor :message
 
-    # X/Twitter only. Skip the receives_your_dm eligibility check before sending. Use if you have already verified the recipient accepts DMs.
+    # X only. Skip the receives_your_dm eligibility check before sending. Use if you have already verified the recipient accepts DMs.
     attr_accessor :skip_dm_check
 
     # WhatsApp only. Name of the approved template to start the conversation with. Required for WhatsApp unless category is used instead (Direct Send). Cannot be combined with category.

data/lib/zernio-sdk/models/create_phone_number_port_in_request_end_user.rb

@@ -14,18 +14,18 @@ require 'date'
 require 'time'
 
 module Zernio
-  # End-user / current-carrier account info that authorizes the port. The losing carrier matches every field against its records and rejects the whole port on a mismatch — enter values exactly as they appear on the carrier bill. 
+  # End-user / current-carrier account info that authorizes the port. The losing carrier matches every field against its records and rejects the whole port on a mismatch, so enter values exactly as they appear on the carrier bill. 
   class CreatePhoneNumberPortInRequestEndUser < ApiModelBase
     # Account holder / business name, as on the carrier account.
     attr_accessor :entity_name
 
-    # Full name (first + last) of the person authorizing the port — must match the LOA signature.
+    # Full name (first + last) of the person authorizing the port, which must match the LOA signature.
     attr_accessor :auth_person_name
 
     # Phone number on the losing carrier's bill. Defaults to the ported number itself on single-number orders. Validated as a real phone number when present.
     attr_accessor :billing_phone_number
 
-    # Account number with the losing carrier — required (carriers reject ports without it; on prepaid mobile plans it is often the phone number itself).
+    # Account number with the losing carrier. Required (carriers reject ports without it; on prepaid mobile plans it is often the phone number itself).
     attr_accessor :account_number
 
     # Transfer PIN. Required for US/CA mobile numbers (wireless carriers reject PIN-less ports). Forwarded to the carrier, never stored. International porting codes (e.g. the UK PAC) go through `requirements` instead.

data/lib/zernio-sdk/models/create_standalone_ad201_response_one_of.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Zernio
-  # Legacy + attach shapes — one ad returned.
+  # Legacy + attach shapes: one ad returned.
   class CreateStandaloneAd201ResponseOneOf < ApiModelBase
     attr_accessor :ad
 

data/lib/zernio-sdk/models/create_standalone_ad201_response_one_of1.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Zernio
-  # Multi-creative shape — N ads returned sharing platformCampaignId / platformAdSetId.
+  # Multi-creative shape: N ads returned sharing platformCampaignId / platformAdSetId.
   class CreateStandaloneAd201ResponseOneOf1 < ApiModelBase
     attr_accessor :ads