dub 0.2.2.pre.alpha.21 → 0.2.2.pre.alpha.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3fc289b1e4ca8721911a3322074c9594c5df9eb7af9e2b78daeaca51f0b28f8
-  data.tar.gz: 9ec461c74ca929e572ce8af203d6c80ae40c2ec516388278b60f36247aa51e00
+  metadata.gz: ccb1c86c2e65464aab0473ef98e3404cefab59caddccb8cb79ad13444997efe6
+  data.tar.gz: 9881d34f2aef4350e829690a160b680b6886d9d394335cffc46a269e8c8c2987
 SHA512:
-  metadata.gz: c8f26cd98054db948758b3c2eeee25548209c70d231f3735786de967259a1f9e6b0a5e5a4b047aa9db843ed90ea85fcf89cab0b6d21abcdbbf2b802ae3fad19b
-  data.tar.gz: 5fe2dadcc7cfb2a8b37cef8660ef975c1ae38be7b457af89e2db7937119f908ad8d3250ac090355e52b766300d912966677659d9ea320b30434869323bab4574
+  metadata.gz: db8ba20e8211ccd63b4bda1343133d0cc37eecd8592171306a9776918e6651ebd32c270159b1ef56f48ef82ab219653c6c570647e9be31295144f4caa48f1ec6
+  data.tar.gz: baa5c15fa14a6401e01b43d7c7e74da09e6875aa6e8b8a7e65ea7030b84db1e9794c8ccb79671264fa60d6729eb9a6ed0b726c55bbdc54e4117492f31625a0a7

data/lib/open_api_sdk/models/operations/event.rb

@@ -7,7 +7,7 @@
 module OpenApiSDK
   module Operations
   
-    # Event - The type of event to retrieve analytics for. Defaults to 'clicks'.
+    # Event - The type of event to retrieve analytics for. Defaults to `clicks`.
     class Event < T::Enum
       enums do
         CLICKS = new('clicks')

data/lib/open_api_sdk/models/operations/getqrcode_request.rb

@@ -17,21 +17,27 @@ module OpenApiSDK
       field :bg_color, T.nilable(::String), { 'query_param': { 'field_name': 'bgColor', 'style': 'form', 'explode': true } }
       # The foreground color of the QR code in hex format. Defaults to `#000000` if not provided.
       field :fg_color, T.nilable(::String), { 'query_param': { 'field_name': 'fgColor', 'style': 'form', 'explode': true } }
+      # Whether to hide the logo in the QR code. Can only be used with a paid plan on Dub.co.
+      field :hide_logo, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'hideLogo', 'style': 'form', 'explode': true } }
       # Whether to include a margin around the QR code. Defaults to `false` if not provided.
       field :include_margin, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeMargin', 'style': 'form', 'explode': true } }
       # The level of error correction to use for the QR code. Defaults to `L` if not provided.
       field :level, T.nilable(::OpenApiSDK::Operations::Level), { 'query_param': { 'field_name': 'level', 'style': 'form', 'explode': true } }
+      # The logo to include in the QR code. Can only be used with a paid plan on Dub.co.
+      field :logo, T.nilable(::String), { 'query_param': { 'field_name': 'logo', 'style': 'form', 'explode': true } }
       # The size of the QR code in pixels. Defaults to `600` if not provided.
       field :size, T.nilable(::Float), { 'query_param': { 'field_name': 'size', 'style': 'form', 'explode': true } }
 
 
-      sig { params(url: ::String, bg_color: T.nilable(::String), fg_color: T.nilable(::String), include_margin: T.nilable(T::Boolean), level: T.nilable(::OpenApiSDK::Operations::Level), size: T.nilable(::Float)).void }
-      def initialize(url: nil, bg_color: nil, fg_color: nil, include_margin: nil, level: nil, size: nil)
+      sig { params(url: ::String, bg_color: T.nilable(::String), fg_color: T.nilable(::String), hide_logo: T.nilable(T::Boolean), include_margin: T.nilable(T::Boolean), level: T.nilable(::OpenApiSDK::Operations::Level), logo: T.nilable(::String), size: T.nilable(::Float)).void }
+      def initialize(url: nil, bg_color: nil, fg_color: nil, hide_logo: nil, include_margin: nil, level: nil, logo: nil, size: nil)
         @url = url
         @bg_color = bg_color
         @fg_color = fg_color
+        @hide_logo = hide_logo
         @include_margin = include_margin
         @level = level
+        @logo = logo
         @size = size
       end
     end

data/lib/open_api_sdk/models/operations/groupby.rb

@@ -7,7 +7,7 @@
 module OpenApiSDK
   module Operations
   
-    # GroupBy - The parameter to group the analytics data points by. Defaults to 'count' if undefined.
+    # GroupBy - The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
     class GroupBy < T::Enum
       enums do
         COUNT = new('count')
@@ -18,11 +18,12 @@ module OpenApiSDK
         DEVICES = new('devices')
         BROWSERS = new('browsers')
         OS = new('os')
+        TRIGGER = new('trigger')
+        TRIGGERS = new('triggers')
         REFERERS = new('referers')
         REFERER_URLS = new('referer_urls')
         TOP_LINKS = new('top_links')
         TOP_URLS = new('top_urls')
-        TRIGGER = new('trigger')
       end
     end
   end

data/lib/open_api_sdk/models/operations/listevents_request.rb

@@ -43,7 +43,7 @@ module OpenApiSDK
       field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
 
       field :page, T.nilable(::Float), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
-      # Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
+      # Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
       field :qr, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'qr', 'style': 'form', 'explode': true } }
       # The referer to retrieve analytics for.
       field :referer, T.nilable(::String), { 'query_param': { 'field_name': 'referer', 'style': 'form', 'explode': true } }
@@ -59,12 +59,14 @@ module OpenApiSDK
       field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
       # The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
       field :timezone, T.nilable(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
+      # The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+      field :trigger, T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
       # The URL to retrieve analytics for.
       field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
 
 
-      sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::QueryParamEvent), external_id: T.nilable(::String), interval: T.nilable(::OpenApiSDK::Operations::QueryParamInterval), key: T.nilable(::String), limit: T.nilable(::Float), link_id: T.nilable(::String), order: T.nilable(::OpenApiSDK::Operations::Order), os: T.nilable(::String), page: T.nilable(::Float), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::SortBy), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), url: T.nilable(::String)).void }
-      def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, interval: nil, key: nil, limit: nil, link_id: nil, order: nil, os: nil, page: nil, qr: nil, referer: nil, referer_url: nil, root: nil, sort_by: nil, start: nil, tag_id: nil, timezone: nil, url: nil)
+      sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::QueryParamEvent), external_id: T.nilable(::String), interval: T.nilable(::OpenApiSDK::Operations::QueryParamInterval), key: T.nilable(::String), limit: T.nilable(::Float), link_id: T.nilable(::String), order: T.nilable(::OpenApiSDK::Operations::Order), os: T.nilable(::String), page: T.nilable(::Float), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::SortBy), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), url: T.nilable(::String)).void }
+      def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, interval: nil, key: nil, limit: nil, link_id: nil, order: nil, os: nil, page: nil, qr: nil, referer: nil, referer_url: nil, root: nil, sort_by: nil, start: nil, tag_id: nil, timezone: nil, trigger: nil, url: nil)
         @browser = browser
         @city = city
         @continent = continent
@@ -89,6 +91,7 @@ module OpenApiSDK
         @start = start
         @tag_id = tag_id
         @timezone = timezone
+        @trigger = trigger
         @url = url
       end
     end

data/lib/open_api_sdk/models/operations/queryparam_trigger.rb

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+    # QueryParamTrigger - The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+    class QueryParamTrigger < T::Enum
+      enums do
+        QR = new('qr')
+        LINK = new('link')
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb

@@ -25,11 +25,11 @@ module OpenApiSDK
       field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
       # The end date and time when to retrieve analytics from. If not provided, defaults to the current date.
       field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
-      # The type of event to retrieve analytics for. Defaults to 'clicks'.
+      # The type of event to retrieve analytics for. Defaults to `clicks`.
       field :event, T.nilable(::OpenApiSDK::Operations::Event), { 'query_param': { 'field_name': 'event', 'style': 'form', 'explode': true } }
       # This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
       field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
-      # The parameter to group the analytics data points by. Defaults to 'count' if undefined.
+      # The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
       field :group_by, T.nilable(::OpenApiSDK::Operations::GroupBy), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
       # The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
       field :interval, T.nilable(::OpenApiSDK::Operations::Interval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
@@ -39,7 +39,7 @@ module OpenApiSDK
       field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
       # The OS to retrieve analytics for.
       field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
-      # Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
+      # Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
       field :qr, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'qr', 'style': 'form', 'explode': true } }
       # The referer to retrieve analytics for.
       field :referer, T.nilable(::String), { 'query_param': { 'field_name': 'referer', 'style': 'form', 'explode': true } }
@@ -53,12 +53,14 @@ module OpenApiSDK
       field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
       # The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
       field :timezone, T.nilable(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
+      # The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+      field :trigger, T.nilable(::OpenApiSDK::Operations::Trigger), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
       # The URL to retrieve analytics for.
       field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
 
 
-      sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), url: T.nilable(::String)).void }
-      def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, qr: nil, referer: nil, referer_url: nil, root: nil, start: nil, tag_id: nil, timezone: nil, url: nil)
+      sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::Trigger), url: T.nilable(::String)).void }
+      def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, qr: nil, referer: nil, referer_url: nil, root: nil, start: nil, tag_id: nil, timezone: nil, trigger: nil, url: nil)
         @browser = browser
         @city = city
         @continent = continent
@@ -80,6 +82,7 @@ module OpenApiSDK
         @start = start
         @tag_id = tag_id
         @timezone = timezone
+        @trigger = trigger
         @url = url
       end
     end

data/lib/open_api_sdk/models/operations/trigger.rb

@@ -0,0 +1,18 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+    # Trigger - The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
+    class Trigger < T::Enum
+      enums do
+        QR = new('qr')
+        LINK = new('link')
+      end
+    end
+  end
+end

data/lib/open_api_sdk/models/operations.rb

@@ -36,10 +36,12 @@ module OpenApiSDK
     autoload :Event, 'open_api_sdk/models/operations/event.rb'
     autoload :GroupBy, 'open_api_sdk/models/operations/groupby.rb'
     autoload :Interval, 'open_api_sdk/models/operations/interval.rb'
+    autoload :Trigger, 'open_api_sdk/models/operations/trigger.rb'
     autoload :RetrieveAnalyticsRequest, 'open_api_sdk/models/operations/retrieveanalytics_request.rb'
     autoload :RetrieveAnalyticsResponse, 'open_api_sdk/models/operations/retrieveanalytics_response.rb'
     autoload :QueryParamEvent, 'open_api_sdk/models/operations/queryparam_event.rb'
     autoload :QueryParamInterval, 'open_api_sdk/models/operations/queryparam_interval.rb'
+    autoload :QueryParamTrigger, 'open_api_sdk/models/operations/queryparam_trigger.rb'
     autoload :Order, 'open_api_sdk/models/operations/order.rb'
     autoload :SortBy, 'open_api_sdk/models/operations/sortby.rb'
     autoload :ListEventsRequest, 'open_api_sdk/models/operations/listevents_request.rb'

data/lib/open_api_sdk/sdkconfiguration.rb

@@ -38,9 +38,9 @@ module OpenApiSDK
       @security = security
       @language = 'ruby'
       @openapi_doc_version = '0.0.1'
-      @sdk_version = '0.2.2-alpha.21'
-      @gen_version = '2.428.1'
-      @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.21 2.428.1 0.0.1 dub'
+      @sdk_version = '0.2.2-alpha.22'
+      @gen_version = '2.429.0'
+      @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.22 2.429.0 0.0.1 dub'
     end
 
     sig { returns([String, T::Hash[Symbol, String]]) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dub
 version: !ruby/object:Gem::Version
-  version: 0.2.2.pre.alpha.21
+  version: 0.2.2.pre.alpha.22
 platform: ruby
 authors:
 - Dub
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -201,6 +201,7 @@ files:
 - lib/open_api_sdk/models/operations/paymentprocessor.rb
 - lib/open_api_sdk/models/operations/queryparam_event.rb
 - lib/open_api_sdk/models/operations/queryparam_interval.rb
+- lib/open_api_sdk/models/operations/queryparam_trigger.rb
 - lib/open_api_sdk/models/operations/requestbody.rb
 - lib/open_api_sdk/models/operations/retrieveanalytics_request.rb
 - lib/open_api_sdk/models/operations/retrieveanalytics_response.rb
@@ -217,6 +218,7 @@ files:
 - lib/open_api_sdk/models/operations/tracksale_requestbody.rb
 - lib/open_api_sdk/models/operations/tracksale_response.rb
 - lib/open_api_sdk/models/operations/tracksale_responsebody.rb
+- lib/open_api_sdk/models/operations/trigger.rb
 - lib/open_api_sdk/models/operations/updatedomain_request.rb
 - lib/open_api_sdk/models/operations/updatedomain_requestbody.rb
 - lib/open_api_sdk/models/operations/updatedomain_response.rb