dub 0.10.5 → 0.11.0

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 (58) hide show
  1. checksums.yaml +4 -4
  2. data/lib/crystalline/module.rb +4 -0
  3. data/lib/crystalline/utils.rb +13 -0
  4. data/lib/open_api_sdk/analytics.rb +1 -1
  5. data/lib/open_api_sdk/commissions.rb +2 -2
  6. data/lib/open_api_sdk/customers.rb +5 -5
  7. data/lib/open_api_sdk/domains.rb +6 -6
  8. data/lib/open_api_sdk/embed_tokens.rb +1 -1
  9. data/lib/open_api_sdk/events.rb +1 -1
  10. data/lib/open_api_sdk/folders.rb +4 -4
  11. data/lib/open_api_sdk/links.rb +10 -10
  12. data/lib/open_api_sdk/models/operations/createfolder_requestbody.rb +6 -2
  13. data/lib/open_api_sdk/models/operations/createfolder_requestbody.rbi +2 -0
  14. data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +1 -1
  15. data/lib/open_api_sdk/models/operations/createpartner_responsebody.rb +24 -24
  16. data/lib/open_api_sdk/models/operations/createpartner_responsebody.rbi +10 -10
  17. data/lib/open_api_sdk/models/operations/listpartners_queryparam_sortby.rb +5 -7
  18. data/lib/open_api_sdk/models/operations/listpartners_request.rb +3 -7
  19. data/lib/open_api_sdk/models/operations/listpartners_request.rbi +0 -2
  20. data/lib/open_api_sdk/models/operations/listpartners_responsebody.rb +24 -24
  21. data/lib/open_api_sdk/models/operations/listpartners_responsebody.rbi +10 -10
  22. data/lib/open_api_sdk/models/operations/queryparam_groupby.rb +4 -1
  23. data/lib/open_api_sdk/models/operations/requestbody.rb +1 -1
  24. data/lib/open_api_sdk/models/operations/tracklead_requestbody.rb +1 -1
  25. data/lib/open_api_sdk/models/operations/updatefolder_requestbody.rb +6 -2
  26. data/lib/open_api_sdk/models/operations/updatefolder_requestbody.rbi +2 -0
  27. data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +1 -1
  28. data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +1 -1
  29. data/lib/open_api_sdk/models/shared/commissioncreatedevent_partner.rb +6 -2
  30. data/lib/open_api_sdk/models/shared/commissioncreatedevent_partner.rbi +2 -0
  31. data/lib/open_api_sdk/models/shared/folderschema.rb +6 -2
  32. data/lib/open_api_sdk/models/shared/folderschema.rbi +2 -0
  33. data/lib/open_api_sdk/models/shared/leadcreatedevent_link.rb +2 -2
  34. data/lib/open_api_sdk/models/shared/leadevent_link.rb +2 -2
  35. data/lib/open_api_sdk/models/shared/link.rb +2 -2
  36. data/lib/open_api_sdk/models/shared/linkclickedevent_link.rb +2 -2
  37. data/lib/open_api_sdk/models/shared/linkschema.rb +2 -2
  38. data/lib/open_api_sdk/models/shared/{tagschema.rb → linktagschema.rb} +1 -1
  39. data/lib/open_api_sdk/models/shared/{tagschema.rbi → linktagschema.rbi} +2 -2
  40. data/lib/open_api_sdk/models/shared/linkwebhookevent_link.rb +2 -2
  41. data/lib/open_api_sdk/models/shared/partner.rb +6 -2
  42. data/lib/open_api_sdk/models/shared/partner.rbi +2 -0
  43. data/lib/open_api_sdk/models/shared/partnerenrolledevent_data.rb +24 -24
  44. data/lib/open_api_sdk/models/shared/partnerenrolledevent_data.rbi +10 -10
  45. data/lib/open_api_sdk/models/shared/salecreatedevent_link.rb +2 -2
  46. data/lib/open_api_sdk/models/shared/salecreatedevent_partner.rb +6 -2
  47. data/lib/open_api_sdk/models/shared/salecreatedevent_partner.rbi +2 -0
  48. data/lib/open_api_sdk/models/shared/saleevent_link.rb +2 -2
  49. data/lib/open_api_sdk/models/shared/workspaceschema.rb +6 -2
  50. data/lib/open_api_sdk/models/shared/workspaceschema.rbi +2 -0
  51. data/lib/open_api_sdk/models/shared.rb +1 -1
  52. data/lib/open_api_sdk/partners.rb +6 -6
  53. data/lib/open_api_sdk/qr_codes.rb +1 -1
  54. data/lib/open_api_sdk/sdkconfiguration.rb +3 -3
  55. data/lib/open_api_sdk/tags.rb +10 -10
  56. data/lib/open_api_sdk/track.rb +2 -2
  57. data/lib/open_api_sdk/workspaces.rb +2 -2
  58. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dac6fb257dc647b247733ad945f117c3b0d8942918b962922609b665ec9f826b
4
- data.tar.gz: e98ad1496e1be015096cb02d3a1bf24a1ad47860f6be2f841efda413688aeb90
3
+ metadata.gz: 8164f6a2fae90054620963c8382ca3a5275ca801f793a61b864cf12a4955f69d
4
+ data.tar.gz: 7b10f13d8a435bed72ac20cda6b8966cd377f3107fdbda789cb9ad4752ca5928
5
5
  SHA512:
6
- metadata.gz: a908b0c29aad3cd1a73574ae956bc809526ee9b2686e9eccc518cc7470952d3939b0658124e072faa34106fc88b1c10c86360ba6a8f042efef233df9f4b24208
7
- data.tar.gz: 34dc9bd70d590fa623d141f42b68eab2de4bf4411e2394b04907b65c24d0417267426743f0d05e866ae1bdcb234277e33647fbf166ae0385e97b2538a3866c00
6
+ metadata.gz: 6cf12732fa46115a26ad7f5fa1dd48074b9c4e27c3f7364fe05c515ea5b152a24c90636bb98a0a2d07f7c26351a2657ebbc1a85c673d4e83bb057c37d6fe092c
7
+ data.tar.gz: 8831de4eb6a141f77f4d94e3cb43b43026a4a47c17aca1167a712766b140e6e4eb0dbf90314873756a96af54dc3dd27519d9a7c1e9372ca9fdc9bfe1b0baefbf
@@ -51,6 +51,10 @@ module Crystalline
51
51
  data.transform_values { |v| Crystalline.unmarshal_json(v, Crystalline::Utils.hash_of(type)) }
52
52
  elsif Crystalline::Utils.nilable?(type) && data == 'null'
53
53
  nil
54
+ elsif Crystalline::Utils.boolean? type
55
+ Crystalline::Utils.to_boolean(data)
56
+ elsif type.is_a?(Class) && type < T::Enum
57
+ type.deserialize(data)
54
58
  else
55
59
  data
56
60
  end
@@ -52,5 +52,18 @@ module Crystalline
52
52
  def self.get_union_types(t)
53
53
  t.types
54
54
  end
55
+
56
+ def self.boolean?(t)
57
+ t.instance_of? Crystalline::Boolean
58
+ end
59
+
60
+ def self.to_boolean(value)
61
+ case value
62
+ when true, false
63
+ value
64
+ else
65
+ raise TypeError, "Cannot convert #{value.inspect} to boolean. The value is of type #{value.class}"
66
+ end
67
+ end
55
68
  end
56
69
  end
@@ -63,7 +63,7 @@ module OpenApiSDK
63
63
  hook_ctx = SDKHooks::HookContext.new(
64
64
  config: @sdk_configuration,
65
65
  base_url: base_url,
66
- oauth2_scopes: [],
66
+ oauth2_scopes: nil,
67
67
  operation_id: 'retrieveAnalytics',
68
68
  security_source: @sdk_configuration.security_source
69
69
  )
@@ -63,7 +63,7 @@ module OpenApiSDK
63
63
  hook_ctx = SDKHooks::HookContext.new(
64
64
  config: @sdk_configuration,
65
65
  base_url: base_url,
66
- oauth2_scopes: [],
66
+ oauth2_scopes: nil,
67
67
  operation_id: 'listCommissions',
68
68
  security_source: @sdk_configuration.security_source
69
69
  )
@@ -303,7 +303,7 @@ module OpenApiSDK
303
303
  hook_ctx = SDKHooks::HookContext.new(
304
304
  config: @sdk_configuration,
305
305
  base_url: base_url,
306
- oauth2_scopes: [],
306
+ oauth2_scopes: nil,
307
307
  operation_id: 'updateCommission',
308
308
  security_source: @sdk_configuration.security_source
309
309
  )
@@ -63,7 +63,7 @@ module OpenApiSDK
63
63
  hook_ctx = SDKHooks::HookContext.new(
64
64
  config: @sdk_configuration,
65
65
  base_url: base_url,
66
- oauth2_scopes: [],
66
+ oauth2_scopes: nil,
67
67
  operation_id: 'getCustomers',
68
68
  security_source: @sdk_configuration.security_source
69
69
  )
@@ -300,7 +300,7 @@ module OpenApiSDK
300
300
  hook_ctx = SDKHooks::HookContext.new(
301
301
  config: @sdk_configuration,
302
302
  base_url: base_url,
303
- oauth2_scopes: [],
303
+ oauth2_scopes: nil,
304
304
  operation_id: 'createCustomer',
305
305
  security_source: @sdk_configuration.security_source
306
306
  )
@@ -531,7 +531,7 @@ module OpenApiSDK
531
531
  hook_ctx = SDKHooks::HookContext.new(
532
532
  config: @sdk_configuration,
533
533
  base_url: base_url,
534
- oauth2_scopes: [],
534
+ oauth2_scopes: nil,
535
535
  operation_id: 'getCustomer',
536
536
  security_source: @sdk_configuration.security_source
537
537
  )
@@ -772,7 +772,7 @@ module OpenApiSDK
772
772
  hook_ctx = SDKHooks::HookContext.new(
773
773
  config: @sdk_configuration,
774
774
  base_url: base_url,
775
- oauth2_scopes: [],
775
+ oauth2_scopes: nil,
776
776
  operation_id: 'updateCustomer',
777
777
  security_source: @sdk_configuration.security_source
778
778
  )
@@ -1006,7 +1006,7 @@ module OpenApiSDK
1006
1006
  hook_ctx = SDKHooks::HookContext.new(
1007
1007
  config: @sdk_configuration,
1008
1008
  base_url: base_url,
1009
- oauth2_scopes: [],
1009
+ oauth2_scopes: nil,
1010
1010
  operation_id: 'deleteCustomer',
1011
1011
  security_source: @sdk_configuration.security_source
1012
1012
  )
@@ -73,7 +73,7 @@ module OpenApiSDK
73
73
  hook_ctx = SDKHooks::HookContext.new(
74
74
  config: @sdk_configuration,
75
75
  base_url: base_url,
76
- oauth2_scopes: [],
76
+ oauth2_scopes: nil,
77
77
  operation_id: 'createDomain',
78
78
  security_source: @sdk_configuration.security_source
79
79
  )
@@ -299,7 +299,7 @@ module OpenApiSDK
299
299
  hook_ctx = SDKHooks::HookContext.new(
300
300
  config: @sdk_configuration,
301
301
  base_url: base_url,
302
- oauth2_scopes: [],
302
+ oauth2_scopes: nil,
303
303
  operation_id: 'listDomains',
304
304
  security_source: @sdk_configuration.security_source
305
305
  )
@@ -577,7 +577,7 @@ module OpenApiSDK
577
577
  hook_ctx = SDKHooks::HookContext.new(
578
578
  config: @sdk_configuration,
579
579
  base_url: base_url,
580
- oauth2_scopes: [],
580
+ oauth2_scopes: nil,
581
581
  operation_id: 'updateDomain',
582
582
  security_source: @sdk_configuration.security_source
583
583
  )
@@ -810,7 +810,7 @@ module OpenApiSDK
810
810
  hook_ctx = SDKHooks::HookContext.new(
811
811
  config: @sdk_configuration,
812
812
  base_url: base_url,
813
- oauth2_scopes: [],
813
+ oauth2_scopes: nil,
814
814
  operation_id: 'deleteDomain',
815
815
  security_source: @sdk_configuration.security_source
816
816
  )
@@ -1044,7 +1044,7 @@ module OpenApiSDK
1044
1044
  hook_ctx = SDKHooks::HookContext.new(
1045
1045
  config: @sdk_configuration,
1046
1046
  base_url: base_url,
1047
- oauth2_scopes: [],
1047
+ oauth2_scopes: nil,
1048
1048
  operation_id: 'registerDomain',
1049
1049
  security_source: @sdk_configuration.security_source
1050
1050
  )
@@ -1270,7 +1270,7 @@ module OpenApiSDK
1270
1270
  hook_ctx = SDKHooks::HookContext.new(
1271
1271
  config: @sdk_configuration,
1272
1272
  base_url: base_url,
1273
- oauth2_scopes: [],
1273
+ oauth2_scopes: nil,
1274
1274
  operation_id: 'checkDomainStatus',
1275
1275
  security_source: @sdk_configuration.security_source
1276
1276
  )
@@ -72,7 +72,7 @@ module OpenApiSDK
72
72
  hook_ctx = SDKHooks::HookContext.new(
73
73
  config: @sdk_configuration,
74
74
  base_url: base_url,
75
- oauth2_scopes: [],
75
+ oauth2_scopes: nil,
76
76
  operation_id: 'createReferralsEmbedToken',
77
77
  security_source: @sdk_configuration.security_source
78
78
  )
@@ -63,7 +63,7 @@ module OpenApiSDK
63
63
  hook_ctx = SDKHooks::HookContext.new(
64
64
  config: @sdk_configuration,
65
65
  base_url: base_url,
66
- oauth2_scopes: [],
66
+ oauth2_scopes: nil,
67
67
  operation_id: 'listEvents',
68
68
  security_source: @sdk_configuration.security_source
69
69
  )
@@ -72,7 +72,7 @@ module OpenApiSDK
72
72
  hook_ctx = SDKHooks::HookContext.new(
73
73
  config: @sdk_configuration,
74
74
  base_url: base_url,
75
- oauth2_scopes: [],
75
+ oauth2_scopes: nil,
76
76
  operation_id: 'createFolder',
77
77
  security_source: @sdk_configuration.security_source
78
78
  )
@@ -298,7 +298,7 @@ module OpenApiSDK
298
298
  hook_ctx = SDKHooks::HookContext.new(
299
299
  config: @sdk_configuration,
300
300
  base_url: base_url,
301
- oauth2_scopes: [],
301
+ oauth2_scopes: nil,
302
302
  operation_id: 'listFolders',
303
303
  security_source: @sdk_configuration.security_source
304
304
  )
@@ -542,7 +542,7 @@ module OpenApiSDK
542
542
  hook_ctx = SDKHooks::HookContext.new(
543
543
  config: @sdk_configuration,
544
544
  base_url: base_url,
545
- oauth2_scopes: [],
545
+ oauth2_scopes: nil,
546
546
  operation_id: 'updateFolder',
547
547
  security_source: @sdk_configuration.security_source
548
548
  )
@@ -775,7 +775,7 @@ module OpenApiSDK
775
775
  hook_ctx = SDKHooks::HookContext.new(
776
776
  config: @sdk_configuration,
777
777
  base_url: base_url,
778
- oauth2_scopes: [],
778
+ oauth2_scopes: nil,
779
779
  operation_id: 'deleteFolder',
780
780
  security_source: @sdk_configuration.security_source
781
781
  )
@@ -73,7 +73,7 @@ module OpenApiSDK
73
73
  hook_ctx = SDKHooks::HookContext.new(
74
74
  config: @sdk_configuration,
75
75
  base_url: base_url,
76
- oauth2_scopes: [],
76
+ oauth2_scopes: nil,
77
77
  operation_id: 'createLink',
78
78
  security_source: @sdk_configuration.security_source
79
79
  )
@@ -299,7 +299,7 @@ module OpenApiSDK
299
299
  hook_ctx = SDKHooks::HookContext.new(
300
300
  config: @sdk_configuration,
301
301
  base_url: base_url,
302
- oauth2_scopes: [],
302
+ oauth2_scopes: nil,
303
303
  operation_id: 'getLinks',
304
304
  security_source: @sdk_configuration.security_source
305
305
  )
@@ -570,7 +570,7 @@ module OpenApiSDK
570
570
  hook_ctx = SDKHooks::HookContext.new(
571
571
  config: @sdk_configuration,
572
572
  base_url: base_url,
573
- oauth2_scopes: [],
573
+ oauth2_scopes: nil,
574
574
  operation_id: 'getLinksCount',
575
575
  security_source: @sdk_configuration.security_source
576
576
  )
@@ -796,7 +796,7 @@ module OpenApiSDK
796
796
  hook_ctx = SDKHooks::HookContext.new(
797
797
  config: @sdk_configuration,
798
798
  base_url: base_url,
799
- oauth2_scopes: [],
799
+ oauth2_scopes: nil,
800
800
  operation_id: 'getLinkInfo',
801
801
  security_source: @sdk_configuration.security_source
802
802
  )
@@ -1040,7 +1040,7 @@ module OpenApiSDK
1040
1040
  hook_ctx = SDKHooks::HookContext.new(
1041
1041
  config: @sdk_configuration,
1042
1042
  base_url: base_url,
1043
- oauth2_scopes: [],
1043
+ oauth2_scopes: nil,
1044
1044
  operation_id: 'updateLink',
1045
1045
  security_source: @sdk_configuration.security_source
1046
1046
  )
@@ -1273,7 +1273,7 @@ module OpenApiSDK
1273
1273
  hook_ctx = SDKHooks::HookContext.new(
1274
1274
  config: @sdk_configuration,
1275
1275
  base_url: base_url,
1276
- oauth2_scopes: [],
1276
+ oauth2_scopes: nil,
1277
1277
  operation_id: 'deleteLink',
1278
1278
  security_source: @sdk_configuration.security_source
1279
1279
  )
@@ -1507,7 +1507,7 @@ module OpenApiSDK
1507
1507
  hook_ctx = SDKHooks::HookContext.new(
1508
1508
  config: @sdk_configuration,
1509
1509
  base_url: base_url,
1510
- oauth2_scopes: [],
1510
+ oauth2_scopes: nil,
1511
1511
  operation_id: 'bulkCreateLinks',
1512
1512
  security_source: @sdk_configuration.security_source
1513
1513
  )
@@ -1742,7 +1742,7 @@ module OpenApiSDK
1742
1742
  hook_ctx = SDKHooks::HookContext.new(
1743
1743
  config: @sdk_configuration,
1744
1744
  base_url: base_url,
1745
- oauth2_scopes: [],
1745
+ oauth2_scopes: nil,
1746
1746
  operation_id: 'bulkUpdateLinks',
1747
1747
  security_source: @sdk_configuration.security_source
1748
1748
  )
@@ -1968,7 +1968,7 @@ module OpenApiSDK
1968
1968
  hook_ctx = SDKHooks::HookContext.new(
1969
1969
  config: @sdk_configuration,
1970
1970
  base_url: base_url,
1971
- oauth2_scopes: [],
1971
+ oauth2_scopes: nil,
1972
1972
  operation_id: 'bulkDeleteLinks',
1973
1973
  security_source: @sdk_configuration.security_source
1974
1974
  )
@@ -2203,7 +2203,7 @@ module OpenApiSDK
2203
2203
  hook_ctx = SDKHooks::HookContext.new(
2204
2204
  config: @sdk_configuration,
2205
2205
  base_url: base_url,
2206
- oauth2_scopes: [],
2206
+ oauth2_scopes: nil,
2207
2207
  operation_id: 'upsertLink',
2208
2208
  security_source: @sdk_configuration.security_source
2209
2209
  )
@@ -15,12 +15,15 @@ module OpenApiSDK
15
15
 
16
16
  # The name of the folder.
17
17
  field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name'), required: true } }
18
+ # The description of the folder.
19
+ field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
18
20
  # The access level of the folder within the workspace.
19
21
  field :access_level, Crystalline::Nilable.new(Models::Operations::AccessLevel), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('accessLevel'), 'decoder': Utils.enum_from_string(Models::Operations::AccessLevel, true) } }
20
22
 
21
- sig { params(name: ::String, access_level: T.nilable(Models::Operations::AccessLevel)).void }
22
- def initialize(name:, access_level: nil)
23
+ sig { params(name: ::String, description: T.nilable(::String), access_level: T.nilable(Models::Operations::AccessLevel)).void }
24
+ def initialize(name:, description: nil, access_level: nil)
23
25
  @name = name
26
+ @description = description
24
27
  @access_level = access_level
25
28
  end
26
29
 
@@ -28,6 +31,7 @@ module OpenApiSDK
28
31
  def ==(other)
29
32
  return false unless other.is_a? self.class
30
33
  return false unless @name == other.name
34
+ return false unless @description == other.description
31
35
  return false unless @access_level == other.access_level
32
36
  true
33
37
  end
@@ -10,6 +10,8 @@ end
10
10
  class OpenApiSDK::Models::Operations::CreateFolderRequestBody
11
11
  def name(); end
12
12
  def name=(str_); end
13
+ def description(); end
14
+ def description=(str_); end
13
15
  def access_level(); end
14
16
  def access_level=(str_); end
15
17
  end
@@ -15,7 +15,7 @@ module OpenApiSDK
15
15
 
16
16
  # The destination URL of the short link.
17
17
  field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url'), required: true } }
18
- # The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains).
18
+ # The domain of the short link (without protocol). If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains).
19
19
  field :domain, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('domain') } }
20
20
  # The short link slug. If not provided, a random 7-character slug will be generated.
21
21
  field :key, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
@@ -47,7 +47,7 @@ module OpenApiSDK
47
47
  field :description, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
48
48
  # The partner's group ID on Dub.
49
49
  field :group_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('groupId') } }
50
- # The total commissions paid to the partner for their referrals. Defaults to 0 if `includeExpandedFields` is false.
50
+ # The total commissions paid to the partner for their referrals
51
51
  field :total_commissions, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('totalCommissions') } }
52
52
 
53
53
  field :click_reward_id, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clickRewardId') } }
@@ -63,17 +63,17 @@ module OpenApiSDK
63
63
  field :banned_at, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('bannedAt') } }
64
64
  # If the partner was banned from the program, this is the reason for the ban.
65
65
  field :banned_reason, Crystalline::Nilable.new(Models::Operations::BannedReason), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('bannedReason'), 'decoder': Utils.enum_from_string(Models::Operations::BannedReason, true) } }
66
- # The total number of clicks on the partner's links. Defaults to 0 if `includeExpandedFields` is false.
67
- field :clicks, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clicks') } }
68
- # The total number of leads generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false.
69
- field :leads, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
70
- # The total number of leads that converted to paying customers. Defaults to 0 if `includeExpandedFields` is false.
71
- field :conversions, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('conversions') } }
72
- # The total number of sales generated by the partner's links (includes recurring sales). Defaults to 0 if `includeExpandedFields` is false.
73
- field :sales, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
74
- # The total amount of sales (in cents) generated by the partner's links. Defaults to 0 if `includeExpandedFields` is false.
75
- field :sale_amount, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
76
- # The total net revenue generated by the partner. Defaults to 0 if `includeExpandedFields` is false.
66
+ # The total number of clicks on the partner's links
67
+ field :total_clicks, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('totalClicks') } }
68
+ # The total number of leads generated by the partner's links
69
+ field :total_leads, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('totalLeads') } }
70
+ # The total number of leads that converted to paying customers
71
+ field :total_conversions, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('totalConversions') } }
72
+ # The total number of sales generated by the partner's links (includes recurring sales)
73
+ field :total_sales, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('totalSales') } }
74
+ # The total amount of sales (in cents) generated by the partner's links
75
+ field :total_sale_amount, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('totalSaleAmount') } }
76
+ # The total net revenue generated by the partner
77
77
  field :net_revenue, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('netRevenue') } }
78
78
  # The partner's website URL (including the https protocol).
79
79
  field :website, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('website') } }
@@ -88,8 +88,8 @@ module OpenApiSDK
88
88
  # The partner's TikTok username (e.g. `johndoe`).
89
89
  field :tiktok, Crystalline::Nilable.new(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tiktok') } }
90
90
 
91
- sig { params(id: ::String, name: ::String, program_id: ::String, partner_id: ::String, created_at: ::String, status: Models::Operations::CreatePartnerStatus, company_name: T.nilable(::String), email: T.nilable(::String), image: T.nilable(::String), country: T.nilable(::String), paypal_email: T.nilable(::String), stripe_connect_id: T.nilable(::String), payouts_enabled_at: T.nilable(::String), tenant_id: T.nilable(::String), links: T.nilable(T::Array[Models::Operations::CreatePartnerLink]), description: T.nilable(::String), group_id: T.nilable(::String), total_commissions: T.nilable(::Float), click_reward_id: T.nilable(::String), lead_reward_id: T.nilable(::String), sale_reward_id: T.nilable(::String), discount_id: T.nilable(::String), application_id: T.nilable(::String), banned_at: T.nilable(::String), banned_reason: T.nilable(Models::Operations::BannedReason), clicks: T.nilable(::Float), leads: T.nilable(::Float), conversions: T.nilable(::Float), sales: T.nilable(::Float), sale_amount: T.nilable(::Float), net_revenue: T.nilable(::Float), website: T.nilable(::String), youtube: T.nilable(::String), twitter: T.nilable(::String), linkedin: T.nilable(::String), instagram: T.nilable(::String), tiktok: T.nilable(::String)).void }
92
- def initialize(id:, name:, program_id:, partner_id:, created_at:, status:, company_name: nil, email: nil, image: nil, country: nil, paypal_email: nil, stripe_connect_id: nil, payouts_enabled_at: nil, tenant_id: nil, links: nil, description: nil, group_id: nil, total_commissions: 0.0, click_reward_id: nil, lead_reward_id: nil, sale_reward_id: nil, discount_id: nil, application_id: nil, banned_at: nil, banned_reason: nil, clicks: 0.0, leads: 0.0, conversions: 0.0, sales: 0.0, sale_amount: 0.0, net_revenue: 0.0, website: nil, youtube: nil, twitter: nil, linkedin: nil, instagram: nil, tiktok: nil)
91
+ sig { params(id: ::String, name: ::String, program_id: ::String, partner_id: ::String, created_at: ::String, status: Models::Operations::CreatePartnerStatus, company_name: T.nilable(::String), email: T.nilable(::String), image: T.nilable(::String), country: T.nilable(::String), paypal_email: T.nilable(::String), stripe_connect_id: T.nilable(::String), payouts_enabled_at: T.nilable(::String), tenant_id: T.nilable(::String), links: T.nilable(T::Array[Models::Operations::CreatePartnerLink]), description: T.nilable(::String), group_id: T.nilable(::String), total_commissions: T.nilable(::Float), click_reward_id: T.nilable(::String), lead_reward_id: T.nilable(::String), sale_reward_id: T.nilable(::String), discount_id: T.nilable(::String), application_id: T.nilable(::String), banned_at: T.nilable(::String), banned_reason: T.nilable(Models::Operations::BannedReason), total_clicks: T.nilable(::Float), total_leads: T.nilable(::Float), total_conversions: T.nilable(::Float), total_sales: T.nilable(::Float), total_sale_amount: T.nilable(::Float), net_revenue: T.nilable(::Float), website: T.nilable(::String), youtube: T.nilable(::String), twitter: T.nilable(::String), linkedin: T.nilable(::String), instagram: T.nilable(::String), tiktok: T.nilable(::String)).void }
92
+ def initialize(id:, name:, program_id:, partner_id:, created_at:, status:, company_name: nil, email: nil, image: nil, country: nil, paypal_email: nil, stripe_connect_id: nil, payouts_enabled_at: nil, tenant_id: nil, links: nil, description: nil, group_id: nil, total_commissions: 0.0, click_reward_id: nil, lead_reward_id: nil, sale_reward_id: nil, discount_id: nil, application_id: nil, banned_at: nil, banned_reason: nil, total_clicks: 0.0, total_leads: 0.0, total_conversions: 0.0, total_sales: 0.0, total_sale_amount: 0.0, net_revenue: 0.0, website: nil, youtube: nil, twitter: nil, linkedin: nil, instagram: nil, tiktok: nil)
93
93
  @id = id
94
94
  @name = name
95
95
  @program_id = program_id
@@ -115,11 +115,11 @@ module OpenApiSDK
115
115
  @application_id = application_id
116
116
  @banned_at = banned_at
117
117
  @banned_reason = banned_reason
118
- @clicks = clicks
119
- @leads = leads
120
- @conversions = conversions
121
- @sales = sales
122
- @sale_amount = sale_amount
118
+ @total_clicks = total_clicks
119
+ @total_leads = total_leads
120
+ @total_conversions = total_conversions
121
+ @total_sales = total_sales
122
+ @total_sale_amount = total_sale_amount
123
123
  @net_revenue = net_revenue
124
124
  @website = website
125
125
  @youtube = youtube
@@ -157,11 +157,11 @@ module OpenApiSDK
157
157
  return false unless @application_id == other.application_id
158
158
  return false unless @banned_at == other.banned_at
159
159
  return false unless @banned_reason == other.banned_reason
160
- return false unless @clicks == other.clicks
161
- return false unless @leads == other.leads
162
- return false unless @conversions == other.conversions
163
- return false unless @sales == other.sales
164
- return false unless @sale_amount == other.sale_amount
160
+ return false unless @total_clicks == other.total_clicks
161
+ return false unless @total_leads == other.total_leads
162
+ return false unless @total_conversions == other.total_conversions
163
+ return false unless @total_sales == other.total_sales
164
+ return false unless @total_sale_amount == other.total_sale_amount
165
165
  return false unless @net_revenue == other.net_revenue
166
166
  return false unless @website == other.website
167
167
  return false unless @youtube == other.youtube
@@ -58,16 +58,16 @@ class OpenApiSDK::Models::Operations::CreatePartnerResponseBody
58
58
  def banned_at=(str_); end
59
59
  def banned_reason(); end
60
60
  def banned_reason=(str_); end
61
- def clicks(); end
62
- def clicks=(str_); end
63
- def leads(); end
64
- def leads=(str_); end
65
- def conversions(); end
66
- def conversions=(str_); end
67
- def sales(); end
68
- def sales=(str_); end
69
- def sale_amount(); end
70
- def sale_amount=(str_); end
61
+ def total_clicks(); end
62
+ def total_clicks=(str_); end
63
+ def total_leads(); end
64
+ def total_leads=(str_); end
65
+ def total_conversions(); end
66
+ def total_conversions=(str_); end
67
+ def total_sales(); end
68
+ def total_sales=(str_); end
69
+ def total_sale_amount(); end
70
+ def total_sale_amount=(str_); end
71
71
  def net_revenue(); end
72
72
  def net_revenue=(str_); end
73
73
  def website(); end
@@ -8,19 +8,17 @@ module OpenApiSDK
8
8
  module Models
9
9
  module Operations
10
10
 
11
- # ListPartnersQueryParamSortBy - The field to sort the partners by. The default is `saleAmount`.
11
+ # ListPartnersQueryParamSortBy - The field to sort the partners by. The default is `totalSaleAmount`.
12
12
  class ListPartnersQueryParamSortBy < T::Enum
13
13
 
14
14
 
15
15
  enums do
16
16
  CREATED_AT = new('createdAt')
17
- CLICKS = new('clicks')
18
- LEADS = new('leads')
19
- CONVERSIONS = new('conversions')
20
- SALES = new('sales')
21
- SALE_AMOUNT = new('saleAmount')
17
+ TOTAL_CLICKS = new('totalClicks')
18
+ TOTAL_LEADS = new('totalLeads')
19
+ TOTAL_CONVERSIONS = new('totalConversions')
20
+ TOTAL_SALE_AMOUNT = new('totalSaleAmount')
22
21
  TOTAL_COMMISSIONS = new('totalCommissions')
23
- NET_REVENUE = new('netRevenue')
24
22
  end
25
23
  end
26
24
  end
@@ -23,9 +23,7 @@ module OpenApiSDK
23
23
  field :tenant_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
24
24
  # A search query to filter partners by ID, name, email, or link.
25
25
  field :search, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'search', 'style': 'form', 'explode': true } }
26
- # Whether to include stats fields on the partner (`clicks`, `leads`, `conversions`, `sales`, `saleAmount`, `commissions`, `netRevenue`). If false, those fields will be returned as 0.
27
- field :include_expanded_fields, Crystalline::Nilable.new(Crystalline::Boolean.new), { 'query_param': { 'field_name': 'includeExpandedFields', 'style': 'form', 'explode': true } }
28
- # The field to sort the partners by. The default is `saleAmount`.
26
+ # The field to sort the partners by. The default is `totalSaleAmount`.
29
27
  field :sort_by, Crystalline::Nilable.new(Models::Operations::ListPartnersQueryParamSortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
30
28
  # The sort order. The default is `desc`.
31
29
  field :sort_order, Crystalline::Nilable.new(Models::Operations::ListPartnersQueryParamSortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
@@ -34,14 +32,13 @@ module OpenApiSDK
34
32
  # The number of items per page.
35
33
  field :page_size, Crystalline::Nilable.new(::Float), { 'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': true } }
36
34
 
37
- sig { params(status: T.nilable(Models::Operations::ListPartnersQueryParamStatus), country: T.nilable(::String), email: T.nilable(::String), tenant_id: T.nilable(::String), search: T.nilable(::String), include_expanded_fields: T.nilable(T::Boolean), sort_by: T.nilable(Models::Operations::ListPartnersQueryParamSortBy), sort_order: T.nilable(Models::Operations::ListPartnersQueryParamSortOrder), page: T.nilable(::Float), page_size: T.nilable(::Float)).void }
38
- def initialize(status: nil, country: nil, email: nil, tenant_id: nil, search: nil, include_expanded_fields: nil, sort_by: Models::Operations::ListPartnersQueryParamSortBy::SALE_AMOUNT, sort_order: Models::Operations::ListPartnersQueryParamSortOrder::DESC, page: 1.0, page_size: 100.0)
35
+ sig { params(status: T.nilable(Models::Operations::ListPartnersQueryParamStatus), country: T.nilable(::String), email: T.nilable(::String), tenant_id: T.nilable(::String), search: T.nilable(::String), sort_by: T.nilable(Models::Operations::ListPartnersQueryParamSortBy), sort_order: T.nilable(Models::Operations::ListPartnersQueryParamSortOrder), page: T.nilable(::Float), page_size: T.nilable(::Float)).void }
36
+ def initialize(status: nil, country: nil, email: nil, tenant_id: nil, search: nil, sort_by: Models::Operations::ListPartnersQueryParamSortBy::TOTAL_SALE_AMOUNT, sort_order: Models::Operations::ListPartnersQueryParamSortOrder::DESC, page: 1.0, page_size: 100.0)
39
37
  @status = status
40
38
  @country = country
41
39
  @email = email
42
40
  @tenant_id = tenant_id
43
41
  @search = search
44
- @include_expanded_fields = include_expanded_fields
45
42
  @sort_by = sort_by
46
43
  @sort_order = sort_order
47
44
  @page = page
@@ -56,7 +53,6 @@ module OpenApiSDK
56
53
  return false unless @email == other.email
57
54
  return false unless @tenant_id == other.tenant_id
58
55
  return false unless @search == other.search
59
- return false unless @include_expanded_fields == other.include_expanded_fields
60
56
  return false unless @sort_by == other.sort_by
61
57
  return false unless @sort_order == other.sort_order
62
58
  return false unless @page == other.page
@@ -18,8 +18,6 @@ class OpenApiSDK::Models::Operations::ListPartnersRequest
18
18
  def tenant_id=(str_); end
19
19
  def search(); end
20
20
  def search=(str_); end
21
- def include_expanded_fields(); end
22
- def include_expanded_fields=(str_); end
23
21
  def sort_by(); end
24
22
  def sort_by=(str_); end
25
23
  def sort_order(); end