late-sdk 0.0.888 → 0.0.890

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a83427f1872fe2252d1f723cdfb3d2a59fddc4c4856b05fdb0f011fee2243ada
-  data.tar.gz: 1457d5205407e5abf9202595287176c9b48a77556a963082398397399d37387a
+  metadata.gz: b5276c61a7a83ea4f82d665041d6dd5e6d2bafdbadaa9db3ec83713b6bc68362
+  data.tar.gz: 6ce9ffb1852bf974f33503512edebe0dd3ec0c1f0cb656a4f8710e584c23d560
 SHA512:
-  metadata.gz: ec90eb31ba88acd4984cba382d1b5a149b735b5a36c9d76a3b54868a31b9d0903bd1bd8f9aa26a79af81dafc9939a87b9607cf4d43ffea3e72523097a2a3e183
-  data.tar.gz: 4596258907db67701384571a8a34e092fffef4bd8ecd8c6b2df2036133fb11e9e8f60a5cecdb0fd61eefbc2495a7517a57ede1d59febd4b54f1c79183020ffe4
+  metadata.gz: e94acf7ce1317ccc976cab938c2170a876652d47bb1af2934463d8e8a8e36efc3c080fab89c7eb4e3bee02e23ad00a2fc6dcb1dc4065c3b87049112991507c07
+  data.tar.gz: 5c90400f53199e0d595f6dc016436524bbb98f3464d1f51f20d2b7a76bdce3699453cdf6180d76bc53a13bbb27c820da22590c95d6ed40cbb128836c7051fb3c

data/docs/AdAudiencesApi.md

@@ -33,7 +33,7 @@ Zernio.configure do |config|
 end
 
 api_instance = Zernio::AdAudiencesApi.new
-audience_id = 'audience_id_example' # String | 
+audience_id = 'audience_id_example' # String | The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
 add_users_to_ad_audience_request = Zernio::AddUsersToAdAudienceRequest.new({users: [Zernio::AddUsersToAdAudienceRequestUsersInner.new]}) # AddUsersToAdAudienceRequest | 
 
 begin
@@ -67,7 +67,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **audience_id** | **String** |  |  |
+| **audience_id** | **String** | The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id. |  |
 | **add_users_to_ad_audience_request** | [**AddUsersToAdAudienceRequest**](AddUsersToAdAudienceRequest.md) |  |  |
 
 ### Return type
@@ -242,7 +242,7 @@ Zernio.configure do |config|
 end
 
 api_instance = Zernio::AdAudiencesApi.new
-audience_id = 'audience_id_example' # String | 
+audience_id = 'audience_id_example' # String | The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
 
 begin
   # Get audience details
@@ -275,7 +275,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **audience_id** | **String** |  |  |
+| **audience_id** | **String** | The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id. |  |
 
 ### Return type
 
@@ -388,7 +388,7 @@ Zernio.configure do |config|
 end
 
 api_instance = Zernio::AdAudiencesApi.new
-audience_id = 'audience_id_example' # String | 
+audience_id = 'audience_id_example' # String | The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
 replace_ad_audience_companies_request = Zernio::ReplaceAdAudienceCompaniesRequest.new({companies: [Zernio::ReplaceAdAudienceCompaniesRequestCompaniesInner.new]}) # ReplaceAdAudienceCompaniesRequest | 
 
 begin
@@ -422,7 +422,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **audience_id** | **String** |  |  |
+| **audience_id** | **String** | The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id. |  |
 | **replace_ad_audience_companies_request** | [**ReplaceAdAudienceCompaniesRequest**](ReplaceAdAudienceCompaniesRequest.md) |  |  |
 
 ### Return type

data/docs/GetAdAudience200Response.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **audience** | **Object** |  | [optional] |
-| **meta_data** | **Object** | Fresh data from Meta API | [optional] |
+| **platform_data** | **Object** | Fresh data from the platform API | [optional] |
 
 ## Example
 
@@ -14,7 +14,7 @@ require 'zernio-sdk'
 
 instance = Zernio::GetAdAudience200Response.new(
   audience: null,
-  meta_data: null
+  platform_data: null
 )
 ```
 

data/docs/ListAdAudiences200ResponseAudiencesInner.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  | [optional] |
+| **id** | **String** | The Zernio audience id. Pass this as audienceId on GET /v1/ads/audiences/{audienceId} and the companies/users upload endpoints. Null when the audience was not created through Zernio. | [optional] |
 | **account_id** | **String** | Account the audience was created against. Returned for saved_targeting items. | [optional] |
 | **platform_audience_id** | **String** |  | [optional] |
 | **name** | **String** |  | [optional] |

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

@@ -21,7 +21,7 @@ module Zernio
     end
     # Add users to audience
     # Upload user data to a customer_list audience. Data is SHA256-hashed server-side before sending to the platform. Email is used on every platform; phone is used on Meta only (other platforms ignore it). On TikTok and Pinterest, the first upload also provisions the audience (deferred create). LinkedIn uploads are full-replace. Max 10,000 users per request.  customer_list only. A LinkedIn `company_list` audience takes company rows, not people: send those to `POST /v1/ads/audiences/{audienceId}/companies`. This endpoint 422s for every other audience type. 
-    # @param audience_id [String] 
+    # @param audience_id [String] The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
     # @param add_users_to_ad_audience_request [AddUsersToAdAudienceRequest] 
     # @param [Hash] opts the optional parameters
     # @return [AddUsersToAdAudience200Response]
@@ -32,7 +32,7 @@ module Zernio
 
     # Add users to audience
     # Upload user data to a customer_list audience. Data is SHA256-hashed server-side before sending to the platform. Email is used on every platform; phone is used on Meta only (other platforms ignore it). On TikTok and Pinterest, the first upload also provisions the audience (deferred create). LinkedIn uploads are full-replace. Max 10,000 users per request.  customer_list only. A LinkedIn `company_list` audience takes company rows, not people: send those to `POST /v1/ads/audiences/{audienceId}/companies`. This endpoint 422s for every other audience type. 
-    # @param audience_id [String] 
+    # @param audience_id [String] The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
     # @param add_users_to_ad_audience_request [AddUsersToAdAudienceRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(AddUsersToAdAudience200Response, Integer, Hash)>] AddUsersToAdAudience200Response data, response status code and response headers
@@ -226,7 +226,7 @@ module Zernio
 
     # Get audience details
     # Returns the local audience record and fresh data from Meta (if available).
-    # @param audience_id [String] 
+    # @param audience_id [String] The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
     # @param [Hash] opts the optional parameters
     # @return [GetAdAudience200Response]
     def get_ad_audience(audience_id, opts = {})
@@ -236,7 +236,7 @@ module Zernio
 
     # Get audience details
     # Returns the local audience record and fresh data from Meta (if available).
-    # @param audience_id [String] 
+    # @param audience_id [String] The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
     # @param [Hash] opts the optional parameters
     # @return [Array<(GetAdAudience200Response, Integer, Hash)>] GetAdAudience200Response data, response status code and response headers
     def get_ad_audience_with_http_info(audience_id, opts = {})
@@ -374,7 +374,7 @@ module Zernio
 
     # Replace audience companies
     # Upload the company rows of a LinkedIn `company_list` audience (account-based marketing). LinkedIn-only, every other platform returns 422.  A LinkedIn audience segment holds exactly one uploaded list, so the list you send here REPLACES the segment's list instead of being appended to it: always send the full set of companies. LinkedIn returns only the identifier of the uploaded file, never its rows, so the merge cannot be done for you, keep the source list on your side.  How the matching behaves:  - Rows are plain text (not hashed), matched against LinkedIn's own company graph. - Matching is asynchronous: LinkedIn takes up to 48h for a new audience and up to 24h for a   later update, and the audience stays `processing` meanwhile. - LinkedIn does not document how quickly companies dropped from the list stop being targeted,   so treat removals as eventual rather than immediate. - LinkedIn recommends at least 1,000 companies for a usable match rate, and caps a list at   300,000.  The initial list is sent with `companies` on `POST /v1/ads/audiences`; this endpoint is for every change after that. 
-    # @param audience_id [String] 
+    # @param audience_id [String] The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
     # @param replace_ad_audience_companies_request [ReplaceAdAudienceCompaniesRequest] 
     # @param [Hash] opts the optional parameters
     # @return [ReplaceAdAudienceCompanies200Response]
@@ -385,7 +385,7 @@ module Zernio
 
     # Replace audience companies
     # Upload the company rows of a LinkedIn &#x60;company_list&#x60; audience (account-based marketing). LinkedIn-only, every other platform returns 422.  A LinkedIn audience segment holds exactly one uploaded list, so the list you send here REPLACES the segment&#39;s list instead of being appended to it: always send the full set of companies. LinkedIn returns only the identifier of the uploaded file, never its rows, so the merge cannot be done for you, keep the source list on your side.  How the matching behaves:  - Rows are plain text (not hashed), matched against LinkedIn&#39;s own company graph. - Matching is asynchronous: LinkedIn takes up to 48h for a new audience and up to 24h for a   later update, and the audience stays &#x60;processing&#x60; meanwhile. - LinkedIn does not document how quickly companies dropped from the list stop being targeted,   so treat removals as eventual rather than immediate. - LinkedIn recommends at least 1,000 companies for a usable match rate, and caps a list at   300,000.  The initial list is sent with &#x60;companies&#x60; on &#x60;POST /v1/ads/audiences&#x60;; this endpoint is for every change after that. 
-    # @param audience_id [String] 
+    # @param audience_id [String] The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
     # @param replace_ad_audience_companies_request [ReplaceAdAudienceCompaniesRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(ReplaceAdAudienceCompanies200Response, Integer, Hash)>] ReplaceAdAudienceCompanies200Response data, response status code and response headers

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

@@ -17,14 +17,14 @@ module Zernio
   class GetAdAudience200Response < ApiModelBase
     attr_accessor :audience
 
-    # Fresh data from Meta API
-    attr_accessor :meta_data
+    # Fresh data from the platform API
+    attr_accessor :platform_data
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'audience' => :'audience',
-        :'meta_data' => :'metaData'
+        :'platform_data' => :'platformData'
       }
     end
 
@@ -42,14 +42,14 @@ module Zernio
     def self.openapi_types
       {
         :'audience' => :'Object',
-        :'meta_data' => :'Object'
+        :'platform_data' => :'Object'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'meta_data'
+        :'platform_data'
       ])
     end
 
@@ -73,8 +73,8 @@ module Zernio
         self.audience = attributes[:'audience']
       end
 
-      if attributes.key?(:'meta_data')
-        self.meta_data = attributes[:'meta_data']
+      if attributes.key?(:'platform_data')
+        self.platform_data = attributes[:'platform_data']
       end
     end
 
@@ -99,7 +99,7 @@ module Zernio
       return true if self.equal?(o)
       self.class == o.class &&
           audience == o.audience &&
-          meta_data == o.meta_data
+          platform_data == o.platform_data
     end
 
     # @see the `==` method
@@ -111,7 +111,7 @@ module Zernio
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [audience, meta_data].hash
+      [audience, platform_data].hash
     end
 
     # Builds the object from hash

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

@@ -15,6 +15,7 @@ require 'time'
 
 module Zernio
   class ListAdAudiences200ResponseAudiencesInner < ApiModelBase
+    # The Zernio audience id. Pass this as audienceId on GET /v1/ads/audiences/{audienceId} and the companies/users upload endpoints. Null when the audience was not created through Zernio.
     attr_accessor :id
 
     # Account the audience was created against. Returned for saved_targeting items.

data/lib/zernio-sdk/version.rb

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

data/openapi.yaml

@@ -49129,7 +49129,7 @@ paths:
                     items:
                       type: object
                       properties:
-                        id: { type: [string, "null"] }
+                        id: { type: [string, "null"], description: "The Zernio audience id. Pass this as audienceId on GET /v1/ads/audiences/{audienceId} and the companies/users upload endpoints. Null when the audience was not created through Zernio." }
                         accountId: { type: string, description: "Account the audience was created against. Returned for saved_targeting items." }
                         platformAudienceId: { type: string }
                         name: { type: string }
@@ -49347,7 +49347,7 @@ paths:
       security:
         - bearerAuth: []
       parameters:
-        - { name: audienceId, in: path, required: true, schema: { type: string } }
+        - { name: audienceId, in: path, required: true, schema: { type: string }, description: "The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id." }
       responses:
         '200':
           description: Audience details
@@ -49357,7 +49357,7 @@ paths:
                 type: object
                 properties:
                   audience: { type: object }
-                  metaData: { type: [object, "null"], description: Fresh data from Meta API }
+                  platformData: { type: [object, "null"], description: Fresh data from the platform API }
         '401': { $ref: '#/components/responses/Unauthorized' }
         '403':
           description: Ads access required. Legacy plans need the Ads add-on; included by default on usage-based plans.
@@ -49455,7 +49455,7 @@ paths:
       security:
         - bearerAuth: []
       parameters:
-        - { name: audienceId, in: path, required: true, schema: { type: string } }
+        - { name: audienceId, in: path, required: true, schema: { type: string }, description: "The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id." }
       requestBody:
         required: true
         content:
@@ -49524,7 +49524,7 @@ paths:
       security:
         - bearerAuth: []
       parameters:
-        - { name: audienceId, in: path, required: true, schema: { type: string } }
+        - { name: audienceId, in: path, required: true, schema: { type: string }, description: "The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id." }
       requestBody:
         required: true
         content:

data/spec/api/ad_audiences_api_spec.rb

@@ -35,7 +35,7 @@ describe 'AdAudiencesApi' do
   # unit tests for add_users_to_ad_audience
   # Add users to audience
   # Upload user data to a customer_list audience. Data is SHA256-hashed server-side before sending to the platform. Email is used on every platform; phone is used on Meta only (other platforms ignore it). On TikTok and Pinterest, the first upload also provisions the audience (deferred create). LinkedIn uploads are full-replace. Max 10,000 users per request.  customer_list only. A LinkedIn `company_list` audience takes company rows, not people: send those to `POST /v1/ads/audiences/{audienceId}/companies`. This endpoint 422s for every other audience type. 
-  # @param audience_id 
+  # @param audience_id The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
   # @param add_users_to_ad_audience_request 
   # @param [Hash] opts the optional parameters
   # @return [AddUsersToAdAudience200Response]
@@ -72,7 +72,7 @@ describe 'AdAudiencesApi' do
   # unit tests for get_ad_audience
   # Get audience details
   # Returns the local audience record and fresh data from Meta (if available).
-  # @param audience_id 
+  # @param audience_id The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
   # @param [Hash] opts the optional parameters
   # @return [GetAdAudience200Response]
   describe 'get_ad_audience test' do
@@ -99,7 +99,7 @@ describe 'AdAudiencesApi' do
   # unit tests for replace_ad_audience_companies
   # Replace audience companies
   # Upload the company rows of a LinkedIn `company_list` audience (account-based marketing). LinkedIn-only, every other platform returns 422.  A LinkedIn audience segment holds exactly one uploaded list, so the list you send here REPLACES the segment's list instead of being appended to it: always send the full set of companies. LinkedIn returns only the identifier of the uploaded file, never its rows, so the merge cannot be done for you, keep the source list on your side.  How the matching behaves:  - Rows are plain text (not hashed), matched against LinkedIn's own company graph. - Matching is asynchronous: LinkedIn takes up to 48h for a new audience and up to 24h for a   later update, and the audience stays `processing` meanwhile. - LinkedIn does not document how quickly companies dropped from the list stop being targeted,   so treat removals as eventual rather than immediate. - LinkedIn recommends at least 1,000 companies for a usable match rate, and caps a list at   300,000.  The initial list is sent with `companies` on `POST /v1/ads/audiences`; this endpoint is for every change after that. 
-  # @param audience_id 
+  # @param audience_id The Zernio audience id (the id field of GET /v1/ads/audiences), not the platform segment id.
   # @param replace_ad_audience_companies_request 
   # @param [Hash] opts the optional parameters
   # @return [ReplaceAdAudienceCompanies200Response]

data/spec/models/get_ad_audience200_response_spec.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: late-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.888
+  version: 0.0.890
 platform: ruby
 authors:
 - OpenAPI-Generator
@@ -6067,7 +6067,7 @@ files:
 - spec/models/you_tube_video_retention_response_retention_curve_inner_spec.rb
 - spec/models/you_tube_video_retention_response_spec.rb
 - spec/spec_helper.rb
-- zernio-sdk-0.0.888.gem
+- zernio-sdk-0.0.890.gem
 - zernio-sdk.gemspec
 homepage: https://openapi-generator.tech
 licenses: