zernio-sdk 0.0.737 → 0.0.738

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 819d897dc076c719e4b1797ef83d1398d882c4b16471432c2df6ee07bdfd689c
-  data.tar.gz: 8a17453dbd051e363180df70e571f2b08df2157e253bd18f3231f32cd1267ea2
+  metadata.gz: 204511ccaf29178934cde6c2b0d9a2cd5775d1eedb91671b414dd113f7e89b72
+  data.tar.gz: 40a2c5e15f46c2ddbf2f93d73cbe5bf7364a88d9003a33190e4fb550c7c81c5b
 SHA512:
-  metadata.gz: 18acc2df387b5373b5b33f22ebdbff93f65123a34cc9dc8927983adcba13c20dd2f9ef5998a1409c2f6973d305109ae02de7b4d9b9a07356c9b45748222843e5
-  data.tar.gz: ea17cd724391033e4e61d11ca97a12d338eb457d40c034931281c66314687a2ef99d7182f100d8a5c874677b4215cb8db1eab0ef1699e1f513126273234e62e7
+  metadata.gz: c40ef81851d6593fe3e71a79dc8b8c520ba5b0280c7efb2bbacc88a59aecec86276c5f3db099468cccd1764d36cf2a76638c4d5777a32eaa70cecbeb1f7909c9
+  data.tar.gz: d46cb077d13222edaeaf4978d9b216c9eacb5e97f364e5f5f55c56ebe63c803f4b96ebfb0c0b926a499694da6084fc8c06633c8106ef3297a08a8aa9999bd7c2

data/README.md

@@ -1536,6 +1536,7 @@ Class | Method | HTTP request | Description
  - [Zernio::ListBlogs200Response](docs/ListBlogs200Response.md)
  - [Zernio::ListBroadcastRecipients200Response](docs/ListBroadcastRecipients200Response.md)
  - [Zernio::ListBroadcastRecipients200ResponseRecipientsInner](docs/ListBroadcastRecipients200ResponseRecipientsInner.md)
+ - [Zernio::ListBroadcastRecipients200ResponseSummary](docs/ListBroadcastRecipients200ResponseSummary.md)
  - [Zernio::ListBroadcasts200Response](docs/ListBroadcasts200Response.md)
  - [Zernio::ListBroadcasts200ResponseBroadcastsInner](docs/ListBroadcasts200ResponseBroadcastsInner.md)
  - [Zernio::ListCalls200Response](docs/ListCalls200Response.md)

data/docs/ListBroadcastRecipients200Response.md

@@ -7,6 +7,7 @@
 | **success** | **Boolean** |  | [optional] |
 | **recipients** | [**Array<ListBroadcastRecipients200ResponseRecipientsInner>**](ListBroadcastRecipients200ResponseRecipientsInner.md) |  | [optional] |
 | **pagination** | [**ListContacts200ResponsePagination**](ListContacts200ResponsePagination.md) |  | [optional] |
+| **summary** | [**ListBroadcastRecipients200ResponseSummary**](ListBroadcastRecipients200ResponseSummary.md) |  | [optional] |
 
 ## Example
 
@@ -16,7 +17,8 @@ require 'zernio-sdk'
 instance = Zernio::ListBroadcastRecipients200Response.new(
   success: null,
   recipients: null,
-  pagination: null
+  pagination: null,
+  summary: null
 )
 ```
 

data/docs/ListBroadcastRecipients200ResponseSummary.md

@@ -0,0 +1,28 @@
+# Zernio::ListBroadcastRecipients200ResponseSummary
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  | [optional] |
+| **pending** | **Integer** |  | [optional] |
+| **sent** | **Integer** |  | [optional] |
+| **delivered** | **Integer** |  | [optional] |
+| **read** | **Integer** |  | [optional] |
+| **failed** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListBroadcastRecipients200ResponseSummary.new(
+  total: null,
+  pending: null,
+  sent: null,
+  delivered: null,
+  read: null,
+  failed: null
+)
+```
+

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

@@ -21,12 +21,15 @@ module Zernio
 
     attr_accessor :pagination
 
+    attr_accessor :summary
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'success' => :'success',
         :'recipients' => :'recipients',
-        :'pagination' => :'pagination'
+        :'pagination' => :'pagination',
+        :'summary' => :'summary'
       }
     end
 
@@ -45,7 +48,8 @@ module Zernio
       {
         :'success' => :'Boolean',
         :'recipients' => :'Array<ListBroadcastRecipients200ResponseRecipientsInner>',
-        :'pagination' => :'ListContacts200ResponsePagination'
+        :'pagination' => :'ListContacts200ResponsePagination',
+        :'summary' => :'ListBroadcastRecipients200ResponseSummary'
       }
     end
 
@@ -84,6 +88,10 @@ module Zernio
       if attributes.key?(:'pagination')
         self.pagination = attributes[:'pagination']
       end
+
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -108,7 +116,8 @@ module Zernio
       self.class == o.class &&
           success == o.success &&
           recipients == o.recipients &&
-          pagination == o.pagination
+          pagination == o.pagination &&
+          summary == o.summary
     end
 
     # @see the `==` method
@@ -120,7 +129,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [success, recipients, pagination].hash
+      [success, recipients, pagination, summary].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,193 @@
+=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
+  # Delivery totals across all recipients in the broadcast, independent of pagination and status filtering.
+  class ListBroadcastRecipients200ResponseSummary < ApiModelBase
+    attr_accessor :total
+
+    attr_accessor :pending
+
+    attr_accessor :sent
+
+    attr_accessor :delivered
+
+    attr_accessor :read
+
+    attr_accessor :failed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'total',
+        :'pending' => :'pending',
+        :'sent' => :'sent',
+        :'delivered' => :'delivered',
+        :'read' => :'read',
+        :'failed' => :'failed'
+      }
+    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' => :'Integer',
+        :'pending' => :'Integer',
+        :'sent' => :'Integer',
+        :'delivered' => :'Integer',
+        :'read' => :'Integer',
+        :'failed' => :'Integer'
+      }
+    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::ListBroadcastRecipients200ResponseSummary` 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::ListBroadcastRecipients200ResponseSummary`. 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']
+      end
+
+      if attributes.key?(:'pending')
+        self.pending = attributes[:'pending']
+      end
+
+      if attributes.key?(:'sent')
+        self.sent = attributes[:'sent']
+      end
+
+      if attributes.key?(:'delivered')
+        self.delivered = attributes[:'delivered']
+      end
+
+      if attributes.key?(:'read')
+        self.read = attributes[:'read']
+      end
+
+      if attributes.key?(:'failed')
+        self.failed = attributes[:'failed']
+      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
+      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'
+      true
+    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 &&
+          pending == o.pending &&
+          sent == o.sent &&
+          delivered == o.delivered &&
+          read == o.read &&
+          failed == o.failed
+    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, pending, sent, delivered, read, failed].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/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.737'
+  VERSION = '0.0.738'
 end

data/lib/zernio-sdk.rb

@@ -895,6 +895,7 @@ require 'zernio-sdk/models/list_blog_articles200_response'
 require 'zernio-sdk/models/list_blogs200_response'
 require 'zernio-sdk/models/list_broadcast_recipients200_response'
 require 'zernio-sdk/models/list_broadcast_recipients200_response_recipients_inner'
+require 'zernio-sdk/models/list_broadcast_recipients200_response_summary'
 require 'zernio-sdk/models/list_broadcasts200_response'
 require 'zernio-sdk/models/list_broadcasts200_response_broadcasts_inner'
 require 'zernio-sdk/models/list_calls200_response'

data/openapi.yaml

@@ -37152,6 +37152,16 @@ paths:
                       limit: { type: integer }
                       skip: { type: integer }
                       hasMore: { type: boolean }
+                  summary:
+                    type: object
+                    description: Delivery totals across all recipients in the broadcast, independent of pagination and status filtering.
+                    properties:
+                      total: { type: integer }
+                      pending: { type: integer }
+                      sent: { type: integer }
+                      delivered: { type: integer }
+                      read: { type: integer }
+                      failed: { type: integer }
         '400': { description: Invalid request }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '404': { $ref: '#/components/responses/NotFound' }

data/spec/models/list_broadcast_recipients200_response_spec.rb

@@ -45,4 +45,10 @@ describe Zernio::ListBroadcastRecipients200Response do
     end
   end
 
+  describe 'test attribute "summary"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
 end

data/spec/models/list_broadcast_recipients200_response_summary_spec.rb

@@ -0,0 +1,66 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Zernio::ListBroadcastRecipients200ResponseSummary
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Zernio::ListBroadcastRecipients200ResponseSummary do
+  #let(:instance) { Zernio::ListBroadcastRecipients200ResponseSummary.new }
+
+  describe 'test an instance of ListBroadcastRecipients200ResponseSummary' do
+    it 'should create an instance of ListBroadcastRecipients200ResponseSummary' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Zernio::ListBroadcastRecipients200ResponseSummary)
+    end
+  end
+
+  describe 'test attribute "total"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "pending"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "sent"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "delivered"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "read"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "failed"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zernio-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.737
+  version: 0.0.738
 platform: ruby
 authors:
 - OpenAPI-Generator
@@ -980,6 +980,7 @@ files:
 - docs/ListBlogs200Response.md
 - docs/ListBroadcastRecipients200Response.md
 - docs/ListBroadcastRecipients200ResponseRecipientsInner.md
+- docs/ListBroadcastRecipients200ResponseSummary.md
 - docs/ListBroadcasts200Response.md
 - docs/ListBroadcasts200ResponseBroadcastsInner.md
 - docs/ListCalls200Response.md
@@ -2786,6 +2787,7 @@ files:
 - lib/zernio-sdk/models/list_blogs200_response.rb
 - lib/zernio-sdk/models/list_broadcast_recipients200_response.rb
 - lib/zernio-sdk/models/list_broadcast_recipients200_response_recipients_inner.rb
+- lib/zernio-sdk/models/list_broadcast_recipients200_response_summary.rb
 - lib/zernio-sdk/models/list_broadcasts200_response.rb
 - lib/zernio-sdk/models/list_broadcasts200_response_broadcasts_inner.rb
 - lib/zernio-sdk/models/list_calls200_response.rb
@@ -4556,6 +4558,7 @@ files:
 - spec/models/list_blogs200_response_spec.rb
 - spec/models/list_broadcast_recipients200_response_recipients_inner_spec.rb
 - spec/models/list_broadcast_recipients200_response_spec.rb
+- spec/models/list_broadcast_recipients200_response_summary_spec.rb
 - spec/models/list_broadcasts200_response_broadcasts_inner_spec.rb
 - spec/models/list_broadcasts200_response_spec.rb
 - spec/models/list_calls200_response_calls_inner_spec.rb
@@ -6496,6 +6499,7 @@ test_files:
 - spec/models/list_sms_sender_ids200_response_budget_spec.rb
 - spec/models/list_comment_automation_logs200_response_misses_samples_inner_spec.rb
 - spec/models/get_ad_insights_report200_response_paging_spec.rb
+- spec/models/list_broadcast_recipients200_response_summary_spec.rb
 - spec/models/create_voice_web_session200_response_spec.rb
 - spec/models/update_linked_in_organization_request_spec.rb
 - spec/models/create_blog_article201_response_spec.rb