dub 0.2.2.pre.alpha.95 → 0.2.2.pre.alpha.99
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.
- checksums.yaml +4 -4
- data/lib/open_api_sdk/models/operations/createcustomer_link.rb +5 -2
- data/lib/open_api_sdk/models/operations/createcustomer_partner.rb +4 -4
- data/lib/open_api_sdk/models/operations/createcustomer_responsebody.rb +8 -2
- data/lib/open_api_sdk/models/operations/createpartner_responsebody.rb +40 -22
- data/lib/open_api_sdk/models/operations/getcustomer_link.rb +5 -2
- data/lib/open_api_sdk/models/operations/getcustomer_partner.rb +4 -4
- data/lib/open_api_sdk/models/operations/getcustomer_responsebody.rb +8 -2
- data/lib/open_api_sdk/models/operations/getcustomers_link.rb +5 -2
- data/lib/open_api_sdk/models/operations/getcustomers_partner.rb +4 -4
- data/lib/open_api_sdk/models/operations/getcustomers_queryparam_sortby.rb +18 -0
- data/lib/open_api_sdk/models/operations/getcustomers_queryparam_sortorder.rb +18 -0
- data/lib/open_api_sdk/models/operations/getcustomers_request.rb +14 -2
- data/lib/open_api_sdk/models/operations/getlinks_request.rb +2 -2
- data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +2 -2
- data/lib/open_api_sdk/models/operations/responsebody.rb +8 -2
- data/lib/open_api_sdk/models/operations/status.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatecustomer_link.rb +5 -2
- data/lib/open_api_sdk/models/operations/updatecustomer_partner.rb +4 -4
- data/lib/open_api_sdk/models/operations/updatecustomer_responsebody.rb +8 -2
- data/lib/open_api_sdk/models/operations.rb +2 -0
- data/lib/open_api_sdk/sdkconfiguration.rb +2 -2
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 74ce17506ef15256bb058d9f57c8a40f1675295748496ebdbbf5e17ce453193e
|
4
|
+
data.tar.gz: df63a4ca77053b430cc927dbbdd63d16399911b96924b43f5a0ef3aeea820a6e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d264499aca5ef489e5f7bc89200a4151c72d53ee36a339eb4513558cabb82d1693ecb28cdf4200edb85bf1f2728f91fe6e3a5d1aa5e862a4a5c9509b5b870386
|
7
|
+
data.tar.gz: 0edbd95d10f64d78b9853bd0521730cee8d37297e0d3365330939c9d0d3363c1eecf80b27f6d9ac7843b4a183f085cffb14eab0c220b79c8ef979287e803b2c8
|
@@ -21,15 +21,18 @@ module OpenApiSDK
|
|
21
21
|
field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
22
22
|
# The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
|
23
23
|
field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
|
24
|
+
# The destination URL of the short link.
|
25
|
+
field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
24
26
|
|
25
27
|
|
26
|
-
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String).void }
|
27
|
-
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil)
|
28
|
+
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String, url: ::String).void }
|
29
|
+
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil, url: nil)
|
28
30
|
@domain = domain
|
29
31
|
@id = id
|
30
32
|
@key = key
|
31
33
|
@program_id = program_id
|
32
34
|
@short_link = short_link
|
35
|
+
@url = url
|
33
36
|
end
|
34
37
|
end
|
35
38
|
end
|
@@ -11,13 +11,13 @@ module OpenApiSDK
|
|
11
11
|
class CreateCustomerPartner < ::Crystalline::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
|
14
|
+
# The partner's email address. Should be a unique value across Dub.
|
15
15
|
field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
|
16
|
-
|
16
|
+
# The partner's unique ID on Dub.
|
17
17
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
18
|
-
|
18
|
+
# The partner's avatar image.
|
19
19
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
20
|
-
|
20
|
+
# The partner's full legal name.
|
21
21
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
22
22
|
|
23
23
|
|
@@ -33,10 +33,14 @@ module OpenApiSDK
|
|
33
33
|
field :partner, T.nilable(::OpenApiSDK::Operations::CreateCustomerPartner), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner') } }
|
34
34
|
|
35
35
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
36
|
+
# Total amount of sales for the customer.
|
37
|
+
field :sale_amount, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
38
|
+
# Total number of sales for the customer.
|
39
|
+
field :sales, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
36
40
|
|
37
41
|
|
38
|
-
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::CreateCustomerDiscount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::CreateCustomerLink), partner: T.nilable(::OpenApiSDK::Operations::CreateCustomerPartner), program_id: T.nilable(::String)).void }
|
39
|
-
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil)
|
42
|
+
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::CreateCustomerDiscount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::CreateCustomerLink), partner: T.nilable(::OpenApiSDK::Operations::CreateCustomerPartner), program_id: T.nilable(::String), sale_amount: T.nilable(::Float), sales: T.nilable(::Float)).void }
|
43
|
+
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil, sale_amount: nil, sales: nil)
|
40
44
|
@created_at = created_at
|
41
45
|
@external_id = external_id
|
42
46
|
@id = id
|
@@ -48,6 +52,8 @@ module OpenApiSDK
|
|
48
52
|
@link = link
|
49
53
|
@partner = partner
|
50
54
|
@program_id = program_id
|
55
|
+
@sale_amount = sale_amount
|
56
|
+
@sales = sales
|
51
57
|
end
|
52
58
|
end
|
53
59
|
end
|
@@ -11,50 +11,62 @@ module OpenApiSDK
|
|
11
11
|
class CreatePartnerResponseBody < ::Crystalline::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
|
14
|
+
# The total number of clicks on the partner's links.
|
15
15
|
field :clicks, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clicks') } }
|
16
|
-
|
16
|
+
# The partner's country (required for tax purposes).
|
17
17
|
field :country, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('country') } }
|
18
|
-
|
18
|
+
# The date when the partner was created on Dub.
|
19
19
|
field :created_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('createdAt') } }
|
20
|
-
|
20
|
+
# The total earnings/commissions accrued by the partner's links.
|
21
21
|
field :earnings, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('earnings') } }
|
22
|
-
|
22
|
+
# The partner's email address. Should be a unique value across Dub.
|
23
23
|
field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
|
24
|
-
|
24
|
+
# The partner's unique ID on Dub.
|
25
25
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
26
|
-
|
26
|
+
# The partner's avatar image.
|
27
27
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
28
|
-
|
28
|
+
# The partner's Instagram username (e.g. `johndoe`).
|
29
|
+
field :instagram, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('instagram') } }
|
30
|
+
# The total number of leads generated by the partner's links.
|
29
31
|
field :leads, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
|
30
|
-
|
32
|
+
# The partner's LinkedIn username (e.g. `johndoe`).
|
33
|
+
field :linkedin, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('linkedin') } }
|
34
|
+
# The partner's referral links in this program.
|
31
35
|
field :links, T::Array[::OpenApiSDK::Operations::CreatePartnerLink], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('links') } }
|
32
|
-
|
36
|
+
# The partner's full legal name.
|
33
37
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
34
|
-
|
38
|
+
# The date when the partner enabled payouts.
|
35
39
|
field :payouts_enabled_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('payoutsEnabledAt') } }
|
36
|
-
|
40
|
+
# The partner's PayPal email (for receiving payouts via PayPal).
|
37
41
|
field :paypal_email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paypalEmail') } }
|
38
|
-
|
42
|
+
# The program's unique ID on Dub.
|
39
43
|
field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
40
|
-
|
44
|
+
# The total amount of sales (in cents) generated by the partner's links.
|
41
45
|
field :sale_amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
42
|
-
|
46
|
+
# The total number of sales generated by the partner's links.
|
43
47
|
field :sales, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
44
|
-
|
48
|
+
# The status of the partner's enrollment in the program.
|
45
49
|
field :status, ::OpenApiSDK::Operations::Status, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('status'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::Status, false) } }
|
46
|
-
|
50
|
+
# The partner's Stripe Connect ID (for receiving payouts via Stripe).
|
47
51
|
field :stripe_connect_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('stripeConnectId') } }
|
48
|
-
|
52
|
+
# The partner's unique ID within your database. Can be useful for associating the partner with a user in your database and retrieving/update their data in the future.
|
49
53
|
field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
50
|
-
|
54
|
+
# The partner's TikTok username (e.g. `johndoe`).
|
55
|
+
field :tiktok, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tiktok') } }
|
56
|
+
# The partner's Twitter username (e.g. `johndoe`).
|
57
|
+
field :twitter, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('twitter') } }
|
58
|
+
# The partner's website URL (including the https protocol).
|
59
|
+
field :website, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('website') } }
|
60
|
+
# The partner's YouTube channel username (e.g. `johndoe`).
|
61
|
+
field :youtube, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('youtube') } }
|
62
|
+
# If the partner submitted an application to join the program, this is the ID of the application.
|
51
63
|
field :application_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('applicationId') } }
|
52
|
-
|
64
|
+
# A brief description of the partner and their background.
|
53
65
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
54
66
|
|
55
67
|
|
56
|
-
sig { params(clicks: ::Float, country: ::String, created_at: ::String, earnings: ::Float, email: ::String, id: ::String, image: ::String, leads: ::Float, links: T::Array[::OpenApiSDK::Operations::CreatePartnerLink], name: ::String, payouts_enabled_at: ::String, paypal_email: ::String, program_id: ::String, sale_amount: ::Float, sales: ::Float, status: ::OpenApiSDK::Operations::Status, stripe_connect_id: ::String, tenant_id: ::String, application_id: T.nilable(::String), description: T.nilable(::String)).void }
|
57
|
-
def initialize(clicks: nil, country: nil, created_at: nil, earnings: nil, email: nil, id: nil, image: nil, leads: nil, links: nil, name: nil, payouts_enabled_at: nil, paypal_email: nil, program_id: nil, sale_amount: nil, sales: nil, status: nil, stripe_connect_id: nil, tenant_id: nil, application_id: nil, description: nil)
|
68
|
+
sig { params(clicks: ::Float, country: ::String, created_at: ::String, earnings: ::Float, email: ::String, id: ::String, image: ::String, instagram: ::String, leads: ::Float, linkedin: ::String, links: T::Array[::OpenApiSDK::Operations::CreatePartnerLink], name: ::String, payouts_enabled_at: ::String, paypal_email: ::String, program_id: ::String, sale_amount: ::Float, sales: ::Float, status: ::OpenApiSDK::Operations::Status, stripe_connect_id: ::String, tenant_id: ::String, tiktok: ::String, twitter: ::String, website: ::String, youtube: ::String, application_id: T.nilable(::String), description: T.nilable(::String)).void }
|
69
|
+
def initialize(clicks: nil, country: nil, created_at: nil, earnings: nil, email: nil, id: nil, image: nil, instagram: nil, leads: nil, linkedin: nil, links: nil, name: nil, payouts_enabled_at: nil, paypal_email: nil, program_id: nil, sale_amount: nil, sales: nil, status: nil, stripe_connect_id: nil, tenant_id: nil, tiktok: nil, twitter: nil, website: nil, youtube: nil, application_id: nil, description: nil)
|
58
70
|
@clicks = clicks
|
59
71
|
@country = country
|
60
72
|
@created_at = created_at
|
@@ -62,7 +74,9 @@ module OpenApiSDK
|
|
62
74
|
@email = email
|
63
75
|
@id = id
|
64
76
|
@image = image
|
77
|
+
@instagram = instagram
|
65
78
|
@leads = leads
|
79
|
+
@linkedin = linkedin
|
66
80
|
@links = links
|
67
81
|
@name = name
|
68
82
|
@payouts_enabled_at = payouts_enabled_at
|
@@ -73,6 +87,10 @@ module OpenApiSDK
|
|
73
87
|
@status = status
|
74
88
|
@stripe_connect_id = stripe_connect_id
|
75
89
|
@tenant_id = tenant_id
|
90
|
+
@tiktok = tiktok
|
91
|
+
@twitter = twitter
|
92
|
+
@website = website
|
93
|
+
@youtube = youtube
|
76
94
|
@application_id = application_id
|
77
95
|
@description = description
|
78
96
|
end
|
@@ -21,15 +21,18 @@ module OpenApiSDK
|
|
21
21
|
field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
22
22
|
# The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
|
23
23
|
field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
|
24
|
+
# The destination URL of the short link.
|
25
|
+
field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
24
26
|
|
25
27
|
|
26
|
-
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String).void }
|
27
|
-
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil)
|
28
|
+
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String, url: ::String).void }
|
29
|
+
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil, url: nil)
|
28
30
|
@domain = domain
|
29
31
|
@id = id
|
30
32
|
@key = key
|
31
33
|
@program_id = program_id
|
32
34
|
@short_link = short_link
|
35
|
+
@url = url
|
33
36
|
end
|
34
37
|
end
|
35
38
|
end
|
@@ -11,13 +11,13 @@ module OpenApiSDK
|
|
11
11
|
class GetCustomerPartner < ::Crystalline::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
|
14
|
+
# The partner's email address. Should be a unique value across Dub.
|
15
15
|
field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
|
16
|
-
|
16
|
+
# The partner's unique ID on Dub.
|
17
17
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
18
|
-
|
18
|
+
# The partner's avatar image.
|
19
19
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
20
|
-
|
20
|
+
# The partner's full legal name.
|
21
21
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
22
22
|
|
23
23
|
|
@@ -33,10 +33,14 @@ module OpenApiSDK
|
|
33
33
|
field :partner, T.nilable(::OpenApiSDK::Operations::GetCustomerPartner), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner') } }
|
34
34
|
|
35
35
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
36
|
+
# Total amount of sales for the customer.
|
37
|
+
field :sale_amount, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
38
|
+
# Total number of sales for the customer.
|
39
|
+
field :sales, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
36
40
|
|
37
41
|
|
38
|
-
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::GetCustomerDiscount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::GetCustomerLink), partner: T.nilable(::OpenApiSDK::Operations::GetCustomerPartner), program_id: T.nilable(::String)).void }
|
39
|
-
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil)
|
42
|
+
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::GetCustomerDiscount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::GetCustomerLink), partner: T.nilable(::OpenApiSDK::Operations::GetCustomerPartner), program_id: T.nilable(::String), sale_amount: T.nilable(::Float), sales: T.nilable(::Float)).void }
|
43
|
+
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil, sale_amount: nil, sales: nil)
|
40
44
|
@created_at = created_at
|
41
45
|
@external_id = external_id
|
42
46
|
@id = id
|
@@ -48,6 +52,8 @@ module OpenApiSDK
|
|
48
52
|
@link = link
|
49
53
|
@partner = partner
|
50
54
|
@program_id = program_id
|
55
|
+
@sale_amount = sale_amount
|
56
|
+
@sales = sales
|
51
57
|
end
|
52
58
|
end
|
53
59
|
end
|
@@ -21,15 +21,18 @@ module OpenApiSDK
|
|
21
21
|
field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
22
22
|
# The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
|
23
23
|
field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
|
24
|
+
# The destination URL of the short link.
|
25
|
+
field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
24
26
|
|
25
27
|
|
26
|
-
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String).void }
|
27
|
-
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil)
|
28
|
+
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String, url: ::String).void }
|
29
|
+
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil, url: nil)
|
28
30
|
@domain = domain
|
29
31
|
@id = id
|
30
32
|
@key = key
|
31
33
|
@program_id = program_id
|
32
34
|
@short_link = short_link
|
35
|
+
@url = url
|
33
36
|
end
|
34
37
|
end
|
35
38
|
end
|
@@ -11,13 +11,13 @@ module OpenApiSDK
|
|
11
11
|
class GetCustomersPartner < ::Crystalline::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
|
14
|
+
# The partner's email address. Should be a unique value across Dub.
|
15
15
|
field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
|
16
|
-
|
16
|
+
# The partner's unique ID on Dub.
|
17
17
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
18
|
-
|
18
|
+
# The partner's avatar image.
|
19
19
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
20
|
-
|
20
|
+
# The partner's full legal name.
|
21
21
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
22
22
|
|
23
23
|
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
|
7
|
+
module OpenApiSDK
|
8
|
+
module Operations
|
9
|
+
|
10
|
+
# GetCustomersQueryParamSortBy - The field to sort the customers by. The default is `createdAt`.
|
11
|
+
class GetCustomersQueryParamSortBy < T::Enum
|
12
|
+
enums do
|
13
|
+
CREATED_AT = new('createdAt')
|
14
|
+
SALE_AMOUNT = new('saleAmount')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
|
7
|
+
module OpenApiSDK
|
8
|
+
module Operations
|
9
|
+
|
10
|
+
# GetCustomersQueryParamSortOrder - The sort order. The default is `desc`.
|
11
|
+
class GetCustomersQueryParamSortOrder < T::Enum
|
12
|
+
enums do
|
13
|
+
ASC = new('asc')
|
14
|
+
DESC = new('desc')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -11,28 +11,40 @@ module OpenApiSDK
|
|
11
11
|
class GetCustomersRequest < ::Crystalline::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
+
# A filter on the list based on the customer's `country` field.
|
15
|
+
field :country, T.nilable(::String), { 'query_param': { 'field_name': 'country', 'style': 'form', 'explode': true } }
|
14
16
|
# A case-sensitive filter on the list based on the customer's `email` field. The value must be a string. Takes precedence over `externalId`.
|
15
17
|
field :email, T.nilable(::String), { 'query_param': { 'field_name': 'email', 'style': 'form', 'explode': true } }
|
16
18
|
# A case-sensitive filter on the list based on the customer's `externalId` field. The value must be a string. Takes precedence over `search`.
|
17
19
|
field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
|
18
20
|
# Whether to include expanded fields on the customer (`link`, `partner`, `discount`).
|
19
21
|
field :include_expanded_fields, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeExpandedFields', 'style': 'form', 'explode': true } }
|
22
|
+
# A filter on the list based on the customer's `linkId` field (the referral link ID).
|
23
|
+
field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
|
20
24
|
# The page number for pagination.
|
21
25
|
field :page, T.nilable(::Float), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
|
22
26
|
# The number of items per page.
|
23
27
|
field :page_size, T.nilable(::Float), { 'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': true } }
|
24
28
|
# A search query to filter customers by email, externalId, or name. If `email` or `externalId` is provided, this will be ignored.
|
25
29
|
field :search, T.nilable(::String), { 'query_param': { 'field_name': 'search', 'style': 'form', 'explode': true } }
|
30
|
+
# The field to sort the customers by. The default is `createdAt`.
|
31
|
+
field :sort_by, T.nilable(::OpenApiSDK::Operations::GetCustomersQueryParamSortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
|
32
|
+
# The sort order. The default is `desc`.
|
33
|
+
field :sort_order, T.nilable(::OpenApiSDK::Operations::GetCustomersQueryParamSortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
|
26
34
|
|
27
35
|
|
28
|
-
sig { params(email: T.nilable(::String), external_id: T.nilable(::String), include_expanded_fields: T.nilable(T::Boolean), page: T.nilable(::Float), page_size: T.nilable(::Float), search: T.nilable(::String)).void }
|
29
|
-
def initialize(email: nil, external_id: nil, include_expanded_fields: nil, page: nil, page_size: nil, search: nil)
|
36
|
+
sig { params(country: T.nilable(::String), email: T.nilable(::String), external_id: T.nilable(::String), include_expanded_fields: T.nilable(T::Boolean), link_id: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), search: T.nilable(::String), sort_by: T.nilable(::OpenApiSDK::Operations::GetCustomersQueryParamSortBy), sort_order: T.nilable(::OpenApiSDK::Operations::GetCustomersQueryParamSortOrder)).void }
|
37
|
+
def initialize(country: nil, email: nil, external_id: nil, include_expanded_fields: nil, link_id: nil, page: nil, page_size: nil, search: nil, sort_by: nil, sort_order: nil)
|
38
|
+
@country = country
|
30
39
|
@email = email
|
31
40
|
@external_id = external_id
|
32
41
|
@include_expanded_fields = include_expanded_fields
|
42
|
+
@link_id = link_id
|
33
43
|
@page = page
|
34
44
|
@page_size = page_size
|
35
45
|
@search = search
|
46
|
+
@sort_by = sort_by
|
47
|
+
@sort_order = sort_order
|
36
48
|
end
|
37
49
|
end
|
38
50
|
end
|
@@ -32,9 +32,9 @@ module OpenApiSDK
|
|
32
32
|
# Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
|
33
33
|
field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
|
34
34
|
# The tag IDs to filter the links by.
|
35
|
-
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode':
|
35
|
+
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': false } }
|
36
36
|
# The unique name of the tags assigned to the short link (case insensitive).
|
37
|
-
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode':
|
37
|
+
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': false } }
|
38
38
|
# The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
|
39
39
|
field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
40
40
|
# The user ID to filter the links by.
|
@@ -24,9 +24,9 @@ module OpenApiSDK
|
|
24
24
|
# Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
|
25
25
|
field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
|
26
26
|
# The tag IDs to filter the links by.
|
27
|
-
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode':
|
27
|
+
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': false } }
|
28
28
|
# The unique name of the tags assigned to the short link (case insensitive).
|
29
|
-
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode':
|
29
|
+
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': false } }
|
30
30
|
# The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
|
31
31
|
field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
32
32
|
# The user ID to filter the links by.
|
@@ -33,10 +33,14 @@ module OpenApiSDK
|
|
33
33
|
field :partner, T.nilable(::OpenApiSDK::Operations::GetCustomersPartner), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner') } }
|
34
34
|
|
35
35
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
36
|
+
# Total amount of sales for the customer.
|
37
|
+
field :sale_amount, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
38
|
+
# Total number of sales for the customer.
|
39
|
+
field :sales, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
36
40
|
|
37
41
|
|
38
|
-
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::Discount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::GetCustomersLink), partner: T.nilable(::OpenApiSDK::Operations::GetCustomersPartner), program_id: T.nilable(::String)).void }
|
39
|
-
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil)
|
42
|
+
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::Discount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::GetCustomersLink), partner: T.nilable(::OpenApiSDK::Operations::GetCustomersPartner), program_id: T.nilable(::String), sale_amount: T.nilable(::Float), sales: T.nilable(::Float)).void }
|
43
|
+
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil, sale_amount: nil, sales: nil)
|
40
44
|
@created_at = created_at
|
41
45
|
@external_id = external_id
|
42
46
|
@id = id
|
@@ -48,6 +52,8 @@ module OpenApiSDK
|
|
48
52
|
@link = link
|
49
53
|
@partner = partner
|
50
54
|
@program_id = program_id
|
55
|
+
@sale_amount = sale_amount
|
56
|
+
@sales = sales
|
51
57
|
end
|
52
58
|
end
|
53
59
|
end
|
@@ -21,15 +21,18 @@ module OpenApiSDK
|
|
21
21
|
field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
22
22
|
# The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
|
23
23
|
field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
|
24
|
+
# The destination URL of the short link.
|
25
|
+
field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
24
26
|
|
25
27
|
|
26
|
-
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String).void }
|
27
|
-
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil)
|
28
|
+
sig { params(domain: ::String, id: ::String, key: ::String, program_id: ::String, short_link: ::String, url: ::String).void }
|
29
|
+
def initialize(domain: nil, id: nil, key: nil, program_id: nil, short_link: nil, url: nil)
|
28
30
|
@domain = domain
|
29
31
|
@id = id
|
30
32
|
@key = key
|
31
33
|
@program_id = program_id
|
32
34
|
@short_link = short_link
|
35
|
+
@url = url
|
33
36
|
end
|
34
37
|
end
|
35
38
|
end
|
@@ -11,13 +11,13 @@ module OpenApiSDK
|
|
11
11
|
class UpdateCustomerPartner < ::Crystalline::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
|
14
|
+
# The partner's email address. Should be a unique value across Dub.
|
15
15
|
field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } }
|
16
|
-
|
16
|
+
# The partner's unique ID on Dub.
|
17
17
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
18
|
-
|
18
|
+
# The partner's avatar image.
|
19
19
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
20
|
-
|
20
|
+
# The partner's full legal name.
|
21
21
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
22
22
|
|
23
23
|
|
@@ -33,10 +33,14 @@ module OpenApiSDK
|
|
33
33
|
field :partner, T.nilable(::OpenApiSDK::Operations::UpdateCustomerPartner), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner') } }
|
34
34
|
|
35
35
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
36
|
+
# Total amount of sales for the customer.
|
37
|
+
field :sale_amount, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
38
|
+
# Total number of sales for the customer.
|
39
|
+
field :sales, T.nilable(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
36
40
|
|
37
41
|
|
38
|
-
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::UpdateCustomerDiscount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::UpdateCustomerLink), partner: T.nilable(::OpenApiSDK::Operations::UpdateCustomerPartner), program_id: T.nilable(::String)).void }
|
39
|
-
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil)
|
42
|
+
sig { params(created_at: ::String, external_id: ::String, id: ::String, name: ::String, avatar: T.nilable(::String), country: T.nilable(::String), discount: T.nilable(::OpenApiSDK::Operations::UpdateCustomerDiscount), email: T.nilable(::String), link: T.nilable(::OpenApiSDK::Operations::UpdateCustomerLink), partner: T.nilable(::OpenApiSDK::Operations::UpdateCustomerPartner), program_id: T.nilable(::String), sale_amount: T.nilable(::Float), sales: T.nilable(::Float)).void }
|
43
|
+
def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil, program_id: nil, sale_amount: nil, sales: nil)
|
40
44
|
@created_at = created_at
|
41
45
|
@external_id = external_id
|
42
46
|
@id = id
|
@@ -48,6 +52,8 @@ module OpenApiSDK
|
|
48
52
|
@link = link
|
49
53
|
@partner = partner
|
50
54
|
@program_id = program_id
|
55
|
+
@sale_amount = sale_amount
|
56
|
+
@sales = sales
|
51
57
|
end
|
52
58
|
end
|
53
59
|
end
|
@@ -99,6 +99,8 @@ module OpenApiSDK
|
|
99
99
|
autoload :Sale, 'open_api_sdk/models/operations/sale.rb'
|
100
100
|
autoload :TrackSaleResponseBody, 'open_api_sdk/models/operations/tracksale_responsebody.rb'
|
101
101
|
autoload :TrackSaleResponse, 'open_api_sdk/models/operations/tracksale_response.rb'
|
102
|
+
autoload :GetCustomersQueryParamSortBy, 'open_api_sdk/models/operations/getcustomers_queryparam_sortby.rb'
|
103
|
+
autoload :GetCustomersQueryParamSortOrder, 'open_api_sdk/models/operations/getcustomers_queryparam_sortorder.rb'
|
102
104
|
autoload :GetCustomersRequest, 'open_api_sdk/models/operations/getcustomers_request.rb'
|
103
105
|
autoload :GetCustomersLink, 'open_api_sdk/models/operations/getcustomers_link.rb'
|
104
106
|
autoload :GetCustomersPartner, 'open_api_sdk/models/operations/getcustomers_partner.rb'
|
@@ -61,9 +61,9 @@ module OpenApiSDK
|
|
61
61
|
end
|
62
62
|
@language = 'ruby'
|
63
63
|
@openapi_doc_version = '0.0.1'
|
64
|
-
@sdk_version = '0.2.2-alpha.
|
64
|
+
@sdk_version = '0.2.2-alpha.99'
|
65
65
|
@gen_version = '2.563.0'
|
66
|
-
@user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.
|
66
|
+
@user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.99 2.563.0 0.0.1 dub'
|
67
67
|
end
|
68
68
|
|
69
69
|
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.
|
4
|
+
version: 0.2.2.pre.alpha.99
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Dub
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-05-
|
11
|
+
date: 2025-05-18 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
@@ -268,6 +268,8 @@ files:
|
|
268
268
|
- lib/open_api_sdk/models/operations/getcustomer_type.rb
|
269
269
|
- lib/open_api_sdk/models/operations/getcustomers_link.rb
|
270
270
|
- lib/open_api_sdk/models/operations/getcustomers_partner.rb
|
271
|
+
- lib/open_api_sdk/models/operations/getcustomers_queryparam_sortby.rb
|
272
|
+
- lib/open_api_sdk/models/operations/getcustomers_queryparam_sortorder.rb
|
271
273
|
- lib/open_api_sdk/models/operations/getcustomers_request.rb
|
272
274
|
- lib/open_api_sdk/models/operations/getcustomers_response.rb
|
273
275
|
- lib/open_api_sdk/models/operations/getcustomers_type.rb
|