From 7b7289770fc3f8f1178a6800f0e68c9a4e50fb20 Mon Sep 17 00:00:00 2001 From: speakeasybot Date: Mon, 10 Jun 2024 01:22:02 +0000 Subject: [PATCH] ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.300.1 --- .speakeasy/gen.lock | 6 +++--- .speakeasy/gen.yaml | 2 +- .speakeasy/workflow.lock | 8 ++++---- Gemfile.lock | 2 +- RELEASES.md | 12 +++++++++++- docs/models/operations/trackleadrequestbody.md | 2 +- docs/models/operations/tracksalerequestbody.md | 17 +++++++++-------- docs/models/operations/tracksaleresponsebody.md | 1 + docs/sdks/track/README.md | 3 ++- dub.gemspec | 2 +- .../models/operations/tracksale_requestbody.rb | 7 +++++-- .../models/operations/tracksale_responsebody.rb | 7 +++++-- lib/open_api_sdk/sdkconfiguration.rb | 4 ++-- 13 files changed, 46 insertions(+), 27 deletions(-) diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock index 5ab26b6..6376d6c 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: dda943a614373c0afd2760452f6aa501 + docChecksum: ba3e83845a082a6c2321d0eeaaf9c23c docVersion: 0.0.1 speakeasyVersion: 1.300.1 generationVersion: 2.339.1 - releaseVersion: 0.0.4 - configChecksum: a5c79ce256848ec51eae800a87ad3e3a + releaseVersion: 0.0.5 + configChecksum: ca47740c1f9091bad7d5a9ba60dd3cc6 repoURL: https://github.com/dubinc/dub-ruby.git installationURL: https://github.com/dubinc/dub-ruby published: true diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml index f8b44ba..c051a4d 100755 --- a/.speakeasy/gen.yaml +++ b/.speakeasy/gen.yaml @@ -12,7 +12,7 @@ generation: auth: oAuth2ClientCredentialsEnabled: true ruby: - version: 0.0.4 + version: 0.0.5 author: Dub description: Ruby Client SDK Generated by Speakeasy imports: diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index db0d4c0..e703cf4 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -2,8 +2,8 @@ speakeasyVersion: 1.300.1 sources: dub: sourceNamespace: dub - sourceRevisionDigest: sha256:59224acd7bd7958a7f091a89a90618eb60550de6ce9061b6a1b86f721b4f9285 - sourceBlobDigest: sha256:04e519216c5ec83c689352f2c023526718c9795f8d2947ac1d5792d749bb36ad + sourceRevisionDigest: sha256:d2c24b5ce76ba71f892713722c1df612f12f25490d6e3a9505a4d8d5227c56d6 + sourceBlobDigest: sha256:b470fd395e2bcc352f9b48b9f32c4a25fbd23cd88adacbc1b94fc84fe09777c0 tags: - latest - main @@ -11,8 +11,8 @@ targets: my-first-target: source: dub sourceNamespace: dub - sourceRevisionDigest: sha256:59224acd7bd7958a7f091a89a90618eb60550de6ce9061b6a1b86f721b4f9285 - sourceBlobDigest: sha256:04e519216c5ec83c689352f2c023526718c9795f8d2947ac1d5792d749bb36ad + sourceRevisionDigest: sha256:d2c24b5ce76ba71f892713722c1df612f12f25490d6e3a9505a4d8d5227c56d6 + sourceBlobDigest: sha256:b470fd395e2bcc352f9b48b9f32c4a25fbd23cd88adacbc1b94fc84fe09777c0 outLocation: /github/workspace/repo workflow: workflowVersion: 1.0.0 diff --git a/Gemfile.lock b/Gemfile.lock index 00cf4f2..f66e425 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - dub (0.0.4) + dub (0.0.5) faraday faraday-multipart rack diff --git a/RELEASES.md b/RELEASES.md index a44e296..304f631 100644 --- a/RELEASES.md +++ b/RELEASES.md @@ -28,4 +28,14 @@ Based on: ### Generated - [ruby v0.0.4] . ### Releases -- [Ruby Gems v0.0.4] https://rubygems.org/gems/dub/versions/0.0.4 - . \ No newline at end of file +- [Ruby Gems v0.0.4] https://rubygems.org/gems/dub/versions/0.0.4 - . + +## 2024-06-10 01:20:51 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.300.1 (2.339.1) https://github.com/speakeasy-api/speakeasy +### Generated +- [ruby v0.0.5] . +### Releases +- [Ruby Gems v0.0.5] https://rubygems.org/gems/dub/versions/0.0.5 - . \ No newline at end of file diff --git a/docs/models/operations/trackleadrequestbody.md b/docs/models/operations/trackleadrequestbody.md index 577e16f..16293ce 100644 --- a/docs/models/operations/trackleadrequestbody.md +++ b/docs/models/operations/trackleadrequestbody.md @@ -6,7 +6,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | | `click_id` | *::String* | :heavy_check_mark: | The ID of the click in th Dub. You can read this value from `dclid` cookie. | | -| `event_name` | *::String* | :heavy_check_mark: | The name of the event to track. | Signup | +| `event_name` | *::String* | :heavy_check_mark: | The name of the event to track. | Sign up | | `customer_id` | *::String* | :heavy_check_mark: | This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. | | | `customer_name` | *T.nilable(::String)* | :heavy_minus_sign: | Name of the customer in the client's app. | | | `customer_email` | *T.nilable(::String)* | :heavy_minus_sign: | Email of the customer in the client's app. | | diff --git a/docs/models/operations/tracksalerequestbody.md b/docs/models/operations/tracksalerequestbody.md index bf3c780..ba4afce 100644 --- a/docs/models/operations/tracksalerequestbody.md +++ b/docs/models/operations/tracksalerequestbody.md @@ -3,11 +3,12 @@ ## Fields -| Field | Type | Required | Description | -| ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | -| `customer_id` | *::String* | :heavy_check_mark: | This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. | -| `amount` | *::Integer* | :heavy_check_mark: | The amount of the sale. Should be passed in cents. | -| `payment_processor` | [::OpenApiSDK::Operations::PaymentProcessor](../../models/operations/paymentprocessor.md) | :heavy_check_mark: | The payment processor via which the sale was made. | -| `invoice_id` | *T.nilable(::String)* | :heavy_minus_sign: | The invoice ID of the sale. | -| `currency` | *T.nilable(::String)* | :heavy_minus_sign: | The currency of the sale. Accepts ISO 4217 currency codes. | -| `metadata` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Additional metadata to be stored with the sale event. | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | +| `customer_id` | *::String* | :heavy_check_mark: | This is the unique identifier for the customer in the client's app. This is used to track the customer's journey. | | +| `amount` | *::Integer* | :heavy_check_mark: | The amount of the sale. Should be passed in cents. | | +| `payment_processor` | [::OpenApiSDK::Operations::PaymentProcessor](../../models/operations/paymentprocessor.md) | :heavy_check_mark: | The payment processor via which the sale was made. | | +| `event_name` | *T.nilable(::String)* | :heavy_minus_sign: | The name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc. | Purchase | +| `invoice_id` | *T.nilable(::String)* | :heavy_minus_sign: | The invoice ID of the sale. | | +| `currency` | *T.nilable(::String)* | :heavy_minus_sign: | The currency of the sale. Accepts ISO 4217 currency codes. | | +| `metadata` | T::Hash[Symbol, *::Object*] | :heavy_minus_sign: | Additional metadata to be stored with the sale event. | | \ No newline at end of file diff --git a/docs/models/operations/tracksaleresponsebody.md b/docs/models/operations/tracksaleresponsebody.md index 45a8ea8..c65b70c 100644 --- a/docs/models/operations/tracksaleresponsebody.md +++ b/docs/models/operations/tracksaleresponsebody.md @@ -7,6 +7,7 @@ A sale was tracked. | Field | Type | Required | Description | | --------------------------- | --------------------------- | --------------------------- | --------------------------- | +| `event_name` | *::String* | :heavy_check_mark: | N/A | | `customer_id` | *::String* | :heavy_check_mark: | N/A | | `amount` | *::Float* | :heavy_check_mark: | N/A | | `payment_processor` | *::String* | :heavy_check_mark: | N/A | diff --git a/docs/sdks/track/README.md b/docs/sdks/track/README.md index 6903d7c..e34c276 100644 --- a/docs/sdks/track/README.md +++ b/docs/sdks/track/README.md @@ -29,7 +29,7 @@ s.config_security( res = s.track.lead(workspace_id="", project_slug="", request_body=::OpenApiSDK::Operations::TrackLeadRequestBody.new( click_id: "", - event_name: "Signup", + event_name: "Sign up", customer_id: "", )) @@ -77,6 +77,7 @@ res = s.track.sale(workspace_id="", project_slug="", request_body= customer_id: "", amount: 996500, payment_processor: ::OpenApiSDK::Operations::PaymentProcessor::SHOPIFY, + event_name: "Purchase", )) if ! res.object.nil? diff --git a/dub.gemspec b/dub.gemspec index 5bea2a0..11f648d 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.0.4' + s.version = '0.0.5' s.platform = Gem::Platform::RUBY s.licenses = ['Apache-2.0'] s.summary = '' diff --git a/lib/open_api_sdk/models/operations/tracksale_requestbody.rb b/lib/open_api_sdk/models/operations/tracksale_requestbody.rb index b08139d..38ffd79 100644 --- a/lib/open_api_sdk/models/operations/tracksale_requestbody.rb +++ b/lib/open_api_sdk/models/operations/tracksale_requestbody.rb @@ -19,18 +19,21 @@ class TrackSaleRequestBody < ::OpenApiSDK::Utils::FieldAugmented field :payment_processor, ::OpenApiSDK::Operations::PaymentProcessor, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::PaymentProcessor, false) } } # The currency of the sale. Accepts ISO 4217 currency codes. field :currency, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency') } } + # The name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc. + field :event_name, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } } # The invoice ID of the sale. field :invoice_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } } # Additional metadata to be stored with the sale event. field :metadata, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } } - sig { params(amount: ::Integer, customer_id: ::String, payment_processor: ::OpenApiSDK::Operations::PaymentProcessor, currency: T.nilable(::String), invoice_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void } - def initialize(amount: nil, customer_id: nil, payment_processor: nil, currency: nil, invoice_id: nil, metadata: nil) + sig { params(amount: ::Integer, customer_id: ::String, payment_processor: ::OpenApiSDK::Operations::PaymentProcessor, currency: T.nilable(::String), event_name: T.nilable(::String), invoice_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void } + def initialize(amount: nil, customer_id: nil, payment_processor: nil, currency: nil, event_name: nil, invoice_id: nil, metadata: nil) @amount = amount @customer_id = customer_id @payment_processor = payment_processor @currency = currency + @event_name = event_name @invoice_id = invoice_id @metadata = metadata end diff --git a/lib/open_api_sdk/models/operations/tracksale_responsebody.rb b/lib/open_api_sdk/models/operations/tracksale_responsebody.rb index 37c0637..4ed57f7 100644 --- a/lib/open_api_sdk/models/operations/tracksale_responsebody.rb +++ b/lib/open_api_sdk/models/operations/tracksale_responsebody.rb @@ -18,6 +18,8 @@ class TrackSaleResponseBody < ::OpenApiSDK::Utils::FieldAugmented field :customer_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } } + field :event_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } } + field :invoice_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } } field :metadata, T::Hash[Symbol, ::Object], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } } @@ -25,11 +27,12 @@ class TrackSaleResponseBody < ::OpenApiSDK::Utils::FieldAugmented field :payment_processor, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor') } } - sig { params(amount: ::Float, currency: ::String, customer_id: ::String, invoice_id: ::String, metadata: T::Hash[Symbol, ::Object], payment_processor: ::String).void } - def initialize(amount: nil, currency: nil, customer_id: nil, invoice_id: nil, metadata: nil, payment_processor: nil) + sig { params(amount: ::Float, currency: ::String, customer_id: ::String, event_name: ::String, invoice_id: ::String, metadata: T::Hash[Symbol, ::Object], payment_processor: ::String).void } + def initialize(amount: nil, currency: nil, customer_id: nil, event_name: nil, invoice_id: nil, metadata: nil, payment_processor: nil) @amount = amount @currency = currency @customer_id = customer_id + @event_name = event_name @invoice_id = invoice_id @metadata = metadata @payment_processor = payment_processor diff --git a/lib/open_api_sdk/sdkconfiguration.rb b/lib/open_api_sdk/sdkconfiguration.rb index f3787c4..756f663 100644 --- a/lib/open_api_sdk/sdkconfiguration.rb +++ b/lib/open_api_sdk/sdkconfiguration.rb @@ -40,9 +40,9 @@ def initialize(client, security, server_url, server_idx, globals) @globals = globals.nil? ? {} : globals @language = 'ruby' @openapi_doc_version = '0.0.1' - @sdk_version = '0.0.4' + @sdk_version = '0.0.5' @gen_version = '2.339.1' - @user_agent = 'speakeasy-sdk/ruby 0.0.4 2.339.1 0.0.1 dub' + @user_agent = 'speakeasy-sdk/ruby 0.0.5 2.339.1 0.0.1 dub' end sig { returns([String, T::Hash[Symbol, String]]) }