late-sdk 0.0.571 → 0.0.573

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

@@ -20,9 +20,9 @@ module Zernio
       @api_client = api_client
     end
     # Archive a lead form
-    # Meta has no hard delete for forms; this archives the form (status=ARCHIVED).
-    # @param form_id [String] 
-    # @param account_id [String] 
+    # Neither platform hard-deletes a form; this archives it (Meta status=ARCHIVED; LinkedIn state=ARCHIVED via PARTIAL_UPDATE).
+    # @param form_id [String] Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
+    # @param account_id [String] Connected facebook or linkedin ads account id (selects the platform).
     # @param [Hash] opts the optional parameters
     # @return [ArchiveLeadForm200Response]
     def archive_lead_form(form_id, account_id, opts = {})
@@ -31,9 +31,9 @@ module Zernio
     end
 
     # Archive a lead form
-    # Meta has no hard delete for forms; this archives the form (status=ARCHIVED).
-    # @param form_id [String] 
-    # @param account_id [String] 
+    # Neither platform hard-deletes a form; this archives it (Meta status=ARCHIVED; LinkedIn state=ARCHIVED via PARTIAL_UPDATE).
+    # @param form_id [String] Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
+    # @param account_id [String] Connected facebook or linkedin ads account id (selects the platform).
     # @param [Hash] opts the optional parameters
     # @return [Array<(ArchiveLeadForm200Response, Integer, Hash)>] ArchiveLeadForm200Response data, response status code and response headers
     def archive_lead_form_with_http_info(form_id, account_id, opts = {})
@@ -90,7 +90,7 @@ module Zernio
     end
 
     # Create a lead form
-    # Creates a Lead Gen form on the connected Facebook Page (POST /{page-id}/leadgen_forms). NOT idempotent — a retry creates a second form. Prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. Requires the Ads add-on. 
+    # Creates a Lead Gen form. The form content goes inside `platformSpecificData` for both platforms (the shape is selected by the accountId's platform). Meta: created on the connected Facebook Page (POST /{page-id}/leadgen_forms); the old top-level Meta fields (questions, thankYou*, contextCard, …) are DEPRECATED but still accepted while platformSpecificData is absent — mixing both shapes is a 400. LinkedIn: created on the ad account's Company Page. NOT idempotent — a retry creates a second form. Meta prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. LinkedIn exposes only free-text and multiple-choice questions via API (prefilled-from-profile fields are Campaign Manager UI-only). Requires the Ads add-on. 
     # @param create_lead_form_request [CreateLeadFormRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CreateLeadForm200Response]
@@ -100,7 +100,7 @@ module Zernio
     end
 
     # Create a lead form
-    # Creates a Lead Gen form on the connected Facebook Page (POST /{page-id}/leadgen_forms). NOT idempotent — a retry creates a second form. Prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. Requires the Ads add-on. 
+    # Creates a Lead Gen form. The form content goes inside &#x60;platformSpecificData&#x60; for both platforms (the shape is selected by the accountId&#39;s platform). Meta: created on the connected Facebook Page (POST /{page-id}/leadgen_forms); the old top-level Meta fields (questions, thankYou*, contextCard, …) are DEPRECATED but still accepted while platformSpecificData is absent — mixing both shapes is a 400. LinkedIn: created on the ad account&#39;s Company Page. NOT idempotent — a retry creates a second form. Meta prefilled question types (EMAIL, PHONE, FULL_NAME, …) must omit label/key; CUSTOM questions require both. LinkedIn exposes only free-text and multiple-choice questions via API (prefilled-from-profile fields are Campaign Manager UI-only). Requires the Ads add-on. 
     # @param create_lead_form_request [CreateLeadFormRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreateLeadForm200Response, Integer, Hash)>] CreateLeadForm200Response data, response status code and response headers
@@ -232,8 +232,8 @@ module Zernio
     end
 
     # Get a lead form
-    # @param form_id [String] 
-    # @param account_id [String] 
+    # @param form_id [String] Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
+    # @param account_id [String] Connected facebook or linkedin ads account id (selects the platform).
     # @param [Hash] opts the optional parameters
     # @return [GetLeadForm200Response]
     def get_lead_form(form_id, account_id, opts = {})
@@ -242,8 +242,8 @@ module Zernio
     end
 
     # Get a lead form
-    # @param form_id [String] 
-    # @param account_id [String] 
+    # @param form_id [String] Numeric form id (Meta leadgen_form id or LinkedIn leadForm id).
+    # @param account_id [String] Connected facebook or linkedin ads account id (selects the platform).
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetLeadForm200Response, Integer, Hash)>] GetLeadForm200Response data, response status code and response headers
     def get_lead_form_with_http_info(form_id, account_id, opts = {})
@@ -387,9 +387,10 @@ module Zernio
     end
 
     # List lead forms
-    # Lists the Lead Gen forms owned by the connected Facebook Page. Requires the Ads add-on.
-    # @param account_id [String] Connected facebook account id.
+    # Lists the Lead Gen forms owned by the account. Meta: forms on the connected Facebook Page. LinkedIn: forms owned by the ad account's Company Page — pass `adAccountId` (LinkedIn forms are org-owned). Requires the Ads add-on. 
+    # @param account_id [String] Connected facebook or linkedin ads account id.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id LinkedIn only: the LinkedIn ad account id (used to resolve the owning organization). Required for LinkedIn.
     # @option opts [Integer] :limit  (default to 25)
     # @option opts [String] :cursor 
     # @return [ListLeadForms200Response]
@@ -399,9 +400,10 @@ module Zernio
     end
 
     # List lead forms
-    # Lists the Lead Gen forms owned by the connected Facebook Page. Requires the Ads add-on.
-    # @param account_id [String] Connected facebook account id.
+    # Lists the Lead Gen forms owned by the account. Meta: forms on the connected Facebook Page. LinkedIn: forms owned by the ad account&#39;s Company Page — pass &#x60;adAccountId&#x60; (LinkedIn forms are org-owned). Requires the Ads add-on. 
+    # @param account_id [String] Connected facebook or linkedin ads account id.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :ad_account_id LinkedIn only: the LinkedIn ad account id (used to resolve the owning organization). Required for LinkedIn.
     # @option opts [Integer] :limit  (default to 25)
     # @option opts [String] :cursor 
     # @return [Array<(ListLeadForms200Response, Integer, Hash)>] ListLeadForms200Response data, response status code and response headers
@@ -427,6 +429,7 @@ module Zernio
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'accountId'] = account_id
+      query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
 
@@ -465,13 +468,14 @@ module Zernio
     end
 
     # List submitted leads
-    # Returns persisted Meta Lead Gen leads for your team, newest-first, with keyset pagination on `cursor`. Leads are ingested in real time from the `leadgen` webhook. Requires the Ads add-on. 
+    # Returns submitted Lead Gen leads for your team, newest-first, with keyset pagination on `cursor`. For Meta (default) leads are served from the persisted cache, ingested in real time from the `leadgen` webhook. When `accountId` is a LinkedIn ads account, leads are fetched live from LinkedIn's `leadFormResponses` (LinkedIn has no webhook and enforces 90-day retention, so nothing is persisted) and `adAccountId` is required. Reading LinkedIn responses needs the `r_marketing_leadgen_automation` permission; accounts connected before it was added must reconnect. Requires the Ads add-on. 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :form_id Filter to a single lead form.
-    # @option opts [String] :account_id Filter to a single connected account.
+    # @option opts [String] :account_id Filter to a single connected account. LinkedIn ads accounts switch to the live fetch.
+    # @option opts [String] :ad_account_id LinkedIn only: the LinkedIn ad account id whose responses to read (owner-scoped finder).
     # @option opts [Integer] :limit  (default to 25)
-    # @option opts [Integer] :since Unix seconds; only leads created at/after this Meta timestamp.
-    # @option opts [String] :cursor Keyset cursor from a previous response&#39;s pagination.cursor.
+    # @option opts [Integer] :since Unix seconds; only leads created at/after this timestamp.
+    # @option opts [String] :cursor Keyset cursor from a previous response&#39;s pagination.cursor (Meta: AdLead id; LinkedIn: numeric start offset).
     # @return [ListLeads200Response]
     def list_leads(opts = {})
       data, _status_code, _headers = list_leads_with_http_info(opts)
@@ -479,13 +483,14 @@ module Zernio
     end
 
     # List submitted leads
-    # Returns persisted Meta Lead Gen leads for your team, newest-first, with keyset pagination on &#x60;cursor&#x60;. Leads are ingested in real time from the &#x60;leadgen&#x60; webhook. Requires the Ads add-on. 
+    # Returns submitted Lead Gen leads for your team, newest-first, with keyset pagination on &#x60;cursor&#x60;. For Meta (default) leads are served from the persisted cache, ingested in real time from the &#x60;leadgen&#x60; webhook. When &#x60;accountId&#x60; is a LinkedIn ads account, leads are fetched live from LinkedIn&#39;s &#x60;leadFormResponses&#x60; (LinkedIn has no webhook and enforces 90-day retention, so nothing is persisted) and &#x60;adAccountId&#x60; is required. Reading LinkedIn responses needs the &#x60;r_marketing_leadgen_automation&#x60; permission; accounts connected before it was added must reconnect. Requires the Ads add-on. 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :form_id Filter to a single lead form.
-    # @option opts [String] :account_id Filter to a single connected account.
+    # @option opts [String] :account_id Filter to a single connected account. LinkedIn ads accounts switch to the live fetch.
+    # @option opts [String] :ad_account_id LinkedIn only: the LinkedIn ad account id whose responses to read (owner-scoped finder).
     # @option opts [Integer] :limit  (default to 25)
-    # @option opts [Integer] :since Unix seconds; only leads created at/after this Meta timestamp.
-    # @option opts [String] :cursor Keyset cursor from a previous response&#39;s pagination.cursor.
+    # @option opts [Integer] :since Unix seconds; only leads created at/after this timestamp.
+    # @option opts [String] :cursor Keyset cursor from a previous response&#39;s pagination.cursor (Meta: AdLead id; LinkedIn: numeric start offset).
     # @return [Array<(ListLeads200Response, Integer, Hash)>] ListLeads200Response data, response status code and response headers
     def list_leads_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -506,6 +511,7 @@ module Zernio
       query_params = opts[:query_params] || {}
       query_params[:'formId'] = opts[:'form_id'] if !opts[:'form_id'].nil?
       query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
+      query_params[:'adAccountId'] = opts[:'ad_account_id'] if !opts[:'ad_account_id'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
       query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
       query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

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

@@ -27,7 +27,7 @@ module Zernio
     # For `geo` only — the area(s) the registered address must be in.
     attr_accessor :areas
 
-    # Live inventory grouped by area code, largest stock first. Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. 
+    # Live inventory grouped by area code, largest stock first. For US and CA this is the full country inventory (every area code with stock, named by state/province); other countries list the areas in the latest inventory page (up to 500 numbers, which for most countries is the entire pool). Empty when out of stock (or the area lookup failed). Pass a chosen `ndc` as `areaCode` on POST /v1/phone-numbers/purchase (or on the KYC submit for regulated countries) to require that area. 
     attr_accessor :area_options
 
     class EnumAttributeValidator

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

@@ -18,10 +18,10 @@ module Zernio
     # Area code (national destination code), e.g. \"11\".
     attr_accessor :ndc
 
-    # Human-readable area name, e.g. \"Sao Paulo\".
+    # Area name: state/province for US/CA (e.g. \"Minnesota\"), city otherwise (e.g. \"Sao Paulo\").
     attr_accessor :name
 
-    # Deliverable numbers seen in this area on the latest inventory page.
+    # Numbers available in this area: country-wide count for US/CA, numbers seen on the latest inventory page otherwise.
     attr_accessor :count
 
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -19,28 +19,40 @@ module Zernio
 
     attr_accessor :name
 
+    # Deprecated (Meta legacy shape): use platformSpecificData.questions.
     attr_accessor :questions
 
     attr_accessor :privacy_policy_url
 
+    # Deprecated: use platformSpecificData.privacyPolicyLinkText.
     attr_accessor :privacy_policy_link_text
 
+    # Deprecated: use platformSpecificData.followUpActionUrl.
     attr_accessor :follow_up_action_url
 
+    # Deprecated: use platformSpecificData.locale.
     attr_accessor :locale
 
+    # Deprecated: use platformSpecificData.thankYouTitle.
     attr_accessor :thank_you_title
 
+    # Deprecated: use platformSpecificData.thankYouBody.
     attr_accessor :thank_you_body
 
+    # Deprecated: use platformSpecificData.thankYouButtonText.
     attr_accessor :thank_you_button_text
 
+    # Deprecated: use platformSpecificData.thankYouButtonType.
     attr_accessor :thank_you_button_type
 
+    # Deprecated: use platformSpecificData.thankYouWebsiteUrl.
     attr_accessor :thank_you_website_url
 
+    # Deprecated: use platformSpecificData.isOptimizedForQuality.
     attr_accessor :is_optimized_for_quality
 
+    attr_accessor :platform_specific_data
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -56,7 +68,8 @@ module Zernio
         :'thank_you_button_text' => :'thankYouButtonText',
         :'thank_you_button_type' => :'thankYouButtonType',
         :'thank_you_website_url' => :'thankYouWebsiteUrl',
-        :'is_optimized_for_quality' => :'isOptimizedForQuality'
+        :'is_optimized_for_quality' => :'isOptimizedForQuality',
+        :'platform_specific_data' => :'platformSpecificData'
       }
     end
 
@@ -85,7 +98,8 @@ module Zernio
         :'thank_you_button_text' => :'String',
         :'thank_you_button_type' => :'String',
         :'thank_you_website_url' => :'String',
-        :'is_optimized_for_quality' => :'Boolean'
+        :'is_optimized_for_quality' => :'Boolean',
+        :'platform_specific_data' => :'CreateLeadFormRequestPlatformSpecificData'
       }
     end
 
@@ -127,8 +141,6 @@ module Zernio
         if (value = attributes[:'questions']).is_a?(Array)
           self.questions = value
         end
-      else
-        self.questions = nil
       end
 
       if attributes.key?(:'privacy_policy_url')
@@ -172,6 +184,10 @@ module Zernio
       if attributes.key?(:'is_optimized_for_quality')
         self.is_optimized_for_quality = attributes[:'is_optimized_for_quality']
       end
+
+      if attributes.key?(:'platform_specific_data')
+        self.platform_specific_data = attributes[:'platform_specific_data']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -191,11 +207,7 @@ module Zernio
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
       end
 
-      if @questions.nil?
-        invalid_properties.push('invalid value for "questions", questions cannot be nil.')
-      end
-
-      if @questions.length < 1
+      if !@questions.nil? && @questions.length < 1
         invalid_properties.push('invalid value for "questions", number of items must be greater than or equal to 1.')
       end
 
@@ -217,8 +229,7 @@ module Zernio
       return false if @account_id.nil?
       return false if @name.nil?
       return false if @name.to_s.length > 200
-      return false if @questions.nil?
-      return false if @questions.length < 1
+      return false if !@questions.nil? && @questions.length < 1
       return false if @privacy_policy_url.nil?
       return false if !@privacy_policy_link_text.nil? && @privacy_policy_link_text.to_s.length > 70
       true
@@ -303,7 +314,8 @@ module Zernio
           thank_you_button_text == o.thank_you_button_text &&
           thank_you_button_type == o.thank_you_button_type &&
           thank_you_website_url == o.thank_you_website_url &&
-          is_optimized_for_quality == o.is_optimized_for_quality
+          is_optimized_for_quality == o.is_optimized_for_quality &&
+          platform_specific_data == o.platform_specific_data
     end
 
     # @see the `==` method
@@ -315,7 +327,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_id, name, questions, privacy_policy_url, privacy_policy_link_text, follow_up_action_url, locale, thank_you_title, thank_you_body, thank_you_button_text, thank_you_button_type, thank_you_website_url, is_optimized_for_quality].hash
+      [account_id, name, questions, privacy_policy_url, privacy_policy_link_text, follow_up_action_url, locale, thank_you_title, thank_you_body, thank_you_button_text, thank_you_button_type, thank_you_website_url, is_optimized_for_quality, platform_specific_data].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,105 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+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
+  # Form content; the shape is selected by the accountId's platform. Unknown fields are a 400 (strict-parsed).
+  module CreateLeadFormRequestPlatformSpecificData
+    class << self
+      # List of class defined in oneOf (OpenAPI v3)
+      def openapi_one_of
+        [
+          :'LinkedInLeadFormPlatformData',
+          :'MetaLeadFormPlatformData'
+        ]
+      end
+
+      # Builds the object
+      # @param [Mixed] Data to be matched against the list of oneOf items
+      # @return [Object] Returns the model or the data itself
+      def build(data)
+        # Go through the list of oneOf items and attempt to identify the appropriate one.
+        # Note:
+        # - We do not attempt to check whether exactly one item matches.
+        # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+        #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+        # - TODO: scalar values are de facto behaving as if they were nullable.
+        # - TODO: logging when debugging is set.
+        openapi_one_of.each do |klass|
+          begin
+            next if klass == :AnyType # "nullable: true"
+            return find_and_cast_into_type(klass, data)
+          rescue # rescue all errors so we keep iterating even if the current item lookup raises
+          end
+        end
+
+        openapi_one_of.include?(:AnyType) ? data : nil
+      end
+
+      private
+
+      SchemaMismatchError = Class.new(StandardError)
+
+      # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
+      def find_and_cast_into_type(klass, data)
+        return if data.nil?
+
+        case klass.to_s
+        when 'Boolean'
+          return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+        when 'Float'
+          return data if data.instance_of?(Float)
+        when 'Integer'
+          return data if data.instance_of?(Integer)
+        when 'Time'
+          return Time.parse(data)
+        when 'Date'
+          return Date.iso8601(data)
+        when 'String'
+          return data if data.instance_of?(String)
+        when 'Object' # "type: object"
+          return data if data.instance_of?(Hash)
+        when /\AArray<(?<sub_type>.+)>\z/ # "type: array"
+          if data.instance_of?(Array)
+            sub_type = Regexp.last_match[:sub_type]
+            return data.map { |item| find_and_cast_into_type(sub_type, item) }
+          end
+        when /\AHash<String, (?<sub_type>.+)>\z/ # "type: object" with "additionalProperties: { ... }"
+          if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+            sub_type = Regexp.last_match[:sub_type]
+            return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+          end
+        else # model
+          const = Zernio.const_get(klass)
+          if const
+            if const.respond_to?(:openapi_one_of) # nested oneOf model
+              model = const.build(data)
+              return model if model
+            else
+              # raise if data contains keys that are not known to the model
+              raise if const.respond_to?(:acceptable_attributes) && !(data.keys - const.acceptable_attributes).empty?
+              model = const.build_from_hash(data)
+              return model if model
+            end
+          end
+        end
+
+        raise # if no match by now, raise
+      rescue
+        raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+      end
+    end
+  end
+
+end