late-sdk 0.0.1593 → 0.0.1594

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 347274c41fe1b389f46a58b959d0aa33bcaf5ddecea9ec96c93f9f6522591435
-  data.tar.gz: c7b7b0b5c6b1fe6124fb500d7e214882c4e7d8b20a6eafa59017acb59b63774d
+  metadata.gz: 491af4c0475c70373f4bb443fbbae5eb791c73de2a2975e7c4dda592b6213eb3
+  data.tar.gz: 98cbf40e5d1f7aadf0d0aa1aa78b8d6c9c286337f3d113ea08f0c19e5d775553
 SHA512:
-  metadata.gz: db5ddf675a7f721a191353c6c01d81bc4e78e12622abe4de52eab41c4e94526eaed070097c6c761b8de0fc7cc101835ccc4cc1d5382d2af9788a2e8c764bb5a0
-  data.tar.gz: 8119f098e8ce0213937d510fb0c4589fc25f240ebf98cb2d5fc13f1f4f67f9e6eebf7c72c66ba133e4dc53fbc21b04671455c0418e8614e28faaaf519ead1214
+  metadata.gz: 0e9782d62875cf7a02d78dd1f24725eb613db72065d0febd8127b025e71420c0484b4fe174487f3b2a6422e1c119aa362db98c3732563a311ce2362d55bc8940
+  data.tar.gz: 2b0e7be4f0da9790975975eff6b2c7797d7643f48e1b722288035f6a4e7c98d8a6dce06ceccb637fd10e85dd9fe6445346bb50b09e6b795066581eb50da59b6a

data/README.md

@@ -650,6 +650,7 @@ Class | Method | HTTP request | Description
 *Zernio::ConversionsApi* | [**list_conversion_destinations**](docs/ConversionsApi.md#list_conversion_destinations) | **GET** /v1/accounts/{accountId}/conversion-destinations | List conversion destinations
 *Zernio::ConversionsApi* | [**list_custom_conversion_goals**](docs/ConversionsApi.md#list_custom_conversion_goals) | **GET** /v1/ads/conversions/custom-goals | List custom conversion goals
 *Zernio::ConversionsApi* | [**list_event_destinations**](docs/ConversionsApi.md#list_event_destinations) | **GET** /v1/events/destinations | List event destinations
+*Zernio::ConversionsApi* | [**list_events**](docs/ConversionsApi.md#list_events) | **GET** /v1/events | List stored events
 *Zernio::ConversionsApi* | [**remove_conversion_associations**](docs/ConversionsApi.md#remove_conversion_associations) | **DELETE** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | Remove associated campaigns
 *Zernio::ConversionsApi* | [**remove_custom_conversion_goal**](docs/ConversionsApi.md#remove_custom_conversion_goal) | **DELETE** /v1/ads/conversions/custom-goals/{goalId} | Remove a custom conversion goal
 *Zernio::ConversionsApi* | [**send_conversions**](docs/ConversionsApi.md#send_conversions) | **POST** /v1/ads/conversions | Send conversion events
@@ -2826,6 +2827,10 @@ Class | Method | HTTP request | Description
  - [Zernio::ListEmailMessages200Response](docs/ListEmailMessages200Response.md)
  - [Zernio::ListEmailThreads200Response](docs/ListEmailThreads200Response.md)
  - [Zernio::ListEventDestinations200Response](docs/ListEventDestinations200Response.md)
+ - [Zernio::ListEvents200Response](docs/ListEvents200Response.md)
+ - [Zernio::ListEvents200ResponseEventsInner](docs/ListEvents200ResponseEventsInner.md)
+ - [Zernio::ListEvents200ResponseEventsInnerClickIds](docs/ListEvents200ResponseEventsInnerClickIds.md)
+ - [Zernio::ListEvents200ResponseEventsInnerUtm](docs/ListEvents200ResponseEventsInnerUtm.md)
  - [Zernio::ListFacebookPages200Response](docs/ListFacebookPages200Response.md)
  - [Zernio::ListFacebookPages200ResponsePagesInner](docs/ListFacebookPages200ResponsePagesInner.md)
  - [Zernio::ListFacebookTaggedPosts200Response](docs/ListFacebookTaggedPosts200Response.md)

data/docs/ConversionsApi.md

@@ -21,6 +21,7 @@ All URIs are relative to *https://zernio.com/api*
 | [**list_conversion_destinations**](ConversionsApi.md#list_conversion_destinations) | **GET** /v1/accounts/{accountId}/conversion-destinations | List conversion destinations |
 | [**list_custom_conversion_goals**](ConversionsApi.md#list_custom_conversion_goals) | **GET** /v1/ads/conversions/custom-goals | List custom conversion goals |
 | [**list_event_destinations**](ConversionsApi.md#list_event_destinations) | **GET** /v1/events/destinations | List event destinations |
+| [**list_events**](ConversionsApi.md#list_events) | **GET** /v1/events | List stored events |
 | [**remove_conversion_associations**](ConversionsApi.md#remove_conversion_associations) | **DELETE** /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations | Remove associated campaigns |
 | [**remove_custom_conversion_goal**](ConversionsApi.md#remove_custom_conversion_goal) | **DELETE** /v1/ads/conversions/custom-goals/{goalId} | Remove a custom conversion goal |
 | [**send_conversions**](ConversionsApi.md#send_conversions) | **POST** /v1/ads/conversions | Send conversion events |
@@ -1259,6 +1260,87 @@ end
 - **Accept**: application/json
 
 
+## list_events
+
+> <ListEvents200Response> list_events(profile_id, opts)
+
+List stored events
+
+Lists the conversion events stored for a profile by `POST /v1/events`, newest first. Personal data is never returned: `hasEmail`, `hasPhone` and `hasExternalId` only say whether the event carried that identifier. Events sent with `testCode` are not stored, so they never appear here.  Paginate with `cursor`: pass the `nextCursor` of the previous page until it comes back `null`. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zernio-sdk'
+# setup authorization
+Zernio.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Zernio::ConversionsApi.new
+profile_id = 'profile_id_example' # String | 
+opts = {
+  limit: 56, # Integer | 
+  from: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only events at or after this time (ISO 8601, on the event time).
+  to: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Only events before this time (ISO 8601, on the event time).
+  event_name: 'event_name_example', # String | Only events with this name, such as `Purchase`.
+  cursor: 'cursor_example' # String | `nextCursor` from the previous page.
+}
+
+begin
+  # List stored events
+  result = api_instance.list_events(profile_id, opts)
+  p result
+rescue Zernio::ApiError => e
+  puts "Error when calling ConversionsApi->list_events: #{e}"
+end
+```
+
+#### Using the list_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListEvents200Response>, Integer, Hash)> list_events_with_http_info(profile_id, opts)
+
+```ruby
+begin
+  # List stored events
+  data, status_code, headers = api_instance.list_events_with_http_info(profile_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListEvents200Response>
+rescue Zernio::ApiError => e
+  puts "Error when calling ConversionsApi->list_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **profile_id** | **String** |  |  |
+| **limit** | **Integer** |  | [optional][default to 50] |
+| **from** | **Time** | Only events at or after this time (ISO 8601, on the event time). | [optional] |
+| **to** | **Time** | Only events before this time (ISO 8601, on the event time). | [optional] |
+| **event_name** | **String** | Only events with this name, such as &#x60;Purchase&#x60;. | [optional] |
+| **cursor** | **String** | &#x60;nextCursor&#x60; from the previous page. | [optional] |
+
+### Return type
+
+[**ListEvents200Response**](ListEvents200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## remove_conversion_associations
 
 > <RemoveConversionAssociations200Response> remove_conversion_associations(account_id, destination_id, ad_account_id, campaign_ids)

data/docs/ListEvents200Response.md

@@ -0,0 +1,20 @@
+# Zernio::ListEvents200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<ListEvents200ResponseEventsInner>**](ListEvents200ResponseEventsInner.md) |  | [optional] |
+| **next_cursor** | **String** | Pass as `cursor` to get the next page; `null` on the last page. | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListEvents200Response.new(
+  events: null,
+  next_cursor: null
+)
+```
+

data/docs/ListEvents200ResponseEventsInner.md

@@ -0,0 +1,46 @@
+# Zernio::ListEvents200ResponseEventsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** |  | [optional] |
+| **event_name** | **String** |  | [optional] |
+| **event_time** | **Time** |  | [optional] |
+| **received_at** | **Time** |  | [optional] |
+| **action_source** | **String** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **currency** | **String** |  | [optional] |
+| **source_url** | **String** | Origin, path and attribution parameters only. | [optional] |
+| **utm** | [**ListEvents200ResponseEventsInnerUtm**](ListEvents200ResponseEventsInnerUtm.md) |  | [optional] |
+| **zrn** | **String** | Ad ID from the `zrn` parameter Zernio adds to links of ads it creates. | [optional] |
+| **click_ids** | [**ListEvents200ResponseEventsInnerClickIds**](ListEvents200ResponseEventsInnerClickIds.md) |  | [optional] |
+| **destinations_sent** | **Integer** | Destinations the event was forwarded to. | [optional] |
+| **has_email** | **Boolean** |  | [optional] |
+| **has_phone** | **Boolean** |  | [optional] |
+| **has_external_id** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListEvents200ResponseEventsInner.new(
+  event_id: null,
+  event_name: null,
+  event_time: null,
+  received_at: null,
+  action_source: null,
+  value: null,
+  currency: null,
+  source_url: null,
+  utm: null,
+  zrn: null,
+  click_ids: null,
+  destinations_sent: null,
+  has_email: null,
+  has_phone: null,
+  has_external_id: null
+)
+```
+

data/docs/ListEvents200ResponseEventsInnerClickIds.md

@@ -0,0 +1,20 @@
+# Zernio::ListEvents200ResponseEventsInnerClickIds
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gclid** | **String** |  | [optional] |
+| **fbc** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListEvents200ResponseEventsInnerClickIds.new(
+  gclid: null,
+  fbc: null
+)
+```
+

data/docs/ListEvents200ResponseEventsInnerUtm.md

@@ -0,0 +1,24 @@
+# Zernio::ListEvents200ResponseEventsInnerUtm
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source** | **String** |  | [optional] |
+| **medium** | **String** |  | [optional] |
+| **campaign** | **String** |  | [optional] |
+| **content** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zernio-sdk'
+
+instance = Zernio::ListEvents200ResponseEventsInnerUtm.new(
+  source: null,
+  medium: null,
+  campaign: null,
+  content: null
+)
+```
+

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

@@ -1262,6 +1262,93 @@ module Zernio
       return data, status_code, headers
     end
 
+    # List stored events
+    # Lists the conversion events stored for a profile by `POST /v1/events`, newest first. Personal data is never returned: `hasEmail`, `hasPhone` and `hasExternalId` only say whether the event carried that identifier. Events sent with `testCode` are not stored, so they never appear here.  Paginate with `cursor`: pass the `nextCursor` of the previous page until it comes back `null`. 
+    # @param profile_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Time] :from Only events at or after this time (ISO 8601, on the event time).
+    # @option opts [Time] :to Only events before this time (ISO 8601, on the event time).
+    # @option opts [String] :event_name Only events with this name, such as `Purchase`.
+    # @option opts [String] :cursor `nextCursor` from the previous page.
+    # @return [ListEvents200Response]
+    def list_events(profile_id, opts = {})
+      data, _status_code, _headers = list_events_with_http_info(profile_id, opts)
+      data
+    end
+
+    # List stored events
+    # Lists the conversion events stored for a profile by `POST /v1/events`, newest first. Personal data is never returned: `hasEmail`, `hasPhone` and `hasExternalId` only say whether the event carried that identifier. Events sent with `testCode` are not stored, so they never appear here.  Paginate with `cursor`: pass the `nextCursor` of the previous page until it comes back `null`. 
+    # @param profile_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit  (default to 50)
+    # @option opts [Time] :from Only events at or after this time (ISO 8601, on the event time).
+    # @option opts [Time] :to Only events before this time (ISO 8601, on the event time).
+    # @option opts [String] :event_name Only events with this name, such as `Purchase`.
+    # @option opts [String] :cursor `nextCursor` from the previous page.
+    # @return [Array<(ListEvents200Response, Integer, Hash)>] ListEvents200Response data, response status code and response headers
+    def list_events_with_http_info(profile_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ConversionsApi.list_events ...'
+      end
+      # verify the required parameter 'profile_id' is set
+      if @api_client.config.client_side_validation && profile_id.nil?
+        fail ArgumentError, "Missing the required parameter 'profile_id' when calling ConversionsApi.list_events"
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ConversionsApi.list_events, must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling ConversionsApi.list_events, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v1/events'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'profileId'] = profile_id
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+      query_params[:'eventName'] = opts[:'event_name'] if !opts[:'event_name'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ListEvents200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"ConversionsApi.list_events",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ConversionsApi#list_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Remove associated campaigns
     # Unlinks campaigns from a LinkedIn conversion rule so they stop tracking it.  Pass `adAccountId` and `campaignIds` as query parameters (`campaignIds` is comma-separated). The route also accepts a JSON body with the same fields for clients that prefer DELETE-with-body, but the documented surface is query-only because some SDK code generators (e.g. Python) collapse query + body parameters with the same name into a single kwarg. 
     # @param account_id [String] 

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

@@ -0,0 +1,160 @@
+=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).  Request ids: responses carry an X-Request-Id header with the id we log the request under. Quote it when reporting a problem. A valid x-request-id you send is reused as that id. 
+
+The version of the OpenAPI document: 1.384.0
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  class ListEvents200Response < ApiModelBase
+    attr_accessor :events
+
+    # Pass as `cursor` to get the next page; `null` on the last page.
+    attr_accessor :next_cursor
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'events' => :'events',
+        :'next_cursor' => :'nextCursor'
+      }
+    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
+      {
+        :'events' => :'Array<ListEvents200ResponseEventsInner>',
+        :'next_cursor' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'next_cursor'
+      ])
+    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::ListEvents200Response` 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::ListEvents200Response`. 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?(:'events')
+        if (value = attributes[:'events']).is_a?(Array)
+          self.events = value
+        end
+      end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      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 &&
+          events == o.events &&
+          next_cursor == o.next_cursor
+    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
+      [events, next_cursor].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