zernio-sdk 0.0.821 → 0.0.823

data/lib/zernio-sdk/api/webhook_events_api.rb

@@ -283,6 +283,72 @@ module Zernio
       return data, status_code, headers
     end
 
+    # Analytics synced event
+    # Fired once per connected account each time its analytics sync cycle completes successfully. Poll-driven (roughly hourly per account), not real-time, and never fired for a skipped or failed cycle.  A trigger, not a transport: the payload carries no metrics and no cursor. On receipt, call `GET /v1/analytics/delta` with your own last `nextCursor` to read every post whose analytics changed, across every account, in one paginated stream instead of polling analytics once per account.  The feed holds back its most recent few seconds of writes, so a read issued the instant this event lands often returns an empty page for that account. Poll again with the same cursor rather than reading an empty page as \"nothing changed\".  High volume (roughly one delivery per connected account per hour). Subscribe to it on a dedicated webhook endpoint: a subscription's consecutive-failure count is shared across all of its events, so an outage while this event is flowing can suppress the low-volume publishing events on the same subscription. 
+    # @param webhook_payload_analytics_synced [WebhookPayloadAnalyticsSynced] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def on_analytics_synced(webhook_payload_analytics_synced, opts = {})
+      on_analytics_synced_with_http_info(webhook_payload_analytics_synced, opts)
+      nil
+    end
+
+    # Analytics synced event
+    # Fired once per connected account each time its analytics sync cycle completes successfully. Poll-driven (roughly hourly per account), not real-time, and never fired for a skipped or failed cycle.  A trigger, not a transport: the payload carries no metrics and no cursor. On receipt, call `GET /v1/analytics/delta` with your own last `nextCursor` to read every post whose analytics changed, across every account, in one paginated stream instead of polling analytics once per account.  The feed holds back its most recent few seconds of writes, so a read issued the instant this event lands often returns an empty page for that account. Poll again with the same cursor rather than reading an empty page as \"nothing changed\".  High volume (roughly one delivery per connected account per hour). Subscribe to it on a dedicated webhook endpoint: a subscription's consecutive-failure count is shared across all of its events, so an outage while this event is flowing can suppress the low-volume publishing events on the same subscription. 
+    # @param webhook_payload_analytics_synced [WebhookPayloadAnalyticsSynced] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def on_analytics_synced_with_http_info(webhook_payload_analytics_synced, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookEventsApi.on_analytics_synced ...'
+      end
+      # verify the required parameter 'webhook_payload_analytics_synced' is set
+      if @api_client.config.client_side_validation && webhook_payload_analytics_synced.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_payload_analytics_synced' when calling WebhookEventsApi.on_analytics_synced"
+      end
+      # resource path
+      local_var_path = '/analytics.synced'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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(webhook_payload_analytics_synced)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"WebhookEventsApi.on_analytics_synced",
+        :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: WebhookEventsApi#on_analytics_synced\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Call ended event
     # Fired on call hangup with the duration and a zero-markup billing breakdown (Meta cost, Telnyx cost, recording surcharge, total). Costs are pass-through; no margin is applied. 
     # @param webhook_payload_call_ended [WebhookPayloadCallEnded] 

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

@@ -0,0 +1,380 @@
+=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
+  # One changed analytics snapshot. Metrics are the absolute values recorded at `syncedAt`, not the amount they moved by since the previous snapshot, so a later entry for the same `postId` always supersedes an earlier one. 
+  class AnalyticsDeltaEntry < ApiModelBase
+    # External post ID. The same identifier as `posts[]._id` in GET /v1/analytics.
+    attr_accessor :post_id
+
+    # Social account this post was published through
+    attr_accessor :account_id
+
+    # Profile the account belongs to
+    attr_accessor :profile_id
+
+    attr_accessor :platform
+
+    # Platform-side post ID (for example the YouTube video ID)
+    attr_accessor :platform_post_id
+
+    # When the post was published, ISO-8601 UTC
+    attr_accessor :published_at
+
+    # When the sync cycle that produced this snapshot STARTED, ISO-8601 UTC. This is NOT the order entries arrive in and it is not a resume point: a slow cycle writes its rows after a faster cycle that started later, so `syncedAt` can go backwards between consecutive entries. Use `nextCursor` to resume. 
+    attr_accessor :synced_at
+
+    # True when the post was detected as deleted on the platform at this sync
+    attr_accessor :is_deleted
+
+    attr_accessor :metrics
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'post_id' => :'postId',
+        :'account_id' => :'accountId',
+        :'profile_id' => :'profileId',
+        :'platform' => :'platform',
+        :'platform_post_id' => :'platformPostId',
+        :'published_at' => :'publishedAt',
+        :'synced_at' => :'syncedAt',
+        :'is_deleted' => :'isDeleted',
+        :'metrics' => :'metrics'
+      }
+    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
+      {
+        :'post_id' => :'String',
+        :'account_id' => :'String',
+        :'profile_id' => :'String',
+        :'platform' => :'String',
+        :'platform_post_id' => :'String',
+        :'published_at' => :'Time',
+        :'synced_at' => :'Time',
+        :'is_deleted' => :'Boolean',
+        :'metrics' => :'AnalyticsDeltaEntryMetrics'
+      }
+    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::AnalyticsDeltaEntry` 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::AnalyticsDeltaEntry`. 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?(:'post_id')
+        self.post_id = attributes[:'post_id']
+      else
+        self.post_id = nil
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
+      end
+
+      if attributes.key?(:'profile_id')
+        self.profile_id = attributes[:'profile_id']
+      else
+        self.profile_id = nil
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      else
+        self.platform = nil
+      end
+
+      if attributes.key?(:'platform_post_id')
+        self.platform_post_id = attributes[:'platform_post_id']
+      else
+        self.platform_post_id = nil
+      end
+
+      if attributes.key?(:'published_at')
+        self.published_at = attributes[:'published_at']
+      else
+        self.published_at = nil
+      end
+
+      if attributes.key?(:'synced_at')
+        self.synced_at = attributes[:'synced_at']
+      else
+        self.synced_at = nil
+      end
+
+      if attributes.key?(:'is_deleted')
+        self.is_deleted = attributes[:'is_deleted']
+      else
+        self.is_deleted = nil
+      end
+
+      if attributes.key?(:'metrics')
+        self.metrics = attributes[:'metrics']
+      else
+        self.metrics = 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 @post_id.nil?
+        invalid_properties.push('invalid value for "post_id", post_id cannot be nil.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @profile_id.nil?
+        invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
+      end
+
+      if @platform.nil?
+        invalid_properties.push('invalid value for "platform", platform cannot be nil.')
+      end
+
+      if @platform_post_id.nil?
+        invalid_properties.push('invalid value for "platform_post_id", platform_post_id cannot be nil.')
+      end
+
+      if @published_at.nil?
+        invalid_properties.push('invalid value for "published_at", published_at cannot be nil.')
+      end
+
+      if @synced_at.nil?
+        invalid_properties.push('invalid value for "synced_at", synced_at cannot be nil.')
+      end
+
+      if @is_deleted.nil?
+        invalid_properties.push('invalid value for "is_deleted", is_deleted cannot be nil.')
+      end
+
+      if @metrics.nil?
+        invalid_properties.push('invalid value for "metrics", metrics 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 @post_id.nil?
+      return false if @account_id.nil?
+      return false if @profile_id.nil?
+      return false if @platform.nil?
+      return false if @platform_post_id.nil?
+      return false if @published_at.nil?
+      return false if @synced_at.nil?
+      return false if @is_deleted.nil?
+      return false if @metrics.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] post_id Value to be assigned
+    def post_id=(post_id)
+      if post_id.nil?
+        fail ArgumentError, 'post_id cannot be nil'
+      end
+
+      @post_id = post_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] profile_id Value to be assigned
+    def profile_id=(profile_id)
+      if profile_id.nil?
+        fail ArgumentError, 'profile_id cannot be nil'
+      end
+
+      @profile_id = profile_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] platform Value to be assigned
+    def platform=(platform)
+      if platform.nil?
+        fail ArgumentError, 'platform cannot be nil'
+      end
+
+      @platform = platform
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] platform_post_id Value to be assigned
+    def platform_post_id=(platform_post_id)
+      if platform_post_id.nil?
+        fail ArgumentError, 'platform_post_id cannot be nil'
+      end
+
+      @platform_post_id = platform_post_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] published_at Value to be assigned
+    def published_at=(published_at)
+      if published_at.nil?
+        fail ArgumentError, 'published_at cannot be nil'
+      end
+
+      @published_at = published_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] synced_at Value to be assigned
+    def synced_at=(synced_at)
+      if synced_at.nil?
+        fail ArgumentError, 'synced_at cannot be nil'
+      end
+
+      @synced_at = synced_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_deleted Value to be assigned
+    def is_deleted=(is_deleted)
+      if is_deleted.nil?
+        fail ArgumentError, 'is_deleted cannot be nil'
+      end
+
+      @is_deleted = is_deleted
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] metrics Value to be assigned
+    def metrics=(metrics)
+      if metrics.nil?
+        fail ArgumentError, 'metrics cannot be nil'
+      end
+
+      @metrics = metrics
+    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 &&
+          post_id == o.post_id &&
+          account_id == o.account_id &&
+          profile_id == o.profile_id &&
+          platform == o.platform &&
+          platform_post_id == o.platform_post_id &&
+          published_at == o.published_at &&
+          synced_at == o.synced_at &&
+          is_deleted == o.is_deleted &&
+          metrics == o.metrics
+    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
+      [post_id, account_id, profile_id, platform, platform_post_id, published_at, synced_at, is_deleted, metrics].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