From 7195ea688ef2abfa1043b538e47d333637cc1534 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Wed, 5 Mar 2025 00:28:46 +0000 Subject: [PATCH 1/2] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.509.1 --- .speakeasy/gen.lock | 53 +++- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 14 +- Gemfile.lock | 4 +- README.md | 2 +- RELEASES.md | 12 +- codeSamples.yaml | 8 +- .../operations/createembedtokenrequestbody.md | 10 - .../operations/createpartnerlinklinkprops.md | 1 - .../operations/createpartnerrequestbody.md | 22 +- .../createreferralsembedtokencountry.md | 259 +++++++++++++++++ .../createreferralsembedtokenlinkprops.md | 35 +++ .../createreferralsembedtokenrequestbody.md | 11 + ...d => createreferralsembedtokenresponse.md} | 4 +- ... createreferralsembedtokenresponsebody.md} | 2 +- docs/models/operations/getcustomerspartner.md | 11 + docs/models/operations/interval.md | 23 +- docs/models/operations/linkprops.md | 1 - docs/models/operations/partner.md | 16 +- docs/models/operations/responsebody.md | 2 +- ...rievepartneranalyticsqueryparaminterval.md | 23 +- .../operations/upsertpartnerlinklinkprops.md | 1 - docs/sdks/embedtokens/README.md | 28 +- docs/sdks/partners/README.md | 1 - dub.gemspec | 2 +- lib/open_api_sdk/embed_tokens.rb | 14 +- lib/open_api_sdk/models/operations.rb | 11 +- .../operations/createpartner_requestbody.rb | 10 +- .../operations/createpartnerlink_linkprops.rb | 7 +- .../createreferralsembedtoken_country.rb | 266 ++++++++++++++++++ .../createreferralsembedtoken_linkprops.rb | 99 +++++++ ... createreferralsembedtoken_requestbody.rb} | 9 +- ... => createreferralsembedtoken_response.rb} | 6 +- ...createreferralsembedtoken_responsebody.rb} | 2 +- .../models/operations/getcustomers_partner.rb | 33 +++ .../models/operations/interval.rb | 1 - .../models/operations/linkprops.rb | 7 +- lib/open_api_sdk/models/operations/partner.rb | 28 +- .../models/operations/responsebody.rb | 4 +- ...evepartneranalytics_queryparam_interval.rb | 1 - .../operations/upsertpartnerlink_linkprops.rb | 7 +- lib/open_api_sdk/sdkconfiguration.rb | 6 +- 42 files changed, 909 insertions(+), 149 deletions(-) delete mode 100644 docs/models/operations/createembedtokenrequestbody.md create mode 100644 docs/models/operations/createreferralsembedtokencountry.md create mode 100644 docs/models/operations/createreferralsembedtokenlinkprops.md create mode 100644 docs/models/operations/createreferralsembedtokenrequestbody.md rename docs/models/operations/{createembedtokenresponse.md => createreferralsembedtokenresponse.md} (98%) rename docs/models/operations/{createembedtokenresponsebody.md => createreferralsembedtokenresponsebody.md} (90%) create mode 100644 docs/models/operations/getcustomerspartner.md create mode 100644 lib/open_api_sdk/models/operations/createreferralsembedtoken_country.rb create mode 100644 lib/open_api_sdk/models/operations/createreferralsembedtoken_linkprops.rb rename lib/open_api_sdk/models/operations/{createembedtoken_requestbody.rb => createreferralsembedtoken_requestbody.rb} (57%) rename lib/open_api_sdk/models/operations/{createembedtoken_response.rb => createreferralsembedtoken_response.rb} (89%) rename lib/open_api_sdk/models/operations/{createembedtoken_responsebody.rb => createreferralsembedtoken_responsebody.rb} (89%) create mode 100644 lib/open_api_sdk/models/operations/getcustomers_partner.rb diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 9c5e39d..1957701 100755 --- a/.speakeasy/gen.lock +++ b/.speakeasy/gen.lock @@ -1,12 +1,12 @@ lockVersion: 2.0.0 id: 5a2dd83e-da98-455b-8ef9-0100a914efdf management: - docChecksum: 67941bfbb5e02cd5bc33d054673647ac + docChecksum: 7d12cd211b08ee0e5d9a48c3e7a01812 docVersion: 0.0.1 - speakeasyVersion: 1.509.0 - generationVersion: 2.539.0 - releaseVersion: 0.2.2-alpha.74 - configChecksum: 4a8358d13fdd80aa0ae2a000cab4e38a + speakeasyVersion: 1.509.1 + generationVersion: 2.539.1 + releaseVersion: 0.2.2-alpha.75 + configChecksum: 404fa88f9d65791ad2fb135dc7d34aab repoURL: https://github.com/dubinc/dub-ruby.git installationURL: https://github.com/dubinc/dub-ruby published: true @@ -47,9 +47,6 @@ generatedFiles: - docs/models/operations/createcustomertype.md - docs/models/operations/createdomainrequestbody.md - docs/models/operations/createdomainresponse.md - - docs/models/operations/createembedtokenrequestbody.md - - docs/models/operations/createembedtokenresponse.md - - docs/models/operations/createembedtokenresponsebody.md - docs/models/operations/createfolderrequestbody.md - docs/models/operations/createfolderresponse.md - docs/models/operations/createlinkrequestbody.md @@ -60,6 +57,11 @@ generatedFiles: - docs/models/operations/createpartnerrequestbody.md - docs/models/operations/createpartnerresponse.md - docs/models/operations/createpartnerresponsebody.md + - docs/models/operations/createreferralsembedtokencountry.md + - docs/models/operations/createreferralsembedtokenlinkprops.md + - docs/models/operations/createreferralsembedtokenrequestbody.md + - docs/models/operations/createreferralsembedtokenresponse.md + - docs/models/operations/createreferralsembedtokenresponsebody.md - docs/models/operations/createtagrequestbody.md - docs/models/operations/createtagresponse.md - docs/models/operations/customer.md @@ -89,6 +91,7 @@ generatedFiles: - docs/models/operations/getcustomerresponse.md - docs/models/operations/getcustomerresponsebody.md - docs/models/operations/getcustomersinterval.md + - docs/models/operations/getcustomerspartner.md - docs/models/operations/getcustomersrequest.md - docs/models/operations/getcustomersresponse.md - docs/models/operations/getcustomertype.md @@ -287,9 +290,6 @@ generatedFiles: - lib/open_api_sdk/models/operations/createcustomer_type.rb - lib/open_api_sdk/models/operations/createdomain_requestbody.rb - lib/open_api_sdk/models/operations/createdomain_response.rb - - lib/open_api_sdk/models/operations/createembedtoken_requestbody.rb - - lib/open_api_sdk/models/operations/createembedtoken_response.rb - - lib/open_api_sdk/models/operations/createembedtoken_responsebody.rb - lib/open_api_sdk/models/operations/createfolder_requestbody.rb - lib/open_api_sdk/models/operations/createfolder_response.rb - lib/open_api_sdk/models/operations/createlink_requestbody.rb @@ -300,6 +300,11 @@ generatedFiles: - lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb - lib/open_api_sdk/models/operations/createpartnerlink_requestbody.rb - lib/open_api_sdk/models/operations/createpartnerlink_response.rb + - lib/open_api_sdk/models/operations/createreferralsembedtoken_country.rb + - lib/open_api_sdk/models/operations/createreferralsembedtoken_linkprops.rb + - lib/open_api_sdk/models/operations/createreferralsembedtoken_requestbody.rb + - lib/open_api_sdk/models/operations/createreferralsembedtoken_response.rb + - lib/open_api_sdk/models/operations/createreferralsembedtoken_responsebody.rb - lib/open_api_sdk/models/operations/createtag_requestbody.rb - lib/open_api_sdk/models/operations/createtag_response.rb - lib/open_api_sdk/models/operations/customer.rb @@ -330,6 +335,7 @@ generatedFiles: - lib/open_api_sdk/models/operations/getcustomer_responsebody.rb - lib/open_api_sdk/models/operations/getcustomer_type.rb - lib/open_api_sdk/models/operations/getcustomers_interval.rb + - lib/open_api_sdk/models/operations/getcustomers_partner.rb - lib/open_api_sdk/models/operations/getcustomers_request.rb - lib/open_api_sdk/models/operations/getcustomers_response.rb - lib/open_api_sdk/models/operations/getlinkinfo_request.rb @@ -1567,5 +1573,30 @@ examples: application/json: {"error": {"code": "rate_limit_exceeded", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"}} "500": application/json: {"error": {"code": "internal_server_error", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"}} + createReferralsEmbedToken: + speakeasy-default-create-referrals-embed-token: + requestBody: + application/json: {"programId": "", "partner": {"name": "", "email": "Florencio98@hotmail.com", "linkProps": {"externalId": "123456", "tagIds": ["clux0rgak00011..."]}}} + responses: + "201": + application/json: {"publicToken": "", "expires": ""} + "400": + application/json: {"error": {"code": "bad_request", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#bad-request"}} + "401": + application/json: {"error": {"code": "unauthorized", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#unauthorized"}} + "403": + application/json: {"error": {"code": "forbidden", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#forbidden"}} + "404": + application/json: {"error": {"code": "not_found", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#not-found"}} + "409": + application/json: {"error": {"code": "conflict", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#conflict"}} + "410": + application/json: {"error": {"code": "invite_expired", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#invite-expired"}} + "422": + application/json: {"error": {"code": "unprocessable_entity", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#unprocessable-entity"}} + "429": + application/json: {"error": {"code": "rate_limit_exceeded", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#rate-limit_exceeded"}} + "500": + application/json: {"error": {"code": "internal_server_error", "message": "The requested resource was not found.", "doc_url": "https://dub.co/docs/api-reference/errors#internal-server_error"}} examplesVersion: 1.0.0 generatedTests: {} diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index fb72668..c6b3be8 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -15,7 +15,7 @@ generation: oAuth2ClientCredentialsEnabled: true oAuth2PasswordEnabled: false ruby: - version: 0.2.2-alpha.74 + version: 0.2.2-alpha.75 author: Dub description: Ruby Client SDK Generated by Speakeasy flattenGlobalSecurity: false diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index c342a8a..f052da9 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,21 +1,21 @@ -speakeasyVersion: 1.509.0 +speakeasyVersion: 1.509.1 sources: dub: sourceNamespace: dub - sourceRevisionDigest: sha256:1258645d97256e7059146a881aec490187e3f874dfbffabd3249eadb0c5bf641 - sourceBlobDigest: sha256:c73395e1465003dee50ff36dcfa0b11b34b6e363d8c1a67986eab4049ec059e3 + sourceRevisionDigest: sha256:c2a6cafd7356b24ab4e2b2ec6fb69f9228296f936d4770bc3f47dbd68a6ea728 + sourceBlobDigest: sha256:801e94947f41ed448f426fa0996e8f84a12226d2d653c8edba0540ea13ebd922 tags: - latest - - speakeasy-sdk-regen-1741048062 + - speakeasy-sdk-regen-1741134471 - 0.0.1 targets: my-first-target: source: dub sourceNamespace: dub - sourceRevisionDigest: sha256:1258645d97256e7059146a881aec490187e3f874dfbffabd3249eadb0c5bf641 - sourceBlobDigest: sha256:c73395e1465003dee50ff36dcfa0b11b34b6e363d8c1a67986eab4049ec059e3 + sourceRevisionDigest: sha256:c2a6cafd7356b24ab4e2b2ec6fb69f9228296f936d4770bc3f47dbd68a6ea728 + sourceBlobDigest: sha256:801e94947f41ed448f426fa0996e8f84a12226d2d653c8edba0540ea13ebd922 codeSamplesNamespace: code-samples-ruby-my-first-target - codeSamplesRevisionDigest: sha256:3af1bcce8dabe9309fe63243e073d0c59d30034ea499f124c71b91b1a3c1932c + codeSamplesRevisionDigest: sha256:bac1a5c05560494664af3fc6b34966f8ab410447f321dcbb6bcdd68b8758c490 workflow: workflowVersion: 1.0.0 speakeasyVersion: latest diff --git a/Gemfile.lock b/Gemfile.lock index 320fce2..1a686b8 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - dub (0.2.2.pre.alpha.74) + dub (0.2.2.pre.alpha.75) faraday faraday-multipart rack @@ -37,7 +37,7 @@ GEM racc prism (0.27.0) racc (1.8.1) - rack (3.1.10) + rack (3.1.11) rainbow (3.1.1) rake (13.2.1) rbi (0.1.12) diff --git a/README.md b/README.md index b1b9de6..36da29f 100644 --- a/README.md +++ b/README.md @@ -131,7 +131,7 @@ end ### [embed_tokens](docs/sdks/embedtokens/README.md) -* [create](docs/sdks/embedtokens/README.md#create) - Create a new embed token +* [referrals](docs/sdks/embedtokens/README.md#referrals) - Create a new referrals embed token ### [events](docs/sdks/events/README.md) diff --git a/RELEASES.md b/RELEASES.md index 82188e8..056c4a2 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -888,4 +888,14 @@ Based on: ### Generated - [ruby v0.2.2-alpha.74] . ### Releases -- [Ruby Gems v0.2.2-alpha.74] https://rubygems.org/gems/dub/versions/0.2.2-alpha.74 - . \ No newline at end of file +- [Ruby Gems v0.2.2-alpha.74] https://rubygems.org/gems/dub/versions/0.2.2-alpha.74 - . + +## 2025-03-05 00:27:35 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.509.1 (2.539.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [ruby v0.2.2-alpha.75] . +### Releases +- [Ruby Gems v0.2.2-alpha.75] https://rubygems.org/gems/dub/versions/0.2.2-alpha.75 - . \ No newline at end of file diff --git a/codeSamples.yaml b/codeSamples.yaml index 728202c..a30c337 100644 --- a/codeSamples.yaml +++ b/codeSamples.yaml @@ -158,7 +158,7 @@ actions: "x-codeSamples": - "lang": "ruby" "label": "createPartner" - "source": "require 'dub'\n\n\ns = ::OpenApiSDK::Dub.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n token: \"DUB_API_KEY\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::CreatePartnerRequestBody.new(\n program_id: \"\",\n name: \"\",\n email: \"Loyal79@yahoo.com\",\n username: \"Aaliyah_Borer\",\n link_props: ::OpenApiSDK::Operations::LinkProps.new(\n external_id: \"123456\",\n tag_ids: [\n \"clux0rgak00011...\",\n ],\n ),\n)\n \nres = s.partners.create(req)\n\nif ! res.object.nil?\n # handle response\nend" + "source": "require 'dub'\n\n\ns = ::OpenApiSDK::Dub.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n token: \"DUB_API_KEY\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::CreatePartnerRequestBody.new(\n program_id: \"\",\n name: \"\",\n email: \"Loyal79@yahoo.com\",\n link_props: ::OpenApiSDK::Operations::LinkProps.new(\n external_id: \"123456\",\n tag_ids: [\n \"clux0rgak00011...\",\n ],\n ),\n)\n \nres = s.partners.create(req)\n\nif ! res.object.nil?\n # handle response\nend" - target: $["paths"]["/partners/analytics"]["get"] update: "x-codeSamples": @@ -213,12 +213,12 @@ actions: - "lang": "ruby" "label": "updateTag" "source": "require 'dub'\n\n\ns = ::OpenApiSDK::Dub.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n token: \"DUB_API_KEY\",\n )\n)\n\n \nres = s.tags.update(id=\"\", request_body=::OpenApiSDK::Operations::UpdateTagRequestBody.new())\n\nif ! res.tag_schema.nil?\n # handle response\nend" - - target: $["paths"]["/tokens/embed"]["post"] + - target: $["paths"]["/tokens/embed/referrals"]["post"] update: "x-codeSamples": - "lang": "ruby" - "label": "createEmbedToken" - "source": "require 'dub'\n\n\ns = ::OpenApiSDK::Dub.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n token: \"DUB_API_KEY\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::CreateEmbedTokenRequestBody.new(\n program_id: \"\",\n)\n \nres = s.embed_tokens.create(req)\n\nif ! res.object.nil?\n # handle response\nend" + "label": "createReferralsEmbedToken" + "source": "require 'dub'\n\n\ns = ::OpenApiSDK::Dub.new\ns.config_security(\n ::OpenApiSDK::Shared::Security.new(\n token: \"DUB_API_KEY\",\n )\n)\n\n\nreq = ::OpenApiSDK::Operations::CreateReferralsEmbedTokenRequestBody.new(\n program_id: \"\",\n partner: ::OpenApiSDK::Operations::Partner.new(\n name: \"\",\n email: \"Florencio98@hotmail.com\",\n link_props: ::OpenApiSDK::Operations::CreateReferralsEmbedTokenLinkProps.new(\n external_id: \"123456\",\n tag_ids: [\n \"clux0rgak00011...\",\n ],\n ),\n ),\n)\n \nres = s.embed_tokens.referrals(req)\n\nif ! res.object.nil?\n # handle response\nend" - target: $["paths"]["/track/lead"]["post"] update: "x-codeSamples": diff --git a/docs/models/operations/createembedtokenrequestbody.md b/docs/models/operations/createembedtokenrequestbody.md deleted file mode 100644 index 99edf42..0000000 --- a/docs/models/operations/createembedtokenrequestbody.md +++ /dev/null @@ -1,10 +0,0 @@ -# CreateEmbedTokenRequestBody - - -## Fields - -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `program_id` | *::String* | :heavy_check_mark: | N/A | -| `partner_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | -| `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createpartnerlinklinkprops.md b/docs/models/operations/createpartnerlinklinkprops.md index 574f927..9a8fb9e 100644 --- a/docs/models/operations/createpartnerlinklinkprops.md +++ b/docs/models/operations/createpartnerlinklinkprops.md @@ -9,7 +9,6 @@ Additional properties that you can pass to the partner's short link. Will be use | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `external_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | 123456 | | `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | -| `partner_id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID of the partner the short link is associated with. | | | `prefix` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | | `archived` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | | `tag_ids` | *T.nilable(::Object)* | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | diff --git a/docs/models/operations/createpartnerrequestbody.md b/docs/models/operations/createpartnerrequestbody.md index 44aa288..10f3843 100644 --- a/docs/models/operations/createpartnerrequestbody.md +++ b/docs/models/operations/createpartnerrequestbody.md @@ -3,14 +3,14 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | -| `program_id` | *::String* | :heavy_check_mark: | The ID of the program to create a partner for. | -| `name` | *::String* | :heavy_check_mark: | Full legal name of the partner. | -| `email` | *::String* | :heavy_check_mark: | Email for the partner in your system. Partners will be able to claim their profile by signing up to Dub Partners with this email. | -| `username` | *::String* | :heavy_check_mark: | A unique username for the partner in your system. This will be used to create a short link for the partner using your program's default domain. | -| `image` | *T.nilable(::String)* | :heavy_minus_sign: | Avatar image for the partner – if not provided, a default avatar will be used. | -| `country` | [T.nilable(::OpenApiSDK::Operations::Country)](../../models/operations/country.md) | :heavy_minus_sign: | Country where the partner is based. | -| `description` | *T.nilable(::String)* | :heavy_minus_sign: | A brief description of the partner and their background. | -| `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID of the partner in your system. | -| `link_props` | [T.nilable(::OpenApiSDK::Operations::LinkProps)](../../models/operations/linkprops.md) | :heavy_minus_sign: | Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `program_id` | *::String* | :heavy_check_mark: | The ID of the program to create a partner for. | +| `name` | *::String* | :heavy_check_mark: | Full legal name of the partner. | +| `email` | *::String* | :heavy_check_mark: | Email for the partner in your system. Partners will be able to claim their profile by signing up to Dub Partners with this email. | +| `username` | *T.nilable(::String)* | :heavy_minus_sign: | A unique username for the partner in your system (max 100 characters). This will be used to create a short link for the partner using your program's default domain. If not provided, Dub will try to generate a username from the partner's name or email. | +| `image` | *T.nilable(::String)* | :heavy_minus_sign: | Avatar image for the partner – if not provided, a default avatar will be used. | +| `country` | [T.nilable(::OpenApiSDK::Operations::Country)](../../models/operations/country.md) | :heavy_minus_sign: | Country where the partner is based. | +| `description` | *T.nilable(::String)* | :heavy_minus_sign: | A brief description of the partner and their background. | +| `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID of the partner in your system. | +| `link_props` | [T.nilable(::OpenApiSDK::Operations::LinkProps)](../../models/operations/linkprops.md) | :heavy_minus_sign: | Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. | \ No newline at end of file diff --git a/docs/models/operations/createreferralsembedtokencountry.md b/docs/models/operations/createreferralsembedtokencountry.md new file mode 100644 index 0000000..9a6b1f1 --- /dev/null +++ b/docs/models/operations/createreferralsembedtokencountry.md @@ -0,0 +1,259 @@ +# CreateReferralsEmbedTokenCountry + +Country where the partner is based. + + +## Values + +| Name | Value | +| ----- | ----- | +| `AF` | AF | +| `AL` | AL | +| `DZ` | DZ | +| `AS` | AS | +| `AD` | AD | +| `AO` | AO | +| `AI` | AI | +| `AQ` | AQ | +| `AG` | AG | +| `AR` | AR | +| `AM` | AM | +| `AW` | AW | +| `AU` | AU | +| `AT` | AT | +| `AZ` | AZ | +| `BS` | BS | +| `BH` | BH | +| `BD` | BD | +| `BB` | BB | +| `BY` | BY | +| `BE` | BE | +| `BZ` | BZ | +| `BJ` | BJ | +| `BM` | BM | +| `BT` | BT | +| `BO` | BO | +| `BA` | BA | +| `BW` | BW | +| `BV` | BV | +| `BR` | BR | +| `IO` | IO | +| `BN` | BN | +| `BG` | BG | +| `BF` | BF | +| `BI` | BI | +| `KH` | KH | +| `CM` | CM | +| `CA` | CA | +| `CV` | CV | +| `KY` | KY | +| `CF` | CF | +| `TD` | TD | +| `CL` | CL | +| `CN` | CN | +| `CX` | CX | +| `CC` | CC | +| `CO` | CO | +| `KM` | KM | +| `CG` | CG | +| `CD` | CD | +| `CK` | CK | +| `CR` | CR | +| `CI` | CI | +| `HR` | HR | +| `CU` | CU | +| `CY` | CY | +| `CZ` | CZ | +| `DK` | DK | +| `DJ` | DJ | +| `DM` | DM | +| `DO` | DO | +| `EC` | EC | +| `EG` | EG | +| `SV` | SV | +| `GQ` | GQ | +| `ER` | ER | +| `EE` | EE | +| `ET` | ET | +| `FK` | FK | +| `FO` | FO | +| `FJ` | FJ | +| `FI` | FI | +| `FR` | FR | +| `GF` | GF | +| `PF` | PF | +| `TF` | TF | +| `GA` | GA | +| `GM` | GM | +| `GE` | GE | +| `DE` | DE | +| `GH` | GH | +| `GI` | GI | +| `GR` | GR | +| `GL` | GL | +| `GD` | GD | +| `GP` | GP | +| `GU` | GU | +| `GT` | GT | +| `GN` | GN | +| `GW` | GW | +| `GY` | GY | +| `HT` | HT | +| `HM` | HM | +| `VA` | VA | +| `HN` | HN | +| `HK` | HK | +| `HU` | HU | +| `IS` | IS | +| `IN` | IN | +| `ID` | ID | +| `IR` | IR | +| `IQ` | IQ | +| `IE` | IE | +| `IL` | IL | +| `IT` | IT | +| `JM` | JM | +| `JP` | JP | +| `JO` | JO | +| `KZ` | KZ | +| `KE` | KE | +| `KI` | KI | +| `KP` | KP | +| `KR` | KR | +| `KW` | KW | +| `KG` | KG | +| `LA` | LA | +| `LV` | LV | +| `LB` | LB | +| `LS` | LS | +| `LR` | LR | +| `LY` | LY | +| `LI` | LI | +| `LT` | LT | +| `LU` | LU | +| `MO` | MO | +| `MG` | MG | +| `MW` | MW | +| `MY` | MY | +| `MV` | MV | +| `ML` | ML | +| `MT` | MT | +| `MH` | MH | +| `MQ` | MQ | +| `MR` | MR | +| `MU` | MU | +| `YT` | YT | +| `MX` | MX | +| `FM` | FM | +| `MD` | MD | +| `MC` | MC | +| `MN` | MN | +| `MS` | MS | +| `MA` | MA | +| `MZ` | MZ | +| `MM` | MM | +| `NA` | NA | +| `NR` | NR | +| `NP` | NP | +| `NL` | NL | +| `NC` | NC | +| `NZ` | NZ | +| `NI` | NI | +| `NE` | NE | +| `NG` | NG | +| `NU` | NU | +| `NF` | NF | +| `MK` | MK | +| `MP` | MP | +| `NO` | NO | +| `OM` | OM | +| `PK` | PK | +| `PW` | PW | +| `PS` | PS | +| `PA` | PA | +| `PG` | PG | +| `PY` | PY | +| `PE` | PE | +| `PH` | PH | +| `PN` | PN | +| `PL` | PL | +| `PT` | PT | +| `PR` | PR | +| `QA` | QA | +| `RE` | RE | +| `RO` | RO | +| `RU` | RU | +| `RW` | RW | +| `SH` | SH | +| `KN` | KN | +| `LC` | LC | +| `PM` | PM | +| `VC` | VC | +| `WS` | WS | +| `SM` | SM | +| `ST` | ST | +| `SA` | SA | +| `SN` | SN | +| `SC` | SC | +| `SL` | SL | +| `SG` | SG | +| `SK` | SK | +| `SI` | SI | +| `SB` | SB | +| `SO` | SO | +| `ZA` | ZA | +| `GS` | GS | +| `ES` | ES | +| `LK` | LK | +| `SD` | SD | +| `SR` | SR | +| `SJ` | SJ | +| `SZ` | SZ | +| `SE` | SE | +| `CH` | CH | +| `SY` | SY | +| `TW` | TW | +| `TJ` | TJ | +| `TZ` | TZ | +| `TH` | TH | +| `TL` | TL | +| `TG` | TG | +| `TK` | TK | +| `TO` | TO | +| `TT` | TT | +| `TN` | TN | +| `TR` | TR | +| `TM` | TM | +| `TC` | TC | +| `TV` | TV | +| `UG` | UG | +| `UA` | UA | +| `AE` | AE | +| `GB` | GB | +| `US` | US | +| `UM` | UM | +| `UY` | UY | +| `UZ` | UZ | +| `VU` | VU | +| `VE` | VE | +| `VN` | VN | +| `VG` | VG | +| `VI` | VI | +| `WF` | WF | +| `EH` | EH | +| `YE` | YE | +| `ZM` | ZM | +| `ZW` | ZW | +| `AX` | AX | +| `BQ` | BQ | +| `CW` | CW | +| `GG` | GG | +| `IM` | IM | +| `JE` | JE | +| `ME` | ME | +| `BL` | BL | +| `MF` | MF | +| `RS` | RS | +| `SX` | SX | +| `SS` | SS | +| `XK` | XK | \ No newline at end of file diff --git a/docs/models/operations/createreferralsembedtokenlinkprops.md b/docs/models/operations/createreferralsembedtokenlinkprops.md new file mode 100644 index 0000000..ba026e1 --- /dev/null +++ b/docs/models/operations/createreferralsembedtokenlinkprops.md @@ -0,0 +1,35 @@ +# CreateReferralsEmbedTokenLinkProps + +Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. + + +## Fields + +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `external_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | 123456 | +| `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | +| `prefix` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | +| `archived` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | +| `tag_ids` | *T.nilable(::Object)* | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | +| `tag_names` | *T.nilable(::Object)* | :heavy_minus_sign: | The unique name of the tags assigned to the short link (case insensitive). | | +| `folder_id` | *T.nilable(::String)* | :heavy_minus_sign: | The unique ID existing folder to assign the short link to. | | +| `comments` | *T.nilable(::String)* | :heavy_minus_sign: | The comments for the short link. | | +| `expires_at` | *T.nilable(::String)* | :heavy_minus_sign: | The date and time when the short link will expire at. | | +| `expired_url` | *T.nilable(::String)* | :heavy_minus_sign: | The URL to redirect to when the short link has expired. | | +| `password` | *T.nilable(::String)* | :heavy_minus_sign: | The password required to access the destination URL of the short link. | | +| `proxy` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. | | +| `title` | *T.nilable(::String)* | :heavy_minus_sign: | 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 | | +| `description` | *T.nilable(::String)* | :heavy_minus_sign: | 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 | | +| `image` | *T.nilable(::String)* | :heavy_minus_sign: | 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 | | +| `video` | *T.nilable(::String)* | :heavy_minus_sign: | 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 | | +| `rewrite` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the short link uses link cloaking. Defaults to `false` if not provided. | | +| `ios` | *T.nilable(::String)* | :heavy_minus_sign: | The iOS destination URL for the short link for iOS device targeting. | | +| `android` | *T.nilable(::String)* | :heavy_minus_sign: | The Android destination URL for the short link for Android device targeting. | | +| `do_index` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex | | +| `utm_source` | *T.nilable(::String)* | :heavy_minus_sign: | The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. | | +| `utm_medium` | *T.nilable(::String)* | :heavy_minus_sign: | The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. | | +| `utm_campaign` | *T.nilable(::String)* | :heavy_minus_sign: | The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. | | +| `utm_term` | *T.nilable(::String)* | :heavy_minus_sign: | The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. | | +| `utm_content` | *T.nilable(::String)* | :heavy_minus_sign: | The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. | | +| `ref` | *T.nilable(::String)* | :heavy_minus_sign: | The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. | | \ No newline at end of file diff --git a/docs/models/operations/createreferralsembedtokenrequestbody.md b/docs/models/operations/createreferralsembedtokenrequestbody.md new file mode 100644 index 0000000..8a71708 --- /dev/null +++ b/docs/models/operations/createreferralsembedtokenrequestbody.md @@ -0,0 +1,11 @@ +# CreateReferralsEmbedTokenRequestBody + + +## Fields + +| Field | Type | Required | Description | +| ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `program_id` | *::String* | :heavy_check_mark: | N/A | +| `partner_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | +| `partner` | [T.nilable(::OpenApiSDK::Operations::Partner)](../../models/operations/partner.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/createembedtokenresponse.md b/docs/models/operations/createreferralsembedtokenresponse.md similarity index 98% rename from docs/models/operations/createembedtokenresponse.md rename to docs/models/operations/createreferralsembedtokenresponse.md index e3975ad..ce74530 100644 --- a/docs/models/operations/createembedtokenresponse.md +++ b/docs/models/operations/createreferralsembedtokenresponse.md @@ -1,4 +1,4 @@ -# CreateEmbedTokenResponse +# CreateReferralsEmbedTokenResponse ## Fields @@ -8,7 +8,7 @@ | `content_type` | *::String* | :heavy_check_mark: | HTTP response content type for this operation | | `status_code` | *::Integer* | :heavy_check_mark: | HTTP response status code for this operation | | `raw_response` | [Faraday::Response](https://www.rubydoc.info/gems/faraday/Faraday/Response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -| `object` | [T.nilable(::OpenApiSDK::Operations::CreateEmbedTokenResponseBody)](../../models/operations/createembedtokenresponsebody.md) | :heavy_minus_sign: | The created public embed token. | +| `object` | [T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenResponseBody)](../../models/operations/createreferralsembedtokenresponsebody.md) | :heavy_minus_sign: | The created public embed token. | | `bad_request` | [T.nilable(::OpenApiSDK::Shared::BadRequest)](../../models/shared/badrequest.md) | :heavy_minus_sign: | 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). | | `unauthorized` | [T.nilable(::OpenApiSDK::Shared::Unauthorized)](../../models/shared/unauthorized.md) | :heavy_minus_sign: | Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. | | `forbidden` | [T.nilable(::OpenApiSDK::Shared::Forbidden)](../../models/shared/forbidden.md) | :heavy_minus_sign: | 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. | diff --git a/docs/models/operations/createembedtokenresponsebody.md b/docs/models/operations/createreferralsembedtokenresponsebody.md similarity index 90% rename from docs/models/operations/createembedtokenresponsebody.md rename to docs/models/operations/createreferralsembedtokenresponsebody.md index 98ce485..5f568c4 100644 --- a/docs/models/operations/createembedtokenresponsebody.md +++ b/docs/models/operations/createreferralsembedtokenresponsebody.md @@ -1,4 +1,4 @@ -# CreateEmbedTokenResponseBody +# CreateReferralsEmbedTokenResponseBody The created public embed token. diff --git a/docs/models/operations/getcustomerspartner.md b/docs/models/operations/getcustomerspartner.md new file mode 100644 index 0000000..37b40b2 --- /dev/null +++ b/docs/models/operations/getcustomerspartner.md @@ -0,0 +1,11 @@ +# GetCustomersPartner + + +## Fields + +| Field | Type | Required | Description | +| --------------------- | --------------------- | --------------------- | --------------------- | +| `id` | *::String* | :heavy_check_mark: | N/A | +| `name` | *::String* | :heavy_check_mark: | N/A | +| `email` | *::String* | :heavy_check_mark: | N/A | +| `image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/interval.md b/docs/models/operations/interval.md index 4dd0a27..e4a99cc 100644 --- a/docs/models/operations/interval.md +++ b/docs/models/operations/interval.md @@ -5,15 +5,14 @@ The interval to retrieve analytics for. If undefined, defaults to 24h. ## Values -| Name | Value | -| ---------------- | ---------------- | -| `TWENTY_FOURH` | 24h | -| `SEVEND` | 7d | -| `THIRTYD` | 30d | -| `NINETYD` | 90d | -| `ONEY` | 1y | -| `MTD` | mtd | -| `QTD` | qtd | -| `YTD` | ytd | -| `ALL` | all | -| `ALL_UNFILTERED` | all_unfiltered | \ No newline at end of file +| Name | Value | +| -------------- | -------------- | +| `TWENTY_FOURH` | 24h | +| `SEVEND` | 7d | +| `THIRTYD` | 30d | +| `NINETYD` | 90d | +| `ONEY` | 1y | +| `MTD` | mtd | +| `QTD` | qtd | +| `YTD` | ytd | +| `ALL` | all | \ No newline at end of file diff --git a/docs/models/operations/linkprops.md b/docs/models/operations/linkprops.md index 74d6c33..2a08f6a 100644 --- a/docs/models/operations/linkprops.md +++ b/docs/models/operations/linkprops.md @@ -9,7 +9,6 @@ Additional properties that you can pass to the partner's short link. Will be use | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `external_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | 123456 | | `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | -| `partner_id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID of the partner the short link is associated with. | | | `prefix` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | | `archived` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | | `tag_ids` | *T.nilable(::Object)* | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | diff --git a/docs/models/operations/partner.md b/docs/models/operations/partner.md index a755446..e11d2cb 100644 --- a/docs/models/operations/partner.md +++ b/docs/models/operations/partner.md @@ -3,9 +3,13 @@ ## Fields -| Field | Type | Required | Description | -| --------------------- | --------------------- | --------------------- | --------------------- | -| `id` | *::String* | :heavy_check_mark: | N/A | -| `name` | *::String* | :heavy_check_mark: | N/A | -| `email` | *::String* | :heavy_check_mark: | N/A | -| `image` | *T.nilable(::String)* | :heavy_minus_sign: | N/A | \ No newline at end of file +| Field | Type | Required | Description | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `name` | *::String* | :heavy_check_mark: | Full legal name of the partner. | +| `email` | *::String* | :heavy_check_mark: | Email for the partner in your system. Partners will be able to claim their profile by signing up to Dub Partners with this email. | +| `username` | *T.nilable(::String)* | :heavy_minus_sign: | A unique username for the partner in your system (max 100 characters). This will be used to create a short link for the partner using your program's default domain. If not provided, Dub will try to generate a username from the partner's name or email. | +| `image` | *T.nilable(::String)* | :heavy_minus_sign: | Avatar image for the partner – if not provided, a default avatar will be used. | +| `country` | [T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenCountry)](../../models/operations/createreferralsembedtokencountry.md) | :heavy_minus_sign: | Country where the partner is based. | +| `description` | *T.nilable(::String)* | :heavy_minus_sign: | A brief description of the partner and their background. | +| `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID of the partner in your system. | +| `link_props` | [T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenLinkProps)](../../models/operations/createreferralsembedtokenlinkprops.md) | :heavy_minus_sign: | Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. | \ No newline at end of file diff --git a/docs/models/operations/responsebody.md b/docs/models/operations/responsebody.md index 9ae67a1..9416ba6 100644 --- a/docs/models/operations/responsebody.md +++ b/docs/models/operations/responsebody.md @@ -13,5 +13,5 @@ | `country` | *T.nilable(::String)* | :heavy_minus_sign: | Country of the customer. | | `created_at` | *::String* | :heavy_check_mark: | The date the customer was created. | | `link` | [T.nilable(::OpenApiSDK::Operations::Link)](../../models/operations/link.md) | :heavy_minus_sign: | N/A | -| `partner` | [T.nilable(::OpenApiSDK::Operations::Partner)](../../models/operations/partner.md) | :heavy_minus_sign: | N/A | +| `partner` | [T.nilable(::OpenApiSDK::Operations::GetCustomersPartner)](../../models/operations/getcustomerspartner.md) | :heavy_minus_sign: | N/A | | `discount` | [T.nilable(::OpenApiSDK::Operations::Discount)](../../models/operations/discount.md) | :heavy_minus_sign: | N/A | \ No newline at end of file diff --git a/docs/models/operations/retrievepartneranalyticsqueryparaminterval.md b/docs/models/operations/retrievepartneranalyticsqueryparaminterval.md index 58292fb..6e6d67d 100644 --- a/docs/models/operations/retrievepartneranalyticsqueryparaminterval.md +++ b/docs/models/operations/retrievepartneranalyticsqueryparaminterval.md @@ -5,15 +5,14 @@ The interval to retrieve analytics for. If undefined, defaults to 24h. ## Values -| Name | Value | -| ---------------- | ---------------- | -| `TWENTY_FOURH` | 24h | -| `SEVEND` | 7d | -| `THIRTYD` | 30d | -| `NINETYD` | 90d | -| `ONEY` | 1y | -| `MTD` | mtd | -| `QTD` | qtd | -| `YTD` | ytd | -| `ALL` | all | -| `ALL_UNFILTERED` | all_unfiltered | \ No newline at end of file +| Name | Value | +| -------------- | -------------- | +| `TWENTY_FOURH` | 24h | +| `SEVEND` | 7d | +| `THIRTYD` | 30d | +| `NINETYD` | 90d | +| `ONEY` | 1y | +| `MTD` | mtd | +| `QTD` | qtd | +| `YTD` | ytd | +| `ALL` | all | \ No newline at end of file diff --git a/docs/models/operations/upsertpartnerlinklinkprops.md b/docs/models/operations/upsertpartnerlinklinkprops.md index 46cb771..1e6d4e8 100644 --- a/docs/models/operations/upsertpartnerlinklinkprops.md +++ b/docs/models/operations/upsertpartnerlinklinkprops.md @@ -9,7 +9,6 @@ Additional properties that you can pass to the partner's short link. Will be use | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `external_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | 123456 | | `tenant_id` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | -| `partner_id` | *T.nilable(::String)* | :heavy_minus_sign: | The ID of the partner the short link is associated with. | | | `prefix` | *T.nilable(::String)* | :heavy_minus_sign: | 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. | | | `archived` | *T.nilable(T::Boolean)* | :heavy_minus_sign: | Whether the short link is archived. Defaults to `false` if not provided. | | | `tag_ids` | *T.nilable(::Object)* | :heavy_minus_sign: | The unique IDs of the tags assigned to the short link. | [
"clux0rgak00011..."
] | diff --git a/docs/sdks/embedtokens/README.md b/docs/sdks/embedtokens/README.md index c677e25..f498422 100644 --- a/docs/sdks/embedtokens/README.md +++ b/docs/sdks/embedtokens/README.md @@ -5,11 +5,11 @@ ### Available Operations -* [create](#create) - Create a new embed token +* [referrals](#referrals) - Create a new referrals embed token -## create +## referrals -Create a new embed token for the referral link. +Create a new referrals embed token for the given partner/tenant. ### Example Usage @@ -25,11 +25,21 @@ s.config_security( ) -req = ::OpenApiSDK::Operations::CreateEmbedTokenRequestBody.new( +req = ::OpenApiSDK::Operations::CreateReferralsEmbedTokenRequestBody.new( program_id: "", + partner: ::OpenApiSDK::Operations::Partner.new( + name: "", + email: "Florencio98@hotmail.com", + link_props: ::OpenApiSDK::Operations::CreateReferralsEmbedTokenLinkProps.new( + external_id: "123456", + tag_ids: [ + "clux0rgak00011...", + ], + ), + ), ) -res = s.embed_tokens.create(req) +res = s.embed_tokens.referrals(req) if ! res.object.nil? # handle response @@ -39,11 +49,11 @@ end ### Parameters -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | -| `request` | [::OpenApiSDK::Operations::CreateEmbedTokenRequestBody](../../models/operations/createembedtokenrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| `request` | [::OpenApiSDK::Operations::CreateReferralsEmbedTokenRequestBody](../../models/operations/createreferralsembedtokenrequestbody.md) | :heavy_check_mark: | The request object to use for the request. | ### Response -**[T.nilable(::OpenApiSDK::Operations::CreateEmbedTokenResponse)](../../models/operations/createembedtokenresponse.md)** +**[T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenResponse)](../../models/operations/createreferralsembedtokenresponse.md)** diff --git a/docs/sdks/partners/README.md b/docs/sdks/partners/README.md index f68aac3..9ba3519 100644 --- a/docs/sdks/partners/README.md +++ b/docs/sdks/partners/README.md @@ -33,7 +33,6 @@ req = ::OpenApiSDK::Operations::CreatePartnerRequestBody.new( program_id: "", name: "", email: "Loyal79@yahoo.com", - username: "Aaliyah_Borer", link_props: ::OpenApiSDK::Operations::LinkProps.new( external_id: "123456", tag_ids: [ diff --git a/dub.gemspec b/dub.gemspec index b5a4df9..93f4961 100644 --- a/dub.gemspec +++ b/dub.gemspec @@ -4,7 +4,7 @@ $LOAD_PATH.push File.expand_path('lib', __dir__) Gem::Specification.new do |s| s.name = 'dub' - s.version = '0.2.2-alpha.74' + s.version = '0.2.2-alpha.75' s.platform = Gem::Platform::RUBY s.licenses = ['Apache-2.0'] s.summary = '' diff --git a/lib/open_api_sdk/embed_tokens.rb b/lib/open_api_sdk/embed_tokens.rb index 7579099..34b0398 100644 --- a/lib/open_api_sdk/embed_tokens.rb +++ b/lib/open_api_sdk/embed_tokens.rb @@ -19,13 +19,13 @@ def initialize(sdk_config) end - sig { params(request: T.nilable(::OpenApiSDK::Operations::CreateEmbedTokenRequestBody)).returns(::OpenApiSDK::Operations::CreateEmbedTokenResponse) } - def create(request) - # create - Create a new embed token - # Create a new embed token for the referral link. + sig { params(request: T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenRequestBody)).returns(::OpenApiSDK::Operations::CreateReferralsEmbedTokenResponse) } + def referrals(request) + # referrals - Create a new referrals embed token + # Create a new referrals embed token for the given partner/tenant. url, params = @sdk_configuration.get_server_details base_url = Utils.template_url(url, params) - url = "#{base_url}/tokens/embed" + url = "#{base_url}/tokens/embed/referrals" headers = {} req_content_type, data, form = Utils.serialize_request_body(request, :request, :json) headers['content-type'] = req_content_type @@ -47,12 +47,12 @@ def create(request) content_type = r.headers.fetch('Content-Type', 'application/octet-stream') - res = ::OpenApiSDK::Operations::CreateEmbedTokenResponse.new( + res = ::OpenApiSDK::Operations::CreateReferralsEmbedTokenResponse.new( status_code: r.status, content_type: content_type, raw_response: r ) if r.status == 201 if Utils.match_content_type(content_type, 'application/json') - out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Operations::CreateEmbedTokenResponseBody) + out = Crystalline.unmarshal_json(JSON.parse(r.env.response_body), ::OpenApiSDK::Operations::CreateReferralsEmbedTokenResponseBody) res.object = out end elsif r.status == 400 diff --git a/lib/open_api_sdk/models/operations.rb b/lib/open_api_sdk/models/operations.rb index e1366b3..cff0794 100644 --- a/lib/open_api_sdk/models/operations.rb +++ b/lib/open_api_sdk/models/operations.rb @@ -96,7 +96,7 @@ module Operations autoload :TrackSaleResponse, 'open_api_sdk/models/operations/tracksale_response.rb' autoload :GetCustomersRequest, 'open_api_sdk/models/operations/getcustomers_request.rb' autoload :Link, 'open_api_sdk/models/operations/link.rb' - autoload :Partner, 'open_api_sdk/models/operations/partner.rb' + autoload :GetCustomersPartner, 'open_api_sdk/models/operations/getcustomers_partner.rb' autoload :Type, 'open_api_sdk/models/operations/type.rb' autoload :GetCustomersInterval, 'open_api_sdk/models/operations/getcustomers_interval.rb' autoload :Discount, 'open_api_sdk/models/operations/discount.rb' @@ -156,9 +156,12 @@ module Operations autoload :UpdateWorkspaceRequestBody, 'open_api_sdk/models/operations/updateworkspace_requestbody.rb' autoload :UpdateWorkspaceRequest, 'open_api_sdk/models/operations/updateworkspace_request.rb' autoload :UpdateWorkspaceResponse, 'open_api_sdk/models/operations/updateworkspace_response.rb' - autoload :CreateEmbedTokenRequestBody, 'open_api_sdk/models/operations/createembedtoken_requestbody.rb' - autoload :CreateEmbedTokenResponseBody, 'open_api_sdk/models/operations/createembedtoken_responsebody.rb' - autoload :CreateEmbedTokenResponse, 'open_api_sdk/models/operations/createembedtoken_response.rb' + autoload :CreateReferralsEmbedTokenCountry, 'open_api_sdk/models/operations/createreferralsembedtoken_country.rb' + autoload :CreateReferralsEmbedTokenLinkProps, 'open_api_sdk/models/operations/createreferralsembedtoken_linkprops.rb' + autoload :Partner, 'open_api_sdk/models/operations/partner.rb' + autoload :CreateReferralsEmbedTokenRequestBody, 'open_api_sdk/models/operations/createreferralsembedtoken_requestbody.rb' + autoload :CreateReferralsEmbedTokenResponseBody, 'open_api_sdk/models/operations/createreferralsembedtoken_responsebody.rb' + autoload :CreateReferralsEmbedTokenResponse, 'open_api_sdk/models/operations/createreferralsembedtoken_response.rb' autoload :Level, 'open_api_sdk/models/operations/level.rb' autoload :GetQRCodeRequest, 'open_api_sdk/models/operations/getqrcode_request.rb' autoload :GetQRCodeResponse, 'open_api_sdk/models/operations/getqrcode_response.rb' diff --git a/lib/open_api_sdk/models/operations/createpartner_requestbody.rb b/lib/open_api_sdk/models/operations/createpartner_requestbody.rb index 13d7638..07f593f 100644 --- a/lib/open_api_sdk/models/operations/createpartner_requestbody.rb +++ b/lib/open_api_sdk/models/operations/createpartner_requestbody.rb @@ -17,8 +17,6 @@ class CreatePartnerRequestBody < ::Crystalline::FieldAugmented field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } } # The ID of the program to create a partner for. field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } } - # A unique username for the partner in your system. This will be used to create a short link for the partner using your program's default domain. - field :username, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('username') } } # Country where the partner is based. field :country, T.nilable(::OpenApiSDK::Operations::Country), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('country'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::Country, true) } } # A brief description of the partner and their background. @@ -29,19 +27,21 @@ class CreatePartnerRequestBody < ::Crystalline::FieldAugmented field :link_props, T.nilable(::OpenApiSDK::Operations::LinkProps), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('linkProps') } } # The ID of the partner in your system. field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } } + # A unique username for the partner in your system (max 100 characters). This will be used to create a short link for the partner using your program's default domain. If not provided, Dub will try to generate a username from the partner's name or email. + field :username, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('username') } } - sig { params(email: ::String, name: ::String, program_id: ::String, username: ::String, country: T.nilable(::OpenApiSDK::Operations::Country), description: T.nilable(::String), image: T.nilable(::String), link_props: T.nilable(::OpenApiSDK::Operations::LinkProps), tenant_id: T.nilable(::String)).void } - def initialize(email: nil, name: nil, program_id: nil, username: nil, country: nil, description: nil, image: nil, link_props: nil, tenant_id: nil) + sig { params(email: ::String, name: ::String, program_id: ::String, country: T.nilable(::OpenApiSDK::Operations::Country), description: T.nilable(::String), image: T.nilable(::String), link_props: T.nilable(::OpenApiSDK::Operations::LinkProps), tenant_id: T.nilable(::String), username: T.nilable(::String)).void } + def initialize(email: nil, name: nil, program_id: nil, country: nil, description: nil, image: nil, link_props: nil, tenant_id: nil, username: nil) @email = email @name = name @program_id = program_id - @username = username @country = country @description = description @image = image @link_props = link_props @tenant_id = tenant_id + @username = username end end end diff --git a/lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb b/lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb index 62572be..a84e92e 100644 --- a/lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb +++ b/lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb @@ -33,8 +33,6 @@ class CreatePartnerLinkLinkProps < ::Crystalline::FieldAugmented field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } } # The iOS destination URL for the short link for iOS device targeting. field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } } - # The ID of the partner the short link is associated with. - field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } } # The password required to access the destination URL of the short link. field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } } # The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided. @@ -67,8 +65,8 @@ class CreatePartnerLinkLinkProps < ::Crystalline::FieldAugmented field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } } - 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 } - 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) + 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), 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 } + 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, 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) @android = android @archived = archived @comments = comments @@ -80,7 +78,6 @@ def initialize(android: nil, archived: nil, comments: nil, description: nil, do_ @folder_id = folder_id @image = image @ios = ios - @partner_id = partner_id @password = password @prefix = prefix @proxy = proxy diff --git a/lib/open_api_sdk/models/operations/createreferralsembedtoken_country.rb b/lib/open_api_sdk/models/operations/createreferralsembedtoken_country.rb new file mode 100644 index 0000000..8b02c1f --- /dev/null +++ b/lib/open_api_sdk/models/operations/createreferralsembedtoken_country.rb @@ -0,0 +1,266 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + # CreateReferralsEmbedTokenCountry - Country where the partner is based. + class CreateReferralsEmbedTokenCountry < T::Enum + enums do + AF = new('AF') + AL = new('AL') + DZ = new('DZ') + AS = new('AS') + AD = new('AD') + AO = new('AO') + AI = new('AI') + AQ = new('AQ') + AG = new('AG') + AR = new('AR') + AM = new('AM') + AW = new('AW') + AU = new('AU') + AT = new('AT') + AZ = new('AZ') + BS = new('BS') + BH = new('BH') + BD = new('BD') + BB = new('BB') + BY = new('BY') + BE = new('BE') + BZ = new('BZ') + BJ = new('BJ') + BM = new('BM') + BT = new('BT') + BO = new('BO') + BA = new('BA') + BW = new('BW') + BV = new('BV') + BR = new('BR') + IO = new('IO') + BN = new('BN') + BG = new('BG') + BF = new('BF') + BI = new('BI') + KH = new('KH') + CM = new('CM') + CA = new('CA') + CV = new('CV') + KY = new('KY') + CF = new('CF') + TD = new('TD') + CL = new('CL') + CN = new('CN') + CX = new('CX') + CC = new('CC') + CO = new('CO') + KM = new('KM') + CG = new('CG') + CD = new('CD') + CK = new('CK') + CR = new('CR') + CI = new('CI') + HR = new('HR') + CU = new('CU') + CY = new('CY') + CZ = new('CZ') + DK = new('DK') + DJ = new('DJ') + DM = new('DM') + DO = new('DO') + EC = new('EC') + EG = new('EG') + SV = new('SV') + GQ = new('GQ') + ER = new('ER') + EE = new('EE') + ET = new('ET') + FK = new('FK') + FO = new('FO') + FJ = new('FJ') + FI = new('FI') + FR = new('FR') + GF = new('GF') + PF = new('PF') + TF = new('TF') + GA = new('GA') + GM = new('GM') + GE = new('GE') + DE = new('DE') + GH = new('GH') + GI = new('GI') + GR = new('GR') + GL = new('GL') + GD = new('GD') + GP = new('GP') + GU = new('GU') + GT = new('GT') + GN = new('GN') + GW = new('GW') + GY = new('GY') + HT = new('HT') + HM = new('HM') + VA = new('VA') + HN = new('HN') + HK = new('HK') + HU = new('HU') + IS = new('IS') + IN = new('IN') + ID = new('ID') + IR = new('IR') + IQ = new('IQ') + IE = new('IE') + IL = new('IL') + IT = new('IT') + JM = new('JM') + JP = new('JP') + JO = new('JO') + KZ = new('KZ') + KE = new('KE') + KI = new('KI') + KP = new('KP') + KR = new('KR') + KW = new('KW') + KG = new('KG') + LA = new('LA') + LV = new('LV') + LB = new('LB') + LS = new('LS') + LR = new('LR') + LY = new('LY') + LI = new('LI') + LT = new('LT') + LU = new('LU') + MO = new('MO') + MG = new('MG') + MW = new('MW') + MY = new('MY') + MV = new('MV') + ML = new('ML') + MT = new('MT') + MH = new('MH') + MQ = new('MQ') + MR = new('MR') + MU = new('MU') + YT = new('YT') + MX = new('MX') + FM = new('FM') + MD = new('MD') + MC = new('MC') + MN = new('MN') + MS = new('MS') + MA = new('MA') + MZ = new('MZ') + MM = new('MM') + NA = new('NA') + NR = new('NR') + NP = new('NP') + NL = new('NL') + NC = new('NC') + NZ = new('NZ') + NI = new('NI') + NE = new('NE') + NG = new('NG') + NU = new('NU') + NF = new('NF') + MK = new('MK') + MP = new('MP') + NO = new('NO') + OM = new('OM') + PK = new('PK') + PW = new('PW') + PS = new('PS') + PA = new('PA') + PG = new('PG') + PY = new('PY') + PE = new('PE') + PH = new('PH') + PN = new('PN') + PL = new('PL') + PT = new('PT') + PR = new('PR') + QA = new('QA') + RE = new('RE') + RO = new('RO') + RU = new('RU') + RW = new('RW') + SH = new('SH') + KN = new('KN') + LC = new('LC') + PM = new('PM') + VC = new('VC') + WS = new('WS') + SM = new('SM') + ST = new('ST') + SA = new('SA') + SN = new('SN') + SC = new('SC') + SL = new('SL') + SG = new('SG') + SK = new('SK') + SI = new('SI') + SB = new('SB') + SO = new('SO') + ZA = new('ZA') + GS = new('GS') + ES = new('ES') + LK = new('LK') + SD = new('SD') + SR = new('SR') + SJ = new('SJ') + SZ = new('SZ') + SE = new('SE') + CH = new('CH') + SY = new('SY') + TW = new('TW') + TJ = new('TJ') + TZ = new('TZ') + TH = new('TH') + TL = new('TL') + TG = new('TG') + TK = new('TK') + TO = new('TO') + TT = new('TT') + TN = new('TN') + TR = new('TR') + TM = new('TM') + TC = new('TC') + TV = new('TV') + UG = new('UG') + UA = new('UA') + AE = new('AE') + GB = new('GB') + US = new('US') + UM = new('UM') + UY = new('UY') + UZ = new('UZ') + VU = new('VU') + VE = new('VE') + VN = new('VN') + VG = new('VG') + VI = new('VI') + WF = new('WF') + EH = new('EH') + YE = new('YE') + ZM = new('ZM') + ZW = new('ZW') + AX = new('AX') + BQ = new('BQ') + CW = new('CW') + GG = new('GG') + IM = new('IM') + JE = new('JE') + ME = new('ME') + BL = new('BL') + MF = new('MF') + RS = new('RS') + SX = new('SX') + SS = new('SS') + XK = new('XK') + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/createreferralsembedtoken_linkprops.rb b/lib/open_api_sdk/models/operations/createreferralsembedtoken_linkprops.rb new file mode 100644 index 0000000..a9933cc --- /dev/null +++ b/lib/open_api_sdk/models/operations/createreferralsembedtoken_linkprops.rb @@ -0,0 +1,99 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + # Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. + class CreateReferralsEmbedTokenLinkProps < ::Crystalline::FieldAugmented + extend T::Sig + + # The Android destination URL for the short link for Android device targeting. + field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } } + # Whether the short link is archived. Defaults to `false` if not provided. + field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } } + # The comments for the short link. + field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } } + # The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og + field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } } + # Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex + field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } } + # The URL to redirect to when the short link has expired. + field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } } + # The date and time when the short link will expire at. + field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } } + # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. + field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } } + # The unique ID existing folder to assign the short link to. + field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } } + # 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 + field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } } + # The iOS destination URL for the short link for iOS device targeting. + field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } } + # The password required to access the destination URL of the short link. + field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } } + # The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided. + field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } } + # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided. + field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } } + # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL. + field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } } + # Whether the short link uses link cloaking. Defaults to `false` if not provided. + field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } } + # The unique IDs of the tags assigned to the short link. + field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } } + # The unique name of the tags assigned to the short link (case insensitive). + field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } } + # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant. + field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } } + # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og + field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } } + # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL. + field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } } + # The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL. + field :utm_content, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_content') } } + # The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL. + field :utm_medium, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_medium') } } + # The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL. + field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } } + # The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL. + field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } } + # The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og + field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } } + + + 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), 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 } + 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, 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) + @android = android + @archived = archived + @comments = comments + @description = description + @do_index = do_index + @expired_url = expired_url + @expires_at = expires_at + @external_id = external_id + @folder_id = folder_id + @image = image + @ios = ios + @password = password + @prefix = prefix + @proxy = proxy + @ref = ref + @rewrite = rewrite + @tag_ids = tag_ids + @tag_names = tag_names + @tenant_id = tenant_id + @title = title + @utm_campaign = utm_campaign + @utm_content = utm_content + @utm_medium = utm_medium + @utm_source = utm_source + @utm_term = utm_term + @video = video + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/createembedtoken_requestbody.rb b/lib/open_api_sdk/models/operations/createreferralsembedtoken_requestbody.rb similarity index 57% rename from lib/open_api_sdk/models/operations/createembedtoken_requestbody.rb rename to lib/open_api_sdk/models/operations/createreferralsembedtoken_requestbody.rb index e3292de..6537ec6 100644 --- a/lib/open_api_sdk/models/operations/createembedtoken_requestbody.rb +++ b/lib/open_api_sdk/models/operations/createreferralsembedtoken_requestbody.rb @@ -8,20 +8,23 @@ module OpenApiSDK module Operations - class CreateEmbedTokenRequestBody < ::Crystalline::FieldAugmented + class CreateReferralsEmbedTokenRequestBody < ::Crystalline::FieldAugmented extend T::Sig field :program_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } } + field :partner, T.nilable(::OpenApiSDK::Operations::Partner), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner') } } + field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } } field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } } - sig { params(program_id: ::String, partner_id: T.nilable(::String), tenant_id: T.nilable(::String)).void } - def initialize(program_id: nil, partner_id: nil, tenant_id: nil) + sig { params(program_id: ::String, partner: T.nilable(::OpenApiSDK::Operations::Partner), partner_id: T.nilable(::String), tenant_id: T.nilable(::String)).void } + def initialize(program_id: nil, partner: nil, partner_id: nil, tenant_id: nil) @program_id = program_id + @partner = partner @partner_id = partner_id @tenant_id = tenant_id end diff --git a/lib/open_api_sdk/models/operations/createembedtoken_response.rb b/lib/open_api_sdk/models/operations/createreferralsembedtoken_response.rb similarity index 89% rename from lib/open_api_sdk/models/operations/createembedtoken_response.rb rename to lib/open_api_sdk/models/operations/createreferralsembedtoken_response.rb index 29849d0..856905e 100644 --- a/lib/open_api_sdk/models/operations/createembedtoken_response.rb +++ b/lib/open_api_sdk/models/operations/createreferralsembedtoken_response.rb @@ -8,7 +8,7 @@ module OpenApiSDK module Operations - class CreateEmbedTokenResponse < ::Crystalline::FieldAugmented + class CreateReferralsEmbedTokenResponse < ::Crystalline::FieldAugmented extend T::Sig # HTTP response content type for this operation @@ -30,7 +30,7 @@ class CreateEmbedTokenResponse < ::Crystalline::FieldAugmented # The server cannot find the requested resource. field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound) # The created public embed token. - field :object, T.nilable(::OpenApiSDK::Operations::CreateEmbedTokenResponseBody) + field :object, T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenResponseBody) # The user has sent too many requests in a given amount of time ("rate limiting") field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded) # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response. @@ -39,7 +39,7 @@ class CreateEmbedTokenResponse < ::Crystalline::FieldAugmented field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity) - sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), object: T.nilable(::OpenApiSDK::Operations::CreateEmbedTokenResponseBody), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void } + 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), object: T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenResponseBody), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void } def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, object: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil) @content_type = content_type @raw_response = raw_response diff --git a/lib/open_api_sdk/models/operations/createembedtoken_responsebody.rb b/lib/open_api_sdk/models/operations/createreferralsembedtoken_responsebody.rb similarity index 89% rename from lib/open_api_sdk/models/operations/createembedtoken_responsebody.rb rename to lib/open_api_sdk/models/operations/createreferralsembedtoken_responsebody.rb index 8779851..b827d1b 100644 --- a/lib/open_api_sdk/models/operations/createembedtoken_responsebody.rb +++ b/lib/open_api_sdk/models/operations/createreferralsembedtoken_responsebody.rb @@ -8,7 +8,7 @@ module OpenApiSDK module Operations # The created public embed token. - class CreateEmbedTokenResponseBody < ::Crystalline::FieldAugmented + class CreateReferralsEmbedTokenResponseBody < ::Crystalline::FieldAugmented extend T::Sig diff --git a/lib/open_api_sdk/models/operations/getcustomers_partner.rb b/lib/open_api_sdk/models/operations/getcustomers_partner.rb new file mode 100644 index 0000000..025dc83 --- /dev/null +++ b/lib/open_api_sdk/models/operations/getcustomers_partner.rb @@ -0,0 +1,33 @@ +# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. + +# typed: true +# frozen_string_literal: true + + +module OpenApiSDK + module Operations + + + class GetCustomersPartner < ::Crystalline::FieldAugmented + extend T::Sig + + + field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } } + + field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } } + + field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } } + + field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } } + + + sig { params(email: ::String, id: ::String, name: ::String, image: T.nilable(::String)).void } + def initialize(email: nil, id: nil, name: nil, image: nil) + @email = email + @id = id + @name = name + @image = image + end + end + end +end diff --git a/lib/open_api_sdk/models/operations/interval.rb b/lib/open_api_sdk/models/operations/interval.rb index 8f92a6d..c5f2ad6 100644 --- a/lib/open_api_sdk/models/operations/interval.rb +++ b/lib/open_api_sdk/models/operations/interval.rb @@ -19,7 +19,6 @@ class Interval < T::Enum QTD = new('qtd') YTD = new('ytd') ALL = new('all') - ALL_UNFILTERED = new('all_unfiltered') end end end diff --git a/lib/open_api_sdk/models/operations/linkprops.rb b/lib/open_api_sdk/models/operations/linkprops.rb index 2224709..dbd4f0c 100644 --- a/lib/open_api_sdk/models/operations/linkprops.rb +++ b/lib/open_api_sdk/models/operations/linkprops.rb @@ -33,8 +33,6 @@ class LinkProps < ::Crystalline::FieldAugmented field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } } # The iOS destination URL for the short link for iOS device targeting. field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } } - # The ID of the partner the short link is associated with. - field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } } # The password required to access the destination URL of the short link. field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } } # The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided. @@ -67,8 +65,8 @@ class LinkProps < ::Crystalline::FieldAugmented field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } } - 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 } - 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) + 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), 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 } + 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, 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) @android = android @archived = archived @comments = comments @@ -80,7 +78,6 @@ def initialize(android: nil, archived: nil, comments: nil, description: nil, do_ @folder_id = folder_id @image = image @ios = ios - @partner_id = partner_id @password = password @prefix = prefix @proxy = proxy diff --git a/lib/open_api_sdk/models/operations/partner.rb b/lib/open_api_sdk/models/operations/partner.rb index 3f5954f..12ede43 100644 --- a/lib/open_api_sdk/models/operations/partner.rb +++ b/lib/open_api_sdk/models/operations/partner.rb @@ -11,22 +11,34 @@ module Operations class Partner < ::Crystalline::FieldAugmented extend T::Sig - + # Email for the partner in your system. Partners will be able to claim their profile by signing up to Dub Partners with this email. field :email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('email') } } - - field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } } - + # Full legal name of the partner. field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } } - + # Country where the partner is based. + field :country, T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenCountry), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('country'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::CreateReferralsEmbedTokenCountry, true) } } + # A brief description of the partner and their background. + field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } } + # Avatar image for the partner – if not provided, a default avatar will be used. field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } } + # Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner. + field :link_props, T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenLinkProps), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('linkProps') } } + # The ID of the partner in your system. + field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } } + # A unique username for the partner in your system (max 100 characters). This will be used to create a short link for the partner using your program's default domain. If not provided, Dub will try to generate a username from the partner's name or email. + field :username, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('username') } } - sig { params(email: ::String, id: ::String, name: ::String, image: T.nilable(::String)).void } - def initialize(email: nil, id: nil, name: nil, image: nil) + sig { params(email: ::String, name: ::String, country: T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenCountry), description: T.nilable(::String), image: T.nilable(::String), link_props: T.nilable(::OpenApiSDK::Operations::CreateReferralsEmbedTokenLinkProps), tenant_id: T.nilable(::String), username: T.nilable(::String)).void } + def initialize(email: nil, name: nil, country: nil, description: nil, image: nil, link_props: nil, tenant_id: nil, username: nil) @email = email - @id = id @name = name + @country = country + @description = description @image = image + @link_props = link_props + @tenant_id = tenant_id + @username = username end end end diff --git a/lib/open_api_sdk/models/operations/responsebody.rb b/lib/open_api_sdk/models/operations/responsebody.rb index c36bdf0..ba29bcf 100644 --- a/lib/open_api_sdk/models/operations/responsebody.rb +++ b/lib/open_api_sdk/models/operations/responsebody.rb @@ -30,10 +30,10 @@ class ResponseBody < ::Crystalline::FieldAugmented field :link, T.nilable(::OpenApiSDK::Operations::Link), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('link') } } - field :partner, T.nilable(::OpenApiSDK::Operations::Partner), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner') } } + field :partner, T.nilable(::OpenApiSDK::Operations::GetCustomersPartner), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partner') } } - 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::Link), partner: T.nilable(::OpenApiSDK::Operations::Partner)).void } + 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::Link), partner: T.nilable(::OpenApiSDK::Operations::GetCustomersPartner)).void } def initialize(created_at: nil, external_id: nil, id: nil, name: nil, avatar: nil, country: nil, discount: nil, email: nil, link: nil, partner: nil) @created_at = created_at @external_id = external_id diff --git a/lib/open_api_sdk/models/operations/retrievepartneranalytics_queryparam_interval.rb b/lib/open_api_sdk/models/operations/retrievepartneranalytics_queryparam_interval.rb index f83253e..0d24d77 100644 --- a/lib/open_api_sdk/models/operations/retrievepartneranalytics_queryparam_interval.rb +++ b/lib/open_api_sdk/models/operations/retrievepartneranalytics_queryparam_interval.rb @@ -19,7 +19,6 @@ class RetrievePartnerAnalyticsQueryParamInterval < T::Enum QTD = new('qtd') YTD = new('ytd') ALL = new('all') - ALL_UNFILTERED = new('all_unfiltered') end end end diff --git a/lib/open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb b/lib/open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb index a22fa70..719b559 100644 --- a/lib/open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb +++ b/lib/open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb @@ -33,8 +33,6 @@ class UpsertPartnerLinkLinkProps < ::Crystalline::FieldAugmented field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } } # The iOS destination URL for the short link for iOS device targeting. field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } } - # The ID of the partner the short link is associated with. - field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } } # The password required to access the destination URL of the short link. field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } } # The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided. @@ -67,8 +65,8 @@ class UpsertPartnerLinkLinkProps < ::Crystalline::FieldAugmented field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } } - 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 } - 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) + 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), 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 } + 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, 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) @android = android @archived = archived @comments = comments @@ -80,7 +78,6 @@ def initialize(android: nil, archived: nil, comments: nil, description: nil, do_ @folder_id = folder_id @image = image @ios = ios - @partner_id = partner_id @password = password @prefix = prefix @proxy = proxy diff --git a/lib/open_api_sdk/sdkconfiguration.rb b/lib/open_api_sdk/sdkconfiguration.rb index 7935dd9..08af917 100644 --- a/lib/open_api_sdk/sdkconfiguration.rb +++ b/lib/open_api_sdk/sdkconfiguration.rb @@ -43,9 +43,9 @@ def initialize(client, security, security_source, server_url, server_idx) end @language = 'ruby' @openapi_doc_version = '0.0.1' - @sdk_version = '0.2.2-alpha.74' - @gen_version = '2.539.0' - @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.74 2.539.0 0.0.1 dub' + @sdk_version = '0.2.2-alpha.75' + @gen_version = '2.539.1' + @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.75 2.539.1 0.0.1 dub' end sig { returns([String, T::Hash[Symbol, String]]) } From d10ebcd86542a941ab7a72ab58ea97158b08c14f Mon Sep 17 00:00:00 2001 From: "speakeasy-github[bot]" <128539517+speakeasy-github[bot]@users.noreply.github.com> Date: Wed, 5 Mar 2025 00:28:50 +0000 Subject: [PATCH 2/2] empty commit to trigger [run-tests] workflow