late-sdk 0.0.736 → 0.0.738

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

@@ -16,15 +16,20 @@ require 'time'
 module Zernio
   # Video creative. Mutually exclusive with this entry's `imageUrl`. Required if `imageUrl` is not supplied. 
   class CtwaAdRequestBodyCreativesInnerVideo < ApiModelBase
+    # Public URL of the video to upload. Provide either `url` or `id`.
     attr_accessor :url
 
-    # Required by Meta for every video creative. Used as the ad thumbnail. 
+    # Reuse a video already uploaded to this ad account (list them with GET /v1/ads/videos) instead of re-uploading. Wins over `url`. Provide either `url` or `id`.
+    attr_accessor :id
+
+    # OPTIONAL: when omitted, the poster is auto-generated from Meta's own preferred video thumbnail. When Meta produces no candidate the request fails with a 502 platform_error (reason: video_thumbnail_unavailable). 
     attr_accessor :thumbnail_url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'url' => :'url',
+        :'id' => :'id',
         :'thumbnail_url' => :'thumbnailUrl'
       }
     end
@@ -43,6 +48,7 @@ module Zernio
     def self.openapi_types
       {
         :'url' => :'String',
+        :'id' => :'String',
         :'thumbnail_url' => :'String'
       }
     end
@@ -71,14 +77,14 @@ module Zernio
 
       if attributes.key?(:'url')
         self.url = attributes[:'url']
-      else
-        self.url = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
       if attributes.key?(:'thumbnail_url')
         self.thumbnail_url = attributes[:'thumbnail_url']
-      else
-        self.thumbnail_url = nil
       end
     end
 
@@ -87,14 +93,6 @@ module Zernio
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @url.nil?
-        invalid_properties.push('invalid value for "url", url cannot be nil.')
-      end
-
-      if @thumbnail_url.nil?
-        invalid_properties.push('invalid value for "thumbnail_url", thumbnail_url cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,37 +100,16 @@ module Zernio
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @url.nil?
-      return false if @thumbnail_url.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] url Value to be assigned
-    def url=(url)
-      if url.nil?
-        fail ArgumentError, 'url cannot be nil'
-      end
-
-      @url = url
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] thumbnail_url Value to be assigned
-    def thumbnail_url=(thumbnail_url)
-      if thumbnail_url.nil?
-        fail ArgumentError, 'thumbnail_url cannot be nil'
-      end
-
-      @thumbnail_url = thumbnail_url
-    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 &&
           url == o.url &&
+          id == o.id &&
           thumbnail_url == o.thumbnail_url
     end
 
@@ -145,7 +122,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [url, thumbnail_url].hash
+      [url, id, thumbnail_url].hash
     end
 
     # Builds the object from hash

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

@@ -16,15 +16,20 @@ require 'time'
 module Zernio
   # Video creative for single-creative shape. Mutually exclusive with `imageUrl` and with `creatives[]`. Required on the single-creative shape if `imageUrl` is not supplied. 
   class CtwaAdRequestBodyVideo < ApiModelBase
+    # Public URL of the video to upload. Provide either `url` or `id`.
     attr_accessor :url
 
-    # Required by Meta for every video creative. Used as the ad thumbnail. 
+    # Reuse a video already uploaded to this ad account (list them with GET /v1/ads/videos) instead of re-uploading. Wins over `url`. Provide either `url` or `id`.
+    attr_accessor :id
+
+    # OPTIONAL: when omitted, the poster is auto-generated from Meta's own preferred video thumbnail. When Meta produces no candidate the request fails with a 502 platform_error (reason: video_thumbnail_unavailable) — retry, or supply this field to control the poster frame exactly. 
     attr_accessor :thumbnail_url
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'url' => :'url',
+        :'id' => :'id',
         :'thumbnail_url' => :'thumbnailUrl'
       }
     end
@@ -43,6 +48,7 @@ module Zernio
     def self.openapi_types
       {
         :'url' => :'String',
+        :'id' => :'String',
         :'thumbnail_url' => :'String'
       }
     end
@@ -71,14 +77,14 @@ module Zernio
 
       if attributes.key?(:'url')
         self.url = attributes[:'url']
-      else
-        self.url = nil
+      end
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
       if attributes.key?(:'thumbnail_url')
         self.thumbnail_url = attributes[:'thumbnail_url']
-      else
-        self.thumbnail_url = nil
       end
     end
 
@@ -87,14 +93,6 @@ module Zernio
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @url.nil?
-        invalid_properties.push('invalid value for "url", url cannot be nil.')
-      end
-
-      if @thumbnail_url.nil?
-        invalid_properties.push('invalid value for "thumbnail_url", thumbnail_url cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -102,37 +100,16 @@ module Zernio
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @url.nil?
-      return false if @thumbnail_url.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] url Value to be assigned
-    def url=(url)
-      if url.nil?
-        fail ArgumentError, 'url cannot be nil'
-      end
-
-      @url = url
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] thumbnail_url Value to be assigned
-    def thumbnail_url=(thumbnail_url)
-      if thumbnail_url.nil?
-        fail ArgumentError, 'thumbnail_url cannot be nil'
-      end
-
-      @thumbnail_url = thumbnail_url
-    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 &&
           url == o.url &&
+          id == o.id &&
           thumbnail_url == o.thumbnail_url
     end
 
@@ -145,7 +122,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [url, thumbnail_url].hash
+      [url, id, thumbnail_url].hash
     end
 
     # Builds the object from hash

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.736'
+  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

@@ -825,15 +825,18 @@ components:
             single-creative shape if `video` is not supplied.
         video:
           type: object
-          required: [url, thumbnailUrl]
           properties:
-            url: { type: string, format: uri }
+            url: { type: string, format: uri, description: "Public URL of the video to upload. Provide either `url` or `id`." }
+            id: { type: string, description: "Reuse a video already uploaded to this ad account (list them with GET /v1/ads/videos) instead of re-uploading. Wins over `url`. Provide either `url` or `id`." }
             thumbnailUrl:
               type: string
               format: uri
               description: |
-                Required by Meta for every video creative. Used as the
-                ad thumbnail.
+                OPTIONAL: when omitted, the poster is auto-generated from
+                Meta's own preferred video thumbnail. When Meta produces no
+                candidate the request fails with a 502 platform_error
+                (reason: video_thumbnail_unavailable) — retry, or supply
+                this field to control the poster frame exactly.
           description: |
             Video creative for single-creative shape. Mutually
             exclusive with `imageUrl` and with `creatives[]`. Required
@@ -871,15 +874,17 @@ components:
                   `video`. Required if `video` is not supplied.
               video:
                 type: object
-                required: [url, thumbnailUrl]
                 properties:
-                  url: { type: string, format: uri }
+                  url: { type: string, format: uri, description: "Public URL of the video to upload. Provide either `url` or `id`." }
+                  id: { type: string, description: "Reuse a video already uploaded to this ad account (list them with GET /v1/ads/videos) instead of re-uploading. Wins over `url`. Provide either `url` or `id`." }
                   thumbnailUrl:
                     type: string
                     format: uri
                     description: |
-                      Required by Meta for every video creative. Used
-                      as the ad thumbnail.
+                      OPTIONAL: when omitted, the poster is auto-generated
+                      from Meta's own preferred video thumbnail. When Meta
+                      produces no candidate the request fails with a 502
+                      platform_error (reason: video_thumbnail_unavailable).
                 description: |
                   Video creative. Mutually exclusive with this entry's
                   `imageUrl`. Required if `imageUrl` is not supplied.
@@ -889,9 +894,9 @@ components:
             Attach the creatives to this EXISTING messaging ad set instead of
             building a campaign, so the ad set keeps its learning phase. It then
             owns budget, targeting and schedule, so `budgetAmount`, `budgetType`,
-            `endDate`, `objective`, `countries`, `interests` and `audienceId` are
-            rejected with a 400 alongside it. Its `destination_type` must match
-            the ad's destination.
+            `endDate`, `objective`, `countries`, `interests`, `audienceId` and
+            `campaignStatus` are rejected with a 400 alongside it. Its
+            `destination_type` must match the ad's destination.
         budgetAmount:
           type: number
           exclusiveMinimum: 0
@@ -1057,6 +1062,22 @@ components:
             Defaults to `OUTCOME_ENGAGEMENT`. `OUTCOME_SALES` and `OUTCOME_LEADS` require
             additional account configuration (Dataset linked to the WABA
             for sales) and may be rejected by Meta if missing.
+        status:
+          type: string
+          enum: [ACTIVE, PAUSED]
+          description: |
+            Ad-level status. Defaults to `ACTIVE`. `PAUSED` skips activating the
+            newly created ad(s) after Meta accepts them.
+        campaignStatus:
+          type: string
+          enum: [ACTIVE, PAUSED]
+          description: |
+            Campaign-level status, same semantics as `POST /v1/ads/create`. Defaults
+            to `ACTIVE`. `PAUSED` holds activation at the campaign so it never
+            spends before the advertiser reviews it, while the ad set and ad still
+            switch on (one resume call brings the whole hierarchy live). Only
+            meaningful when a new campaign is being created; rejected with a 400
+            alongside `adSetId` (the attach shape reuses an existing campaign).
         bidStrategy:
           type: string
           enum:
@@ -37131,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/create_call_ad_request_spec.rb

@@ -195,6 +195,26 @@ describe Zernio::CreateCallAdRequest do
     end
   end
 
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "campaign_status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.campaign_status = value }.not_to raise_error
+      # end
+    end
+  end
+
   describe 'test attribute "bid_strategy"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/create_messaging_ad_request_spec.rb

@@ -195,6 +195,26 @@ describe Zernio::CreateMessagingAdRequest do
     end
   end
 
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "campaign_status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.campaign_status = value }.not_to raise_error
+      # end
+    end
+  end
+
   describe 'test attribute "bid_strategy"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/ctwa_ad_request_body_creatives_inner_video_spec.rb

@@ -33,6 +33,12 @@ describe Zernio::CtwaAdRequestBodyCreativesInnerVideo do
     end
   end
 
+  describe 'test attribute "id"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "thumbnail_url"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

data/spec/models/ctwa_ad_request_body_spec.rb

@@ -195,6 +195,26 @@ describe Zernio::CtwaAdRequestBody do
     end
   end
 
+  describe 'test attribute "status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.status = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "campaign_status"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["ACTIVE", "PAUSED"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.campaign_status = value }.not_to raise_error
+      # end
+    end
+  end
+
   describe 'test attribute "bid_strategy"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/