dub 0.2.2.pre.alpha.61 → 0.2.2.pre.alpha.63
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/dub.rb +1 -0
- data/lib/open_api_sdk/dub.rb +2 -1
- data/lib/open_api_sdk/folders.rb +359 -0
- data/lib/open_api_sdk/models/operations/{createpartner_interval.rb → accesslevel.rb} +4 -4
- data/lib/open_api_sdk/models/operations/createcustomer_responsebody.rb +1 -1
- data/lib/open_api_sdk/models/operations/createfolder_requestbody.rb +27 -0
- data/lib/open_api_sdk/models/operations/createfolder_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations/createpartner_responsebody.rb +11 -23
- data/lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb +5 -2
- data/lib/open_api_sdk/models/operations/createpartnerlink_requestbody.rb +5 -5
- data/lib/open_api_sdk/models/operations/createpartnerlink_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/data.rb +5 -2
- data/lib/open_api_sdk/models/operations/deletecustomer_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/deletecustomer_responsebody.rb +1 -1
- data/lib/open_api_sdk/models/operations/deletefolder_request.rb +24 -0
- data/lib/open_api_sdk/models/operations/deletefolder_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/deletefolder_responsebody.rb +24 -0
- data/lib/open_api_sdk/models/operations/getcustomer_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/getcustomer_responsebody.rb +1 -1
- data/lib/open_api_sdk/models/operations/getlinks_request.rb +5 -2
- data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +5 -2
- data/lib/open_api_sdk/models/operations/interval.rb +3 -1
- data/lib/open_api_sdk/models/operations/linkprops.rb +5 -2
- data/lib/open_api_sdk/models/operations/listevents_request.rb +5 -2
- data/lib/open_api_sdk/models/operations/listfolders_request.rb +24 -0
- data/lib/open_api_sdk/models/operations/listfolders_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/queryparam_groupby.rb +19 -0
- data/lib/open_api_sdk/models/operations/queryparam_interval.rb +3 -1
- data/lib/open_api_sdk/models/operations/requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations/responsebody.rb +1 -1
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +5 -2
- data/lib/open_api_sdk/models/operations/retrievepartneranalytics_queryparam_interval.rb +26 -0
- data/lib/open_api_sdk/models/operations/retrievepartneranalytics_request.rb +45 -0
- data/lib/open_api_sdk/models/operations/retrievepartneranalytics_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/updatecustomer_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatecustomer_responsebody.rb +1 -1
- data/lib/open_api_sdk/models/operations/{createpartner_type.rb → updatefolder_accesslevel.rb} +4 -4
- data/lib/open_api_sdk/models/operations/updatefolder_request.rb +27 -0
- data/lib/open_api_sdk/models/operations/updatefolder_requestbody.rb +27 -0
- data/lib/open_api_sdk/models/operations/updatefolder_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb +102 -0
- data/lib/open_api_sdk/models/operations/upsertpartnerlink_requestbody.rb +39 -0
- data/lib/open_api_sdk/models/operations/upsertpartnerlink_response.rb +60 -0
- data/lib/open_api_sdk/models/operations.rb +19 -3
- data/lib/open_api_sdk/models/shared/accesslevel.rb +18 -0
- data/lib/open_api_sdk/models/shared/folderschema.rb +39 -0
- data/lib/open_api_sdk/models/shared/link.rb +5 -2
- data/lib/open_api_sdk/models/shared/linkschema.rb +5 -2
- data/lib/open_api_sdk/models/shared/workspaceschema.rb +5 -2
- data/lib/open_api_sdk/models/shared.rb +2 -0
- data/lib/open_api_sdk/partners.rb +166 -1
- data/lib/open_api_sdk/sdkconfiguration.rb +3 -3
- metadata +24 -5
- data/lib/open_api_sdk/models/operations/createpartner_discount.rb +0 -42
@@ -0,0 +1,45 @@
|
|
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
|
+
|
11
|
+
class RetrievePartnerAnalyticsRequest < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# The ID of the program to retrieve analytics for.
|
15
|
+
field :program_id, ::String, { 'query_param': { 'field_name': 'programId', 'style': 'form', 'explode': true } }
|
16
|
+
# The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over `interval`.
|
17
|
+
field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
|
18
|
+
# The parameter to group the analytics data points by. Defaults to `count` if undefined.
|
19
|
+
field :group_by, T.nilable(::OpenApiSDK::Operations::QueryParamGroupBy), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
|
20
|
+
# The interval to retrieve analytics for. If undefined, defaults to 24h.
|
21
|
+
field :interval, T.nilable(::OpenApiSDK::Operations::RetrievePartnerAnalyticsQueryParamInterval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
|
22
|
+
# The ID of the partner to retrieve analytics for.
|
23
|
+
field :partner_id, T.nilable(::String), { 'query_param': { 'field_name': 'partnerId', 'style': 'form', 'explode': true } }
|
24
|
+
# The start date and time when to retrieve analytics from. Takes precedence over `interval`.
|
25
|
+
field :start, T.nilable(::String), { 'query_param': { 'field_name': 'start', 'style': 'form', 'explode': true } }
|
26
|
+
# The ID of the tenant that created the link inside your system.
|
27
|
+
field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
28
|
+
# The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
|
29
|
+
field :timezone, T.nilable(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
|
30
|
+
|
31
|
+
|
32
|
+
sig { params(program_id: ::String, 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 }
|
33
|
+
def initialize(program_id: nil, end_: nil, group_by: nil, interval: nil, partner_id: nil, start: nil, tenant_id: nil, timezone: nil)
|
34
|
+
@program_id = program_id
|
35
|
+
@end_ = end_
|
36
|
+
@group_by = group_by
|
37
|
+
@interval = interval
|
38
|
+
@partner_id = partner_id
|
39
|
+
@start = start
|
40
|
+
@tenant_id = tenant_id
|
41
|
+
@timezone = timezone
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,60 @@
|
|
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
|
+
|
11
|
+
class RetrievePartnerAnalyticsResponse < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# HTTP response content type for this operation
|
15
|
+
field :content_type, ::String
|
16
|
+
# Raw HTTP response; suitable for custom response parsing
|
17
|
+
field :raw_response, ::Faraday::Response
|
18
|
+
# HTTP response status code for this operation
|
19
|
+
field :status_code, ::Integer
|
20
|
+
# 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).
|
21
|
+
field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
|
22
|
+
# This response is sent when a request conflicts with the current state of the server.
|
23
|
+
field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
|
24
|
+
# 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.
|
25
|
+
field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
|
26
|
+
# The server has encountered a situation it does not know how to handle.
|
27
|
+
field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
|
28
|
+
# This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
29
|
+
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
30
|
+
# The server cannot find the requested resource.
|
31
|
+
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
32
|
+
# Partner analytics data
|
33
|
+
field :one_of, T.nilable(::Object)
|
34
|
+
# The user has sent too many requests in a given amount of time ("rate limiting")
|
35
|
+
field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
|
36
|
+
# Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
37
|
+
field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
|
38
|
+
# The request was well-formed but was unable to be followed due to semantic errors.
|
39
|
+
field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
|
40
|
+
|
41
|
+
|
42
|
+
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 }
|
43
|
+
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)
|
44
|
+
@content_type = content_type
|
45
|
+
@raw_response = raw_response
|
46
|
+
@status_code = status_code
|
47
|
+
@bad_request = bad_request
|
48
|
+
@conflict = conflict
|
49
|
+
@forbidden = forbidden
|
50
|
+
@internal_server_error = internal_server_error
|
51
|
+
@invite_expired = invite_expired
|
52
|
+
@not_found = not_found
|
53
|
+
@one_of = one_of
|
54
|
+
@rate_limit_exceeded = rate_limit_exceeded
|
55
|
+
@unauthorized = unauthorized
|
56
|
+
@unprocessable_entity = unprocessable_entity
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
@@ -11,7 +11,7 @@ module OpenApiSDK
|
|
11
11
|
class UpdateCustomerRequest < ::OpenApiSDK::Utils::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
# The unique
|
14
|
+
# The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`).
|
15
15
|
field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } }
|
16
16
|
# Whether to include expanded fields on the customer (`link`, `partner`, `discount`).
|
17
17
|
field :include_expanded_fields, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeExpandedFields', 'style': 'form', 'explode': true } }
|
@@ -15,7 +15,7 @@ module OpenApiSDK
|
|
15
15
|
field :created_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('createdAt') } }
|
16
16
|
# Unique identifier for the customer in the client's app.
|
17
17
|
field :external_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
18
|
-
# The unique
|
18
|
+
# The unique ID of the customer. You may use either the customer's `id` on Dub (obtained via `/customers` endpoint) or their `externalId` (unique ID within your system, prefixed with `ext_`, e.g. `ext_123`).
|
19
19
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
20
20
|
# Name of the customer.
|
21
21
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
data/lib/open_api_sdk/models/operations/{createpartner_type.rb → updatefolder_accesslevel.rb}
RENAMED
@@ -7,11 +7,11 @@
|
|
7
7
|
module OpenApiSDK
|
8
8
|
module Operations
|
9
9
|
|
10
|
-
|
11
|
-
class
|
10
|
+
# UpdateFolderAccessLevel - The access level of the folder within the workspace.
|
11
|
+
class UpdateFolderAccessLevel < T::Enum
|
12
12
|
enums do
|
13
|
-
|
14
|
-
|
13
|
+
READ = new('read')
|
14
|
+
WRITE = new('write')
|
15
15
|
end
|
16
16
|
end
|
17
17
|
end
|
@@ -0,0 +1,27 @@
|
|
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
|
+
|
11
|
+
class UpdateFolderRequest < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# The ID of the folder to update.
|
15
|
+
field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } }
|
16
|
+
|
17
|
+
field :request_body, T.nilable(::OpenApiSDK::Operations::UpdateFolderRequestBody), { 'request': { 'media_type': 'application/json' } }
|
18
|
+
|
19
|
+
|
20
|
+
sig { params(id: ::String, request_body: T.nilable(::OpenApiSDK::Operations::UpdateFolderRequestBody)).void }
|
21
|
+
def initialize(id: nil, request_body: nil)
|
22
|
+
@id = id
|
23
|
+
@request_body = request_body
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,27 @@
|
|
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
|
+
|
11
|
+
class UpdateFolderRequestBody < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# The access level of the folder within the workspace.
|
15
|
+
field :access_level, T.nilable(::OpenApiSDK::Operations::UpdateFolderAccessLevel), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('accessLevel'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::UpdateFolderAccessLevel, true) } }
|
16
|
+
# The name of the folder.
|
17
|
+
field :name, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
18
|
+
|
19
|
+
|
20
|
+
sig { params(access_level: T.nilable(::OpenApiSDK::Operations::UpdateFolderAccessLevel), name: T.nilable(::String)).void }
|
21
|
+
def initialize(access_level: nil, name: nil)
|
22
|
+
@access_level = access_level
|
23
|
+
@name = name
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
@@ -0,0 +1,60 @@
|
|
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
|
+
|
11
|
+
class UpdateFolderResponse < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# HTTP response content type for this operation
|
15
|
+
field :content_type, ::String
|
16
|
+
# Raw HTTP response; suitable for custom response parsing
|
17
|
+
field :raw_response, ::Faraday::Response
|
18
|
+
# HTTP response status code for this operation
|
19
|
+
field :status_code, ::Integer
|
20
|
+
# 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).
|
21
|
+
field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
|
22
|
+
# This response is sent when a request conflicts with the current state of the server.
|
23
|
+
field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
|
24
|
+
# The updated folder.
|
25
|
+
field :folder_schema, T.nilable(::OpenApiSDK::Shared::FolderSchema)
|
26
|
+
# 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.
|
27
|
+
field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
|
28
|
+
# The server has encountered a situation it does not know how to handle.
|
29
|
+
field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
|
30
|
+
# This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
31
|
+
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
32
|
+
# The server cannot find the requested resource.
|
33
|
+
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
34
|
+
# The user has sent too many requests in a given amount of time ("rate limiting")
|
35
|
+
field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
|
36
|
+
# Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
37
|
+
field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
|
38
|
+
# The request was well-formed but was unable to be followed due to semantic errors.
|
39
|
+
field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
|
40
|
+
|
41
|
+
|
42
|
+
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), folder_schema: T.nilable(::OpenApiSDK::Shared::FolderSchema), 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), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
|
43
|
+
def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, folder_schema: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
|
44
|
+
@content_type = content_type
|
45
|
+
@raw_response = raw_response
|
46
|
+
@status_code = status_code
|
47
|
+
@bad_request = bad_request
|
48
|
+
@conflict = conflict
|
49
|
+
@folder_schema = folder_schema
|
50
|
+
@forbidden = forbidden
|
51
|
+
@internal_server_error = internal_server_error
|
52
|
+
@invite_expired = invite_expired
|
53
|
+
@not_found = not_found
|
54
|
+
@rate_limit_exceeded = rate_limit_exceeded
|
55
|
+
@unauthorized = unauthorized
|
56
|
+
@unprocessable_entity = unprocessable_entity
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
@@ -29,6 +29,8 @@ module OpenApiSDK
|
|
29
29
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
30
30
|
# 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.
|
31
31
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
32
|
+
# The unique ID existing folder to assign the short link to.
|
33
|
+
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
32
34
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
33
35
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
34
36
|
# The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
@@ -87,8 +89,8 @@ module OpenApiSDK
|
|
87
89
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
88
90
|
|
89
91
|
|
90
|
-
sig { params(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), 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), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), 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), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
|
91
|
-
def initialize(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, 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, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
|
92
|
+
sig { params(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), 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), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), 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), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
|
93
|
+
def initialize(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, 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, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
|
92
94
|
@android = android
|
93
95
|
@archived = archived
|
94
96
|
@comments = comments
|
@@ -98,6 +100,7 @@ module OpenApiSDK
|
|
98
100
|
@expired_url = expired_url
|
99
101
|
@expires_at = expires_at
|
100
102
|
@external_id = external_id
|
103
|
+
@folder_id = folder_id
|
101
104
|
@geo = geo
|
102
105
|
@image = image
|
103
106
|
@ios = ios
|
@@ -31,6 +31,8 @@ module OpenApiSDK
|
|
31
31
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
32
32
|
# 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.
|
33
33
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
34
|
+
# The unique ID existing folder to assign the short link to.
|
35
|
+
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
34
36
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
35
37
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
36
38
|
# The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
@@ -87,8 +89,8 @@ module OpenApiSDK
|
|
87
89
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
88
90
|
|
89
91
|
|
90
|
-
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), 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), 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 }
|
91
|
-
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, 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, 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)
|
92
|
+
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), 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), 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 }
|
93
|
+
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, 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, 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)
|
92
94
|
@url = url
|
93
95
|
@android = android
|
94
96
|
@archived = archived
|
@@ -99,6 +101,7 @@ module OpenApiSDK
|
|
99
101
|
@expired_url = expired_url
|
100
102
|
@expires_at = expires_at
|
101
103
|
@external_id = external_id
|
104
|
+
@folder_id = folder_id
|
102
105
|
@geo = geo
|
103
106
|
@image = image
|
104
107
|
@ios = ios
|
@@ -0,0 +1,102 @@
|
|
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
|
+
# Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner.
|
11
|
+
class UpsertPartnerLinkLinkProps < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# The Android destination URL for the short link for Android device targeting.
|
15
|
+
field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
|
16
|
+
# Whether the short link is archived. Defaults to `false` if not provided.
|
17
|
+
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
|
+
# The comments for the short link.
|
19
|
+
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
+
# The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
21
|
+
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
|
+
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
|
+
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
24
|
+
# The URL to redirect to when the short link has expired.
|
25
|
+
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
26
|
+
# The date and time when the short link will expire at.
|
27
|
+
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
28
|
+
# 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.
|
29
|
+
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
30
|
+
# The unique ID existing folder to assign the short link to.
|
31
|
+
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
32
|
+
# The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
33
|
+
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
34
|
+
# The iOS destination URL for the short link for iOS device targeting.
|
35
|
+
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
36
|
+
# The ID of the partner the short link is associated with.
|
37
|
+
field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } }
|
38
|
+
# The password required to access the destination URL of the short link.
|
39
|
+
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
40
|
+
# 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.
|
41
|
+
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
42
|
+
# Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
|
43
|
+
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
44
|
+
# The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
|
45
|
+
field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
|
46
|
+
# Whether the short link uses link cloaking. Defaults to `false` if not provided.
|
47
|
+
field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
|
48
|
+
# The unique IDs of the tags assigned to the short link.
|
49
|
+
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
50
|
+
# The unique name of the tags assigned to the short link (case insensitive).
|
51
|
+
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
52
|
+
# 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.
|
53
|
+
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
54
|
+
# The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
55
|
+
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
56
|
+
# The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
|
57
|
+
field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
|
58
|
+
# The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
|
59
|
+
field :utm_content, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_content') } }
|
60
|
+
# The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.
|
61
|
+
field :utm_medium, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_medium') } }
|
62
|
+
# The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.
|
63
|
+
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
64
|
+
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
65
|
+
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
66
|
+
# The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
67
|
+
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
68
|
+
|
69
|
+
|
70
|
+
sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), folder_id: T.nilable(::String), image: T.nilable(::String), ios: T.nilable(::String), partner_id: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), title: 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), video: T.nilable(::String)).void }
|
71
|
+
def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, expired_url: nil, expires_at: nil, external_id: nil, folder_id: nil, image: nil, ios: nil, partner_id: nil, password: nil, prefix: nil, proxy: nil, ref: nil, rewrite: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
72
|
+
@android = android
|
73
|
+
@archived = archived
|
74
|
+
@comments = comments
|
75
|
+
@description = description
|
76
|
+
@do_index = do_index
|
77
|
+
@expired_url = expired_url
|
78
|
+
@expires_at = expires_at
|
79
|
+
@external_id = external_id
|
80
|
+
@folder_id = folder_id
|
81
|
+
@image = image
|
82
|
+
@ios = ios
|
83
|
+
@partner_id = partner_id
|
84
|
+
@password = password
|
85
|
+
@prefix = prefix
|
86
|
+
@proxy = proxy
|
87
|
+
@ref = ref
|
88
|
+
@rewrite = rewrite
|
89
|
+
@tag_ids = tag_ids
|
90
|
+
@tag_names = tag_names
|
91
|
+
@tenant_id = tenant_id
|
92
|
+
@title = title
|
93
|
+
@utm_campaign = utm_campaign
|
94
|
+
@utm_content = utm_content
|
95
|
+
@utm_medium = utm_medium
|
96
|
+
@utm_source = utm_source
|
97
|
+
@utm_term = utm_term
|
98
|
+
@video = video
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
@@ -0,0 +1,39 @@
|
|
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
|
+
|
11
|
+
class UpsertPartnerLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# The ID of the program that the partner is enrolled in.
|
15
|
+
field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
16
|
+
# The short link slug. If not provided, a random 7-character slug will be generated.
|
17
|
+
field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
|
18
|
+
# Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner.
|
19
|
+
field :link_props, T.nilable(::OpenApiSDK::Operations::UpsertPartnerLinkLinkProps), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('linkProps') } }
|
20
|
+
# The ID of the partner to create a link for. Will take precedence over `tenantId` if provided.
|
21
|
+
field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } }
|
22
|
+
# The ID of the partner in your system. If both `partnerId` and `tenantId` are not provided, an error will be thrown.
|
23
|
+
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
24
|
+
# The URL to shorten (if not provided, the program's default URL will be used). Will throw an error if the domain doesn't match the program's default URL domain.
|
25
|
+
field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
26
|
+
|
27
|
+
|
28
|
+
sig { params(program_id: ::String, key: T.nilable(::String), link_props: T.nilable(::OpenApiSDK::Operations::UpsertPartnerLinkLinkProps), partner_id: T.nilable(::String), tenant_id: T.nilable(::String), url: T.nilable(::String)).void }
|
29
|
+
def initialize(program_id: nil, key: nil, link_props: nil, partner_id: nil, tenant_id: nil, url: nil)
|
30
|
+
@program_id = program_id
|
31
|
+
@key = key
|
32
|
+
@link_props = link_props
|
33
|
+
@partner_id = partner_id
|
34
|
+
@tenant_id = tenant_id
|
35
|
+
@url = url
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
@@ -0,0 +1,60 @@
|
|
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
|
+
|
11
|
+
class UpsertPartnerLinkResponse < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# HTTP response content type for this operation
|
15
|
+
field :content_type, ::String
|
16
|
+
# Raw HTTP response; suitable for custom response parsing
|
17
|
+
field :raw_response, ::Faraday::Response
|
18
|
+
# HTTP response status code for this operation
|
19
|
+
field :status_code, ::Integer
|
20
|
+
# 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).
|
21
|
+
field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
|
22
|
+
# This response is sent when a request conflicts with the current state of the server.
|
23
|
+
field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
|
24
|
+
# 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.
|
25
|
+
field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
|
26
|
+
# The server has encountered a situation it does not know how to handle.
|
27
|
+
field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
|
28
|
+
# This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
29
|
+
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
30
|
+
# The upserted partner link
|
31
|
+
field :link_schema, T.nilable(::OpenApiSDK::Shared::LinkSchema)
|
32
|
+
# The server cannot find the requested resource.
|
33
|
+
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
34
|
+
# The user has sent too many requests in a given amount of time ("rate limiting")
|
35
|
+
field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
|
36
|
+
# Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
37
|
+
field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
|
38
|
+
# The request was well-formed but was unable to be followed due to semantic errors.
|
39
|
+
field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
|
40
|
+
|
41
|
+
|
42
|
+
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), link_schema: T.nilable(::OpenApiSDK::Shared::LinkSchema), 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 }
|
43
|
+
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, link_schema: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
|
44
|
+
@content_type = content_type
|
45
|
+
@raw_response = raw_response
|
46
|
+
@status_code = status_code
|
47
|
+
@bad_request = bad_request
|
48
|
+
@conflict = conflict
|
49
|
+
@forbidden = forbidden
|
50
|
+
@internal_server_error = internal_server_error
|
51
|
+
@invite_expired = invite_expired
|
52
|
+
@link_schema = link_schema
|
53
|
+
@not_found = not_found
|
54
|
+
@rate_limit_exceeded = rate_limit_exceeded
|
55
|
+
@unauthorized = unauthorized
|
56
|
+
@unprocessable_entity = unprocessable_entity
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
@@ -60,6 +60,18 @@ module OpenApiSDK
|
|
60
60
|
autoload :DeleteTagRequest, 'open_api_sdk/models/operations/deletetag_request.rb'
|
61
61
|
autoload :DeleteTagResponseBody, 'open_api_sdk/models/operations/deletetag_responsebody.rb'
|
62
62
|
autoload :DeleteTagResponse, 'open_api_sdk/models/operations/deletetag_response.rb'
|
63
|
+
autoload :AccessLevel, 'open_api_sdk/models/operations/accesslevel.rb'
|
64
|
+
autoload :CreateFolderRequestBody, 'open_api_sdk/models/operations/createfolder_requestbody.rb'
|
65
|
+
autoload :CreateFolderResponse, 'open_api_sdk/models/operations/createfolder_response.rb'
|
66
|
+
autoload :ListFoldersRequest, 'open_api_sdk/models/operations/listfolders_request.rb'
|
67
|
+
autoload :ListFoldersResponse, 'open_api_sdk/models/operations/listfolders_response.rb'
|
68
|
+
autoload :UpdateFolderAccessLevel, 'open_api_sdk/models/operations/updatefolder_accesslevel.rb'
|
69
|
+
autoload :UpdateFolderRequestBody, 'open_api_sdk/models/operations/updatefolder_requestbody.rb'
|
70
|
+
autoload :UpdateFolderRequest, 'open_api_sdk/models/operations/updatefolder_request.rb'
|
71
|
+
autoload :UpdateFolderResponse, 'open_api_sdk/models/operations/updatefolder_response.rb'
|
72
|
+
autoload :DeleteFolderRequest, 'open_api_sdk/models/operations/deletefolder_request.rb'
|
73
|
+
autoload :DeleteFolderResponseBody, 'open_api_sdk/models/operations/deletefolder_responsebody.rb'
|
74
|
+
autoload :DeleteFolderResponse, 'open_api_sdk/models/operations/deletefolder_response.rb'
|
63
75
|
autoload :CreateDomainRequestBody, 'open_api_sdk/models/operations/createdomain_requestbody.rb'
|
64
76
|
autoload :CreateDomainResponse, 'open_api_sdk/models/operations/createdomain_response.rb'
|
65
77
|
autoload :ListDomainsRequest, 'open_api_sdk/models/operations/listdomains_request.rb'
|
@@ -122,14 +134,18 @@ module OpenApiSDK
|
|
122
134
|
autoload :CreatePartnerRequestBody, 'open_api_sdk/models/operations/createpartner_requestbody.rb'
|
123
135
|
autoload :Status, 'open_api_sdk/models/operations/status.rb'
|
124
136
|
autoload :Links, 'open_api_sdk/models/operations/links.rb'
|
125
|
-
autoload :CreatePartnerType, 'open_api_sdk/models/operations/createpartner_type.rb'
|
126
|
-
autoload :CreatePartnerInterval, 'open_api_sdk/models/operations/createpartner_interval.rb'
|
127
|
-
autoload :CreatePartnerDiscount, 'open_api_sdk/models/operations/createpartner_discount.rb'
|
128
137
|
autoload :CreatePartnerResponseBody, 'open_api_sdk/models/operations/createpartner_responsebody.rb'
|
129
138
|
autoload :CreatePartnerResponse, 'open_api_sdk/models/operations/createpartner_response.rb'
|
130
139
|
autoload :CreatePartnerLinkLinkProps, 'open_api_sdk/models/operations/createpartnerlink_linkprops.rb'
|
131
140
|
autoload :CreatePartnerLinkRequestBody, 'open_api_sdk/models/operations/createpartnerlink_requestbody.rb'
|
132
141
|
autoload :CreatePartnerLinkResponse, 'open_api_sdk/models/operations/createpartnerlink_response.rb'
|
142
|
+
autoload :UpsertPartnerLinkLinkProps, 'open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb'
|
143
|
+
autoload :UpsertPartnerLinkRequestBody, 'open_api_sdk/models/operations/upsertpartnerlink_requestbody.rb'
|
144
|
+
autoload :UpsertPartnerLinkResponse, 'open_api_sdk/models/operations/upsertpartnerlink_response.rb'
|
145
|
+
autoload :RetrievePartnerAnalyticsQueryParamInterval, 'open_api_sdk/models/operations/retrievepartneranalytics_queryparam_interval.rb'
|
146
|
+
autoload :QueryParamGroupBy, 'open_api_sdk/models/operations/queryparam_groupby.rb'
|
147
|
+
autoload :RetrievePartnerAnalyticsRequest, 'open_api_sdk/models/operations/retrievepartneranalytics_request.rb'
|
148
|
+
autoload :RetrievePartnerAnalyticsResponse, 'open_api_sdk/models/operations/retrievepartneranalytics_response.rb'
|
133
149
|
autoload :GetWorkspaceRequest, 'open_api_sdk/models/operations/getworkspace_request.rb'
|
134
150
|
autoload :GetWorkspaceResponse, 'open_api_sdk/models/operations/getworkspace_response.rb'
|
135
151
|
autoload :UpdateWorkspaceRequestBody, 'open_api_sdk/models/operations/updateworkspace_requestbody.rb'
|
@@ -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 Shared
|
9
|
+
|
10
|
+
# AccessLevel - The access level of the folder within the workspace.
|
11
|
+
class AccessLevel < T::Enum
|
12
|
+
enums do
|
13
|
+
READ = new('read')
|
14
|
+
WRITE = new('write')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|