dub 0.2.2 → 0.3.0

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

@@ -1,4 +1,4 @@
-# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 
 # typed: true
 # frozen_string_literal: true
@@ -8,18 +8,18 @@ module OpenApiSDK
   module Operations
   
 
-    class RequestBody < ::OpenApiSDK::Utils::FieldAugmented
+    class RequestBody < ::Crystalline::FieldAugmented
       extend T::Sig
 
       # The destination URL of the short link.
       field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
       # The Android destination URL for the short link for Android device targeting.
       field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
-      # Whether the short link is archived.
+      # Whether the short link is archived. Defaults to `false` if not provided.
       field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
       # The comments for the short link.
       field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
-      # The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+      # The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
       field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
       # Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
       field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
@@ -29,25 +29,37 @@ module OpenApiSDK
       field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
       # The date and time when the short link will expire at.
       field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
-      # This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with `ext_` when passed as a query parameter.
+      # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
       field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
+      # The unique ID existing folder to assign the short link to.
+      field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
       # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
       field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
-      # The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+      # The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
       field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
       # The iOS destination URL for the short link for iOS device targeting.
       field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
       # The short link slug. If not provided, a random 7-character slug will be generated.
       field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
+      # The length of the short link slug. Defaults to 7 if not provided. When used with `prefix`, the total length of the key will be `prefix.length + keyLength`.
+      field :key_length, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('keyLength') } }
+      # The ID of the partner the short link is associated with.
+      field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } }
       # The password required to access the destination URL of the short link.
       field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
       # The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
       field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
-      # Whether the short link uses Custom Social Media Cards feature.
+      # The ID of the program the short link is associated with.
+      field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
+      # Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
       field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
-      # Whether the short link's stats are publicly accessible.
+      # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
+      # 
+      # @deprecated  true: This will be removed in a future release, please migrate away from it as soon as possible.
       field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
-      # Whether the short link uses link cloaking.
+      # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
+      field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
+      # Whether the short link uses link cloaking. Defaults to `false` if not provided.
       field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
       # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
       # 
@@ -57,14 +69,36 @@ module OpenApiSDK
       field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
       # The unique name of the tags assigned to the short link (case insensitive).
       field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
-      # The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
+      # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
+      field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
+      # The date and time when the tests were or will be completed.
+      field :test_completed_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testCompletedAt') } }
+      # The date and time when the tests started.
+      field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
+      # An array of A/B test URLs and the percentage of traffic to send to each URL.
+      field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::BulkCreateLinksTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
+      # The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
       field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
-      # Whether to track conversions for the short link.
+      # Whether to track conversions for the short link. Defaults to `false` if not provided.
       field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
+      # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
+      field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
+      # The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
+      field :utm_content, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_content') } }
+      # The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.
+      field :utm_medium, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_medium') } }
+      # The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.
+      field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
+      # The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
+      field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
+      # The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
+      field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
+      # An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
+      field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
 
 
-      sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean)).void }
-      def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil)
+      sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), folder_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), key_length: T.nilable(::Float), partner_id: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), test_completed_at: T.nilable(::String), test_started_at: T.nilable(::String), test_variants: T.nilable(T::Array[::OpenApiSDK::Operations::BulkCreateLinksTestVariants]), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
+      def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, folder_id: nil, geo: nil, image: nil, ios: nil, key: nil, key_length: nil, partner_id: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, test_completed_at: nil, test_started_at: nil, test_variants: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
         @url = url
         @android = android
         @archived = archived
@@ -75,20 +109,36 @@ module OpenApiSDK
         @expired_url = expired_url
         @expires_at = expires_at
         @external_id = external_id
+        @folder_id = folder_id
         @geo = geo
         @image = image
         @ios = ios
         @key = key
+        @key_length = key_length
+        @partner_id = partner_id
         @password = password
         @prefix = prefix
+        @program_id = program_id
         @proxy = proxy
         @public_stats = public_stats
+        @ref = ref
         @rewrite = rewrite
         @tag_id = tag_id
         @tag_ids = tag_ids
         @tag_names = tag_names
+        @tenant_id = tenant_id
+        @test_completed_at = test_completed_at
+        @test_started_at = test_started_at
+        @test_variants = test_variants
         @title = title
         @track_conversion = track_conversion
+        @utm_campaign = utm_campaign
+        @utm_content = utm_content
+        @utm_medium = utm_medium
+        @utm_source = utm_source
+        @utm_term = utm_term
+        @video = video
+        @webhook_ids = webhook_ids
       end
     end
   end

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

@@ -0,0 +1,33 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+
+    class ResponseBody < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # Whether the domain is available.
+      field :available, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('available') } }
+      # The domain name.
+      field :domain, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('domain') } }
+      # Whether the domain is a premium domain.
+      field :premium, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('premium') } }
+      # The price description.
+      field :price, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('price') } }
+
+
+      sig { params(available: T::Boolean, domain: ::String, premium: T::Boolean, price: ::String).void }
+      def initialize(available: nil, domain: nil, premium: nil, price: nil)
+        @available = available
+        @domain = domain
+        @premium = premium
+        @price = price
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 
 # typed: true
 # frozen_string_literal: true
@@ -8,73 +8,118 @@ module OpenApiSDK
   module Operations
   
 
-    class RetrieveAnalyticsRequest < ::OpenApiSDK::Utils::FieldAugmented
+    class RetrieveAnalyticsRequest < ::Crystalline::FieldAugmented
       extend T::Sig
 
       # The browser to retrieve analytics for.
       field :browser, T.nilable(::String), { 'query_param': { 'field_name': 'browser', 'style': 'form', 'explode': true } }
       # The city to retrieve analytics for.
       field :city, T.nilable(::String), { 'query_param': { 'field_name': 'city', 'style': 'form', 'explode': true } }
-      # The country to retrieve analytics for.
+      # The continent to retrieve analytics for.
+      field :continent, T.nilable(::OpenApiSDK::Shared::ContinentCode), { 'query_param': { 'field_name': 'continent', 'style': 'form', 'explode': true } }
+      # The country to retrieve analytics for. Must be passed as a 2-letter ISO 3166-1 country code. Learn more: https://d.to/geo
       field :country, T.nilable(::OpenApiSDK::Shared::CountryCode), { 'query_param': { 'field_name': 'country', 'style': 'form', 'explode': true } }
+      # The ID of the customer to retrieve analytics for.
+      field :customer_id, T.nilable(::String), { 'query_param': { 'field_name': 'customerId', 'style': 'form', 'explode': true } }
       # The device to retrieve analytics for.
       field :device, T.nilable(::String), { 'query_param': { 'field_name': 'device', 'style': 'form', 'explode': true } }
       # The domain to filter analytics for.
       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.
+      # The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.
       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.
+      # 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 folder ID to retrieve analytics for. If not provided, return analytics for unsorted links.
+      field :folder_id, T.nilable(::String), { 'query_param': { 'field_name': 'folderId', 'style': 'form', 'explode': true } }
+      # The parameter to group the analytics data points by. Defaults to `count` if undefined.
       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.
+      # The interval to retrieve analytics for. If undefined, defaults to 24h.
       field :interval, T.nilable(::OpenApiSDK::Operations::Interval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
-      # The short link slug.
+      # The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.
       field :key, T.nilable(::String), { 'query_param': { 'field_name': 'key', 'style': 'form', 'explode': true } }
-      # The unique ID of the short link on Dub.
+      # The unique ID of the short link on Dub to retrieve analytics for.
       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.
+      # The ID of the partner to retrieve analytics for.
+      field :partner_id, T.nilable(::String), { 'query_param': { 'field_name': 'partnerId', 'style': 'form', 'explode': true } }
+      # The ID of the program to retrieve analytics for.
+      field :program_id, T.nilable(::String), { 'query_param': { 'field_name': 'programId', 'style': 'form', 'explode': true } }
+      # 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 } }
+      # The full referer URL to retrieve analytics for.
+      field :referer_url, T.nilable(::String), { 'query_param': { 'field_name': 'refererUrl', 'style': 'form', 'explode': true } }
+      # The ISO 3166-2 region code to retrieve analytics for.
+      field :region, T.nilable(::String), { 'query_param': { 'field_name': 'region', 'style': 'form', 'explode': true } }
       # Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
       field :root, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'root', 'style': 'form', 'explode': true } }
-      # The start date and time when to retrieve analytics from.
+      # The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.
       field :start, T.nilable(::String), { 'query_param': { 'field_name': 'start', 'style': 'form', 'explode': true } }
-      # The tag ID to retrieve analytics for.
+      # Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
       field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
+      # The tag IDs to retrieve analytics for.
+      field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
+      # The ID of the tenant that created the link inside your system.
+      field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', '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 } }
+      # The UTM campaign of the short link.
+      field :utm_campaign, T.nilable(::String), { 'query_param': { 'field_name': 'utm_campaign', 'style': 'form', 'explode': true } }
+      # The UTM content of the short link.
+      field :utm_content, T.nilable(::String), { 'query_param': { 'field_name': 'utm_content', 'style': 'form', 'explode': true } }
+      # The UTM medium of the short link.
+      field :utm_medium, T.nilable(::String), { 'query_param': { 'field_name': 'utm_medium', 'style': 'form', 'explode': true } }
+      # The UTM source of the short link.
+      field :utm_source, T.nilable(::String), { 'query_param': { 'field_name': 'utm_source', 'style': 'form', 'explode': true } }
+      # The UTM term of the short link.
+      field :utm_term, T.nilable(::String), { 'query_param': { 'field_name': 'utm_term', 'style': 'form', 'explode': true } }
 
 
-      sig { params(browser: T.nilable(::String), city: T.nilable(::String), 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), 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, 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, 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), customer_id: T.nilable(::String), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), folder_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), partner_id: T.nilable(::String), program_id: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), region: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tenant_id: T.nilable(::String), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::Trigger), url: T.nilable(::String), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String)).void }
+      def initialize(browser: nil, city: nil, continent: nil, country: nil, customer_id: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, folder_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, partner_id: nil, program_id: nil, qr: nil, referer: nil, referer_url: nil, region: nil, root: nil, start: nil, tag_id: nil, tag_ids: nil, tenant_id: nil, timezone: nil, trigger: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil)
         @browser = browser
         @city = city
+        @continent = continent
         @country = country
+        @customer_id = customer_id
         @device = device
         @domain = domain
         @end_ = end_
         @event = event
         @external_id = external_id
+        @folder_id = folder_id
         @group_by = group_by
         @interval = interval
         @key = key
         @link_id = link_id
         @os = os
+        @partner_id = partner_id
+        @program_id = program_id
         @qr = qr
         @referer = referer
+        @referer_url = referer_url
+        @region = region
         @root = root
         @start = start
         @tag_id = tag_id
+        @tag_ids = tag_ids
+        @tenant_id = tenant_id
         @timezone = timezone
+        @trigger = trigger
         @url = url
+        @utm_campaign = utm_campaign
+        @utm_content = utm_content
+        @utm_medium = utm_medium
+        @utm_source = utm_source
+        @utm_term = utm_term
       end
     end
   end

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

@@ -1,4 +1,4 @@
-# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 
 # typed: true
 # frozen_string_literal: true
@@ -8,7 +8,7 @@ module OpenApiSDK
   module Operations
   
 
-    class RetrieveAnalyticsResponse < ::OpenApiSDK::Utils::FieldAugmented
+    class RetrieveAnalyticsResponse < ::Crystalline::FieldAugmented
       extend T::Sig
 
       # HTTP response content type for this operation

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

@@ -0,0 +1,27 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+
+    class RetrieveLinksRequest < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :partner_id, T.nilable(::String), { 'query_param': { 'field_name': 'partnerId', 'style': 'form', 'explode': true } }
+
+      field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
+
+
+      sig { params(partner_id: T.nilable(::String), tenant_id: T.nilable(::String)).void }
+      def initialize(partner_id: nil, tenant_id: nil)
+        @partner_id = partner_id
+        @tenant_id = tenant_id
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+
+    class RetrieveLinksResponse < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # HTTP response content type for this operation
+      field :content_type, ::String
+      # Raw HTTP response; suitable for custom response parsing
+      field :raw_response, ::Faraday::Response
+      # HTTP response status code for this operation
+      field :status_code, ::Integer
+      # The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
+      field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
+      # This response is sent when a request conflicts with the current state of the server.
+      field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
+      # The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
+      field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
+      # The server has encountered a situation it does not know how to handle.
+      field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
+      # This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
+      field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
+      # The retrieved partner links.
+      field :links, T.nilable(T::Array[::OpenApiSDK::Operations::Link])
+      # The server cannot find the requested resource.
+      field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
+      # The user has sent too many requests in a given amount of time ("rate limiting")
+      field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
+      # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
+      field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
+      # The request was well-formed but was unable to be followed due to semantic errors.
+      field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
+
+
+      sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), links: T.nilable(T::Array[::OpenApiSDK::Operations::Link]), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
+      def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, links: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
+        @content_type = content_type
+        @raw_response = raw_response
+        @status_code = status_code
+        @bad_request = bad_request
+        @conflict = conflict
+        @forbidden = forbidden
+        @internal_server_error = internal_server_error
+        @invite_expired = invite_expired
+        @links = links
+        @not_found = not_found
+        @rate_limit_exceeded = rate_limit_exceeded
+        @unauthorized = unauthorized
+        @unprocessable_entity = unprocessable_entity
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+    # RetrievePartnerAnalyticsQueryParamInterval - The interval to retrieve analytics for. If undefined, defaults to 24h.
+    class RetrievePartnerAnalyticsQueryParamInterval < T::Enum
+      enums do
+        TWENTY_FOURH = new('24h')
+        SEVEND = new('7d')
+        THIRTYD = new('30d')
+        NINETYD = new('90d')
+        ONEY = new('1y')
+        MTD = new('mtd')
+        QTD = new('qtd')
+        YTD = new('ytd')
+        ALL = new('all')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+
+    class RetrievePartnerAnalyticsRequest < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # The end date and time when to retrieve analytics from. If not provided, defaults to the current date. If set along with `start`, takes precedence over `interval`.
+      field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
+      # The parameter to group the analytics data points by. Defaults to `count` if undefined.
+      field :group_by, T.nilable(::OpenApiSDK::Operations::QueryParamGroupBy), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
+      # The interval to retrieve analytics for. If undefined, defaults to 24h.
+      field :interval, T.nilable(::OpenApiSDK::Operations::RetrievePartnerAnalyticsQueryParamInterval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
+      # The ID of the partner to retrieve analytics for.
+      field :partner_id, T.nilable(::String), { 'query_param': { 'field_name': 'partnerId', 'style': 'form', 'explode': true } }
+      # The start date and time when to retrieve analytics from. If set, takes precedence over `interval`.
+      field :start, T.nilable(::String), { 'query_param': { 'field_name': 'start', 'style': 'form', 'explode': true } }
+      # The ID of the tenant that created the link inside your system.
+      field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', '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 } }
+
+
+      sig { params(end_: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::QueryParamGroupBy), interval: T.nilable(::OpenApiSDK::Operations::RetrievePartnerAnalyticsQueryParamInterval), partner_id: T.nilable(::String), start: T.nilable(::String), tenant_id: T.nilable(::String), timezone: T.nilable(::String)).void }
+      def initialize(end_: nil, group_by: nil, interval: nil, partner_id: nil, start: nil, tenant_id: nil, timezone: nil)
+        @end_ = end_
+        @group_by = group_by
+        @interval = interval
+        @partner_id = partner_id
+        @start = start
+        @tenant_id = tenant_id
+        @timezone = timezone
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+
+    class RetrievePartnerAnalyticsResponse < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+      # HTTP response content type for this operation
+      field :content_type, ::String
+      # Raw HTTP response; suitable for custom response parsing
+      field :raw_response, ::Faraday::Response
+      # HTTP response status code for this operation
+      field :status_code, ::Integer
+      # The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
+      field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
+      # This response is sent when a request conflicts with the current state of the server.
+      field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
+      # The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
+      field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
+      # The server has encountered a situation it does not know how to handle.
+      field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
+      # This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
+      field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
+      # The server cannot find the requested resource.
+      field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
+      # Partner analytics data
+      field :one_of, T.nilable(::Object)
+      # The user has sent too many requests in a given amount of time ("rate limiting")
+      field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
+      # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
+      field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
+      # The request was well-formed but was unable to be followed due to semantic errors.
+      field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
+
+
+      sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), one_of: T.nilable(::Object), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
+      def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, one_of: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
+        @content_type = content_type
+        @raw_response = raw_response
+        @status_code = status_code
+        @bad_request = bad_request
+        @conflict = conflict
+        @forbidden = forbidden
+        @internal_server_error = internal_server_error
+        @invite_expired = invite_expired
+        @not_found = not_found
+        @one_of = one_of
+        @rate_limit_exceeded = rate_limit_exceeded
+        @unauthorized = unauthorized
+        @unprocessable_entity = unprocessable_entity
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+
+module OpenApiSDK
+  module Operations
+  
+
+    class Sale < ::Crystalline::FieldAugmented
+      extend T::Sig
+
+
+      field :amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount') } }
+
+      field :currency, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency') } }
+
+      field :invoice_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } }
+
+      field :metadata, T::Hash[Symbol, ::Object], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
+
+      field :payment_processor, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor') } }
+
+
+      sig { params(amount: ::Float, currency: ::String, invoice_id: ::String, metadata: T::Hash[Symbol, ::Object], payment_processor: ::String).void }
+      def initialize(amount: nil, currency: nil, invoice_id: nil, metadata: nil, payment_processor: nil)
+        @amount = amount
+        @currency = currency
+        @invoice_id = invoice_id
+        @metadata = metadata
+        @payment_processor = payment_processor
+      end
+    end
+  end
+end

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

@@ -1,4 +1,4 @@
-# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 
 # typed: true
 # frozen_string_literal: true
@@ -7,14 +7,16 @@
 module OpenApiSDK
   module Operations
   
-    # Sort - The field to sort the links by. The default is `createdAt`, and sort order is always descending.
+    # Sort - DEPRECATED. Use `sortBy` instead.
+    # 
+    # @deprecated  class: This will be removed in a future release, please migrate away from it as soon as possible.
     class Sort < T::Enum
       enums do
         CREATED_AT = new('createdAt')
         CLICKS = new('clicks')
+        SALE_AMOUNT = new('saleAmount')
         LAST_CLICKED = new('lastClicked')
       end
     end
-
   end
 end