Merge pull request #51 from dubinc/speakeasy-sdk-regen-1731457570

chore: 🐝 Update SDK - Generate 0.2.2-alpha.32

.speakeasy/gen.yaml

@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: true
     oAuth2PasswordEnabled: false
 ruby:
-  version: 0.2.2-alpha.31
+  version: 0.2.2-alpha.32
   author: Dub
   description: Ruby Client SDK Generated by Speakeasy
   imports:

.speakeasy/workflow.lock

@@ -2,19 +2,19 @@ speakeasyVersion: 1.438.1
 sources:
     dub:
         sourceNamespace: dub
-        sourceRevisionDigest: sha256:38a4ba7ddf108888129468f0d82285e3f1157dcbeda6384fbe6b7819a8d171f2
-        sourceBlobDigest: sha256:a11010fb626e9e32fb495d600b5fffeecc8b8cc7493bf6202802461d25be157f
+        sourceRevisionDigest: sha256:ade642623da232e60621ed2ac3a05f573e788bb827e8af67730c074655278908
+        sourceBlobDigest: sha256:15a4bc5ddf9675dc60f3829516e1561f691ca4c6c521a3fc79f59d50c77b561d
         tags:
             - latest
             - main
 targets:
     my-first-target:
         source: dub
         sourceNamespace: dub
-        sourceRevisionDigest: sha256:38a4ba7ddf108888129468f0d82285e3f1157dcbeda6384fbe6b7819a8d171f2
-        sourceBlobDigest: sha256:a11010fb626e9e32fb495d600b5fffeecc8b8cc7493bf6202802461d25be157f
+        sourceRevisionDigest: sha256:ade642623da232e60621ed2ac3a05f573e788bb827e8af67730c074655278908
+        sourceBlobDigest: sha256:15a4bc5ddf9675dc60f3829516e1561f691ca4c6c521a3fc79f59d50c77b561d
         codeSamplesNamespace: code-samples-ruby-my-first-target
-        codeSamplesRevisionDigest: sha256:3e27e1b2cfb98bb01f4ccbf4ee39763345befe851c776b3abc631fbfde4689cf
+        codeSamplesRevisionDigest: sha256:adb027338993fe7c821997dff2a4e19a3eeaede8ee1d80f4858c21184016947e
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dub (0.2.2.pre.alpha.31)
+    dub (0.2.2.pre.alpha.32)
       faraday
       faraday-multipart
       rack

README.md

@@ -110,6 +110,14 @@ end
 
 * [retrieve](docs/sdks/analytics/README.md#retrieve) - Retrieve analytics for a link, a domain, or the authenticated workspace.
 
+### [customers](docs/sdks/customers/README.md)
+
+* [list](docs/sdks/customers/README.md#list) - Get a list of customers
+* [create](docs/sdks/customers/README.md#create) - Create a customer
+* [get](docs/sdks/customers/README.md#get) - Get a customer
+* [update](docs/sdks/customers/README.md#update) - Update a customer
+* [delete](docs/sdks/customers/README.md#delete) - Delete a customer
+
 ### [domains](docs/sdks/domains/README.md)
 
 * [create](docs/sdks/domains/README.md#create) - Create a domain
@@ -154,7 +162,7 @@ end
 
 * [lead](docs/sdks/track/README.md#lead) - Track a lead
 * [sale](docs/sdks/track/README.md#sale) - Track a sale
-* [customer](docs/sdks/track/README.md#customer) - Track a customer
+* [~~customer~~](docs/sdks/track/README.md#customer) - Track a customer :warning: **Deprecated**
 
 ### [workspaces](docs/sdks/workspaces/README.md)
 

RELEASES.md

@@ -458,4 +458,14 @@ Based on:
 ### Generated
 - [ruby v0.2.2-alpha.31] .
 ### Releases
-- [Ruby Gems v0.2.2-alpha.31] https://rubygems.org/gems/dub/versions/0.2.2-alpha.31 - .
+- [Ruby Gems v0.2.2-alpha.31] https://rubygems.org/gems/dub/versions/0.2.2-alpha.31 - .
+
+## 2024-11-13 00:26:07
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.438.1 (2.457.2) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [ruby v0.2.2-alpha.32] .
+### Releases
+- [Ruby Gems v0.2.2-alpha.32] https://rubygems.org/gems/dub/versions/0.2.2-alpha.32 - .

codeSamples.yaml

@@ -9,6 +9,36 @@ actions:
         - "lang": "ruby"
           "label": "retrieveAnalytics"
           "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::RetrieveAnalyticsRequest.new(\n  timezone: \"America/New_York\",\n  city: \"New York\",\n  device: \"Desktop\",\n  browser: \"Chrome\",\n  os: \"Windows\",\n  referer: \"google.com\",\n  referer_url: \"https://dub.co/blog\",\n)\n    \nres = s.analytics.retrieve(req)\n\nif ! res.one_of.nil?\n  # handle response\nend"
+  - target: $["paths"]["/customers"]["get"]
+    update:
+      "x-codeSamples":
+        - "lang": "ruby"
+          "label": "getCustomers"
+          "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.customers.list()\n\nif ! res.response_bodies.nil?\n  # handle response\nend"
+  - target: $["paths"]["/customers"]["post"]
+    update:
+      "x-codeSamples":
+        - "lang": "ruby"
+          "label": "createCustomer"
+          "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::CreateCustomerRequestBody.new(\n  external_id: \"<id>\",\n)\n    \nres = s.customers.create(req)\n\nif ! res.object.nil?\n  # handle response\nend"
+  - target: $["paths"]["/customers/{id}"]["delete"]
+    update:
+      "x-codeSamples":
+        - "lang": "ruby"
+          "label": "deleteCustomer"
+          "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.customers.delete(id=\"<id>\")\n\nif ! res.object.nil?\n  # handle response\nend"
+  - target: $["paths"]["/customers/{id}"]["get"]
+    update:
+      "x-codeSamples":
+        - "lang": "ruby"
+          "label": "getCustomer"
+          "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::GetCustomerRequest.new(\n  id: \"<id>\",\n)\n    \nres = s.customers.get(req)\n\nif ! res.object.nil?\n  # handle response\nend"
+  - target: $["paths"]["/customers/{id}"]["patch"]
+    update:
+      "x-codeSamples":
+        - "lang": "ruby"
+          "label": "updateCustomer"
+          "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.customers.update(id=\"<id>\", request_body=::OpenApiSDK::Operations::UpdateCustomerRequestBody.new())\n\nif ! res.object.nil?\n  # handle response\nend"
   - target: $["paths"]["/domains"]["get"]
     update:
       "x-codeSamples":
@@ -135,24 +165,18 @@ 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=\"<id>\", request_body=::OpenApiSDK::Operations::UpdateTagRequestBody.new())\n\nif ! res.tag_schema.nil?\n  # handle response\nend"
-  - target: $["paths"]["/track/customer"]["post"]
-    update:
-      "x-codeSamples":
-        - "lang": "ruby"
-          "label": "trackCustomer"
-          "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::TrackCustomerRequestBody.new(\n  customer_id: \"<id>\",\n)\n    \nres = s.track.customer(req)\n\nif ! res.object.nil?\n  # handle response\nend"
   - target: $["paths"]["/track/lead"]["post"]
     update:
       "x-codeSamples":
         - "lang": "ruby"
           "label": "trackLead"
-          "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::TrackLeadRequestBody.new(\n  click_id: \"<id>\",\n  event_name: \"Sign up\",\n  customer_id: \"<id>\",\n)\n    \nres = s.track.lead(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::TrackLeadRequestBody.new(\n  click_id: \"<id>\",\n  event_name: \"Sign up\",\n)\n    \nres = s.track.lead(req)\n\nif ! res.object.nil?\n  # handle response\nend"
   - target: $["paths"]["/track/sale"]["post"]
     update:
       "x-codeSamples":
         - "lang": "ruby"
           "label": "trackSale"
-          "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::TrackSaleRequestBody.new(\n  customer_id: \"<id>\",\n  amount: 996500,\n  payment_processor: ::OpenApiSDK::Operations::PaymentProcessor::PADDLE,\n  event_name: \"Purchase\",\n)\n    \nres = s.track.sale(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::TrackSaleRequestBody.new(\n  amount: 996500,\n  payment_processor: ::OpenApiSDK::Operations::PaymentProcessor::PADDLE,\n  event_name: \"Purchase\",\n)\n    \nres = s.track.sale(req)\n\nif ! res.object.nil?\n  # handle response\nend"
   - target: $["paths"]["/workspaces/{idOrSlug}"]["get"]
     update:
       "x-codeSamples":

docs/models/operations/createcustomerrequestbody.md

@@ -0,0 +1,11 @@
+# CreateCustomerRequestBody
+
+
+## Fields
+
+| Field                                                                                       | Type                                                                                        | Required                                                                                    | Description                                                                                 |
+| ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
+| `email`                                                                                     | *T.nilable(::String)*                                                                       | :heavy_minus_sign:                                                                          | Email of the customer in the client's app.                                                  |
+| `name`                                                                                      | *T.nilable(::String)*                                                                       | :heavy_minus_sign:                                                                          | Name of the customer in the client's app. If not provided, a random name will be generated. |
+| `avatar`                                                                                    | *T.nilable(::String)*                                                                       | :heavy_minus_sign:                                                                          | Avatar URL of the customer in the client's app.                                             |
+| `external_id`                                                                               | *::String*                                                                                  | :heavy_check_mark:                                                                          | Unique identifier for the customer in the client's app.                                     |