dub 0.2.2.pre.alpha.54 → 0.2.2.pre.alpha.56

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. checksums.yaml +4 -4
  2. data/lib/open_api_sdk/customers.rb +3 -1
  3. data/lib/open_api_sdk/models/operations/groupby.rb +6 -1
  4. data/lib/open_api_sdk/models/operations/listevents_request.rb +17 -2
  5. data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +18 -3
  6. data/lib/open_api_sdk/models/shared/workspaceschema.rb +2 -5
  7. data/lib/open_api_sdk/sdkconfiguration.rb +3 -3
  8. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 51b4c7a939288c04e0252f58f08b5b61725b3e03c33d65c7731924872174be0b
4
- data.tar.gz: 0c7a014672d31d0c05ddf40c2b2626567ab8a87e3fbe5a8ea2b51de45dc737f4
3
+ metadata.gz: 1ae70cc095ac7458b17039281686a95d20a50fb8d1c8196c499024c55caf439d
4
+ data.tar.gz: ab1dc3c809b86d9040b257fa9c342c7315a2129b20715d6d30a6545700581296
5
5
  SHA512:
6
- metadata.gz: 0f0299947ac1dfbeb8884017f359261b4f3baa9e613b36918e427c265458754ca57b807fa50ccb62f76ee900311c27d7b4d5453e403fd9d7a4af9895b547ee8f
7
- data.tar.gz: 93768d85407188c7a2cb61028ae6490350757101c1999110bb3fc546578084d021de34296093d5086df4d206eb0931ad29ff2530b25cc77fc9d3fe81c5ecacde
6
+ metadata.gz: bc489a02dc5d2e6dcf03314d33fa0c7c558cbbc4fa4fe52b97c3d7081d04a925a45594a5fa48d0c1257acc9faa2c2ad2881d782baa207c5005b4bce7ed173c04
7
+ data.tar.gz: aa259bc07f095bd88545c603b9f58cae29eeafcb6112a3dfdebe0fcbb87980d8910099495d9e05ae5723f750a75d70c1d3ed89daece4b5c29618dfe06c409e08
data/lib/open_api_sdk/customers.rb CHANGED
@@ -101,7 +101,9 @@ module OpenApiSDK
101
101
  sig { params(request: T.nilable(::OpenApiSDK::Operations::CreateCustomerRequestBody)).returns(::OpenApiSDK::Operations::CreateCustomerResponse) }
102
102
  def create(request)
103
103
  # create - Create a customer
104
- # Create a customer for the authenticated workspace.
104
+ # [Deprecated]: Customer creation can only be done via tracking a lead event. Use the /track/lead endpoint instead.
105
+ #
106
+ # @deprecated method: This will be removed in a future release, please migrate away from it as soon as possible.
105
107
  url, params = @sdk_configuration.get_server_details
106
108
  base_url = Utils.template_url(url, params)
107
109
  url = "#{base_url}/customers"
data/lib/open_api_sdk/models/operations/groupby.rb CHANGED
@@ -7,7 +7,7 @@
7
7
  module OpenApiSDK
8
8
  module Operations
9
9
 
10
- # 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.
10
+ # GroupBy - The parameter to group the analytics data points by. Defaults to `count` if undefined.
11
11
  class GroupBy < T::Enum
12
12
  enums do
13
13
  COUNT = new('count')
@@ -25,6 +25,11 @@ module OpenApiSDK
25
25
  REFERER_URLS = new('referer_urls')
26
26
  TOP_LINKS = new('top_links')
27
27
  TOP_URLS = new('top_urls')
28
+ UTM_SOURCES = new('utm_sources')
29
+ UTM_MEDIUMS = new('utm_mediums')
30
+ UTM_CAMPAIGNS = new('utm_campaigns')
31
+ UTM_TERMS = new('utm_terms')
32
+ UTM_CONTENTS = new('utm_contents')
28
33
  end
29
34
  end
30
35
  end
data/lib/open_api_sdk/models/operations/listevents_request.rb CHANGED
@@ -69,10 +69,20 @@ module OpenApiSDK
69
69
  field :trigger, T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
70
70
  # The URL to retrieve analytics for.
71
71
  field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
72
+ # The UTM campaign of the short link.
73
+ field :utm_campaign, T.nilable(::String), { 'query_param': { 'field_name': 'utm_campaign', 'style': 'form', 'explode': true } }
74
+ # The UTM content of the short link.
75
+ field :utm_content, T.nilable(::String), { 'query_param': { 'field_name': 'utm_content', 'style': 'form', 'explode': true } }
76
+ # The UTM medium of the short link.
77
+ field :utm_medium, T.nilable(::String), { 'query_param': { 'field_name': 'utm_medium', 'style': 'form', 'explode': true } }
78
+ # The UTM source of the short link.
79
+ field :utm_source, T.nilable(::String), { 'query_param': { 'field_name': 'utm_source', 'style': 'form', 'explode': true } }
80
+ # The UTM term of the short link.
81
+ field :utm_term, T.nilable(::String), { 'query_param': { 'field_name': 'utm_term', 'style': 'form', 'explode': true } }
72
82
 
73
83
 
74
- 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), region: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::QueryParamSortBy), sort_order: T.nilable(::OpenApiSDK::Operations::QueryParamSortOrder), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), url: T.nilable(::String)).void }
75
- 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, region: nil, root: nil, sort_by: nil, sort_order: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil)
84
+ 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), region: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::QueryParamSortBy), sort_order: T.nilable(::OpenApiSDK::Operations::QueryParamSortOrder), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), 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 }
85
+ 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, region: nil, root: nil, sort_by: nil, sort_order: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil)
76
86
  @browser = browser
77
87
  @city = city
78
88
  @continent = continent
@@ -102,6 +112,11 @@ module OpenApiSDK
102
112
  @timezone = timezone
103
113
  @trigger = trigger
104
114
  @url = url
115
+ @utm_campaign = utm_campaign
116
+ @utm_content = utm_content
117
+ @utm_medium = utm_medium
118
+ @utm_source = utm_source
119
+ @utm_term = utm_term
105
120
  end
106
121
  end
107
122
  end
data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb CHANGED
@@ -29,7 +29,7 @@ module OpenApiSDK
29
29
  field :event, T.nilable(::OpenApiSDK::Operations::Event), { 'query_param': { 'field_name': 'event', 'style': 'form', 'explode': true } }
30
30
  # This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
31
31
  field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
32
- # 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.
32
+ # The parameter to group the analytics data points by. Defaults to `count` if undefined.
33
33
  field :group_by, T.nilable(::OpenApiSDK::Operations::GroupBy), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
34
34
  # The interval to retrieve analytics for. If undefined, defaults to 24h.
35
35
  field :interval, T.nilable(::OpenApiSDK::Operations::Interval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
@@ -61,10 +61,20 @@ module OpenApiSDK
61
61
  field :trigger, T.nilable(::OpenApiSDK::Operations::Trigger), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
62
62
  # The URL to retrieve analytics for.
63
63
  field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
64
+ # The UTM campaign of the short link.
65
+ field :utm_campaign, T.nilable(::String), { 'query_param': { 'field_name': 'utm_campaign', 'style': 'form', 'explode': true } }
66
+ # The UTM content of the short link.
67
+ field :utm_content, T.nilable(::String), { 'query_param': { 'field_name': 'utm_content', 'style': 'form', 'explode': true } }
68
+ # The UTM medium of the short link.
69
+ field :utm_medium, T.nilable(::String), { 'query_param': { 'field_name': 'utm_medium', 'style': 'form', 'explode': true } }
70
+ # The UTM source of the short link.
71
+ field :utm_source, T.nilable(::String), { 'query_param': { 'field_name': 'utm_source', 'style': 'form', 'explode': true } }
72
+ # The UTM term of the short link.
73
+ field :utm_term, T.nilable(::String), { 'query_param': { 'field_name': 'utm_term', 'style': 'form', 'explode': true } }
64
74
 
65
75
 
66
- 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), region: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::Trigger), url: T.nilable(::String)).void }
67
- 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, region: nil, root: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil)
76
+ 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), region: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), 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 }
77
+ 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, region: nil, root: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil)
68
78
  @browser = browser
69
79
  @city = city
70
80
  @continent = continent
@@ -90,6 +100,11 @@ module OpenApiSDK
90
100
  @timezone = timezone
91
101
  @trigger = trigger
92
102
  @url = url
103
+ @utm_campaign = utm_campaign
104
+ @utm_content = utm_content
105
+ @utm_medium = utm_medium
106
+ @utm_source = utm_source
107
+ @utm_term = utm_term
93
108
  end
94
109
  end
95
110
  end
data/lib/open_api_sdk/models/shared/workspaceschema.rb CHANGED
@@ -43,8 +43,6 @@ module OpenApiSDK
43
43
  field :partners_enabled, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnersEnabled') } }
44
44
  # The date and time when the payment failed for the workspace.
45
45
  field :payment_failed_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentFailedAt') } }
46
- # [BETA – Dub Partners]: The ID of the payment method for partner payouts.
47
- field :payout_method_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('payoutMethodId') } }
48
46
  # The plan of the workspace.
49
47
  field :plan, ::OpenApiSDK::Shared::Plan, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('plan'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Shared::Plan, false) } }
50
48
  # The limit of tracked revenue in the current billing cycle (in cents).
@@ -73,8 +71,8 @@ module OpenApiSDK
73
71
  field :flags, T.nilable(T::Hash[Symbol, T::Boolean]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('flags') } }
74
72
 
75
73
 
76
- sig { params(ai_limit: ::Float, ai_usage: ::Float, billing_cycle_start: ::Float, conversion_enabled: T::Boolean, created_at: ::String, domains: T::Array[::OpenApiSDK::Shared::Domains], domains_limit: ::Float, dot_link_claimed: T::Boolean, id: ::String, invite_code: ::String, links_limit: ::Float, links_usage: ::Float, logo: ::String, name: ::String, partners_enabled: T::Boolean, payment_failed_at: ::String, payout_method_id: ::String, plan: ::OpenApiSDK::Shared::Plan, sales_limit: ::Float, sales_usage: ::Float, slug: ::String, store: T::Hash[Symbol, ::Object], stripe_connect_id: ::String, stripe_id: ::String, tags_limit: ::Float, usage: ::Float, usage_limit: ::Float, users: T::Array[::OpenApiSDK::Shared::Users], users_limit: ::Float, flags: T.nilable(T::Hash[Symbol, T::Boolean])).void }
77
- def initialize(ai_limit: nil, ai_usage: nil, billing_cycle_start: nil, conversion_enabled: nil, created_at: nil, domains: nil, domains_limit: nil, dot_link_claimed: nil, id: nil, invite_code: nil, links_limit: nil, links_usage: nil, logo: nil, name: nil, partners_enabled: nil, payment_failed_at: nil, payout_method_id: nil, plan: nil, sales_limit: nil, sales_usage: nil, slug: nil, store: nil, stripe_connect_id: nil, stripe_id: nil, tags_limit: nil, usage: nil, usage_limit: nil, users: nil, users_limit: nil, flags: nil)
74
+ sig { params(ai_limit: ::Float, ai_usage: ::Float, billing_cycle_start: ::Float, conversion_enabled: T::Boolean, created_at: ::String, domains: T::Array[::OpenApiSDK::Shared::Domains], domains_limit: ::Float, dot_link_claimed: T::Boolean, id: ::String, invite_code: ::String, links_limit: ::Float, links_usage: ::Float, logo: ::String, name: ::String, partners_enabled: T::Boolean, payment_failed_at: ::String, plan: ::OpenApiSDK::Shared::Plan, sales_limit: ::Float, sales_usage: ::Float, slug: ::String, store: T::Hash[Symbol, ::Object], stripe_connect_id: ::String, stripe_id: ::String, tags_limit: ::Float, usage: ::Float, usage_limit: ::Float, users: T::Array[::OpenApiSDK::Shared::Users], users_limit: ::Float, flags: T.nilable(T::Hash[Symbol, T::Boolean])).void }
75
+ def initialize(ai_limit: nil, ai_usage: nil, billing_cycle_start: nil, conversion_enabled: nil, created_at: nil, domains: nil, domains_limit: nil, dot_link_claimed: nil, id: nil, invite_code: nil, links_limit: nil, links_usage: nil, logo: nil, name: nil, partners_enabled: nil, payment_failed_at: nil, plan: nil, sales_limit: nil, sales_usage: nil, slug: nil, store: nil, stripe_connect_id: nil, stripe_id: nil, tags_limit: nil, usage: nil, usage_limit: nil, users: nil, users_limit: nil, flags: nil)
78
76
  @ai_limit = ai_limit
79
77
  @ai_usage = ai_usage
80
78
  @billing_cycle_start = billing_cycle_start
@@ -91,7 +89,6 @@ module OpenApiSDK
91
89
  @name = name
92
90
  @partners_enabled = partners_enabled
93
91
  @payment_failed_at = payment_failed_at
94
- @payout_method_id = payout_method_id
95
92
  @plan = plan
96
93
  @sales_limit = sales_limit
97
94
  @sales_usage = sales_usage
data/lib/open_api_sdk/sdkconfiguration.rb CHANGED
@@ -38,9 +38,9 @@ module OpenApiSDK
38
38
  @security = security
39
39
  @language = 'ruby'
40
40
  @openapi_doc_version = '0.0.1'
41
- @sdk_version = '0.2.2-alpha.54'
42
- @gen_version = '2.493.21'
43
- @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.54 2.493.21 0.0.1 dub'
41
+ @sdk_version = '0.2.2-alpha.56'
42
+ @gen_version = '2.493.34'
43
+ @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.56 2.493.34 0.0.1 dub'
44
44
  end
45
45
 
46
46
  sig { returns([String, T::Hash[Symbol, String]]) }
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dub
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2.pre.alpha.54
4
+ version: 0.2.2.pre.alpha.56
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dub
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-01-17 00:00:00.000000000 Z
11
+ date: 2025-01-23 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday