Automatically update Ruby SDK

Author: github-actions[bot]

lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.0.31"
+    VERSION = "1.0.32"
     AUTHORS = ["Trophy Labs, Inc"].freeze
     EMAIL = ""
     SUMMARY = "Ruby library for the Trophy API."

lib/trophy_api_client/achievements/client.rb

@@ -76,7 +76,7 @@ def all(user_attributes: nil, request_options: nil)
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
     def complete(key:, user:, request_options: nil)
       response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -167,7 +167,7 @@ def all(user_attributes: nil, request_options: nil)
     #    environment: TrophyApiClient::Environment::PRODUCTION,
     #    api_key: "YOUR_API_KEY"
     #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "user-id" })
+    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
     def complete(key:, user:, request_options: nil)
       Async do
         response = @request_client.conn.post do |req|

lib/trophy_api_client/leaderboards/client.rb

@@ -56,14 +56,15 @@ def all(request_options: nil)
     #
     # @param key [String] Unique key of the leaderboard as set when created.
     # @param offset [Integer] Number of rankings to skip for pagination.
-    # @param limit [Integer] Maximum number of rankings to return.
+    # @param limit [Integer] Maximum number of rankings to return. Cannot be greater than the size of the
+    #  leaderboard.
     # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
     #  run.
     # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
     #  the user is not found in the leaderboard, returns empty rankings array.
-    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. This
-    #  parameter is required, and only valid for leaderboards with a breakdown
-    #  attribute.
+    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. For
+    #  example, `city:London`. This parameter is required, and only valid for
+    #  leaderboards with a breakdown attribute.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::LeaderboardResponseWithRankings]
     # @example
@@ -157,14 +158,15 @@ def all(request_options: nil)
     #
     # @param key [String] Unique key of the leaderboard as set when created.
     # @param offset [Integer] Number of rankings to skip for pagination.
-    # @param limit [Integer] Maximum number of rankings to return.
+    # @param limit [Integer] Maximum number of rankings to return. Cannot be greater than the size of the
+    #  leaderboard.
     # @param run [String] Specific run date in YYYY-MM-DD format. If not provided, returns the current
     #  run.
     # @param user_id [String] When provided, offset is relative to this user's position on the leaderboard. If
     #  the user is not found in the leaderboard, returns empty rankings array.
-    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. This
-    #  parameter is required, and only valid for leaderboards with a breakdown
-    #  attribute.
+    # @param user_attributes [String] Attribute key and value to filter the rankings by, separated by a colon. For
+    #  example, `city:London`. This parameter is required, and only valid for
+    #  leaderboards with a breakdown attribute.
     # @param request_options [TrophyApiClient::RequestOptions]
     # @return [TrophyApiClient::LeaderboardResponseWithRankings]
     # @example

lib/trophy_api_client/metrics/client.rb

@@ -42,7 +42,7 @@ def initialize(request_client:)
     #  api.metrics.event(
     #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
     #    key: "words-written",
-    #    user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "18" },
+    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
     #    value: 750,
     #    attributes: { "category": "writing", "source": "mobile-app" }
     #  )
@@ -107,7 +107,7 @@ def initialize(request_client:)
     #  api.metrics.event(
     #    idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f",
     #    key: "words-written",
-    #    user: { email: "user@example.com", name: "User", tz: "Europe/London", device_tokens: ["token1", "token2"], subscribe_to_emails: true, attributes: { "department": "engineering", "role": "developer" }, id: "18" },
+    #    user: { email: "user@example.com", tz: "Europe/London", attributes: { "department": "engineering", "role": "developer" }, id: "18" },
     #    value: 750,
     #    attributes: { "category": "writing", "source": "mobile-app" }
     #  )

lib/trophy_api_client/types/updated_user.rb

@@ -38,14 +38,14 @@ class UpdatedUser
     #  up in the Trophy dashboard.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::UpdatedUser]
-    def initialize(email:, name:, device_tokens:, subscribe_to_emails:, attributes:, tz: OMIT,
+    def initialize(email: OMIT, name: OMIT, tz: OMIT, device_tokens: OMIT, subscribe_to_emails: OMIT, attributes: OMIT,
                    additional_properties: nil)
-      @email = email
-      @name = name
+      @email = email if email != OMIT
+      @name = name if name != OMIT
       @tz = tz if tz != OMIT
-      @device_tokens = device_tokens
-      @subscribe_to_emails = subscribe_to_emails
-      @attributes = attributes
+      @device_tokens = device_tokens if device_tokens != OMIT
+      @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
+      @attributes = attributes if attributes != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "email": email,
@@ -97,12 +97,12 @@ def to_json(*_args)
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.email.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
-      obj.device_tokens.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
-      obj.subscribe_to_emails.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
-      obj.attributes.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
+      obj.device_tokens&.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
+      obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
+      obj.attributes&.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
     end
   end
 end

lib/trophy_api_client/types/upserted_user.rb

@@ -41,15 +41,15 @@ class UpsertedUser
     #  up in the Trophy dashboard.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::UpsertedUser]
-    def initialize(id:, email:, name:, device_tokens:, subscribe_to_emails:, attributes:, tz: OMIT,
-                   additional_properties: nil)
+    def initialize(id:, email: OMIT, name: OMIT, tz: OMIT, device_tokens: OMIT, subscribe_to_emails: OMIT,
+                   attributes: OMIT, additional_properties: nil)
       @id = id
-      @email = email
-      @name = name
+      @email = email if email != OMIT
+      @name = name if name != OMIT
       @tz = tz if tz != OMIT
-      @device_tokens = device_tokens
-      @subscribe_to_emails = subscribe_to_emails
-      @attributes = attributes
+      @device_tokens = device_tokens if device_tokens != OMIT
+      @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
+      @attributes = attributes if attributes != OMIT
       @additional_properties = additional_properties
       @_field_set = {
         "id": id,
@@ -105,12 +105,12 @@ def to_json(*_args)
     # @return [Void]
     def self.validate_raw(obj:)
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-      obj.email.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
-      obj.device_tokens.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
-      obj.subscribe_to_emails.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
-      obj.attributes.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
+      obj.device_tokens&.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
+      obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
+      obj.attributes&.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
     end
   end
 end

lib/trophy_api_client/types/user.rb

@@ -7,29 +7,28 @@
 module TrophyApiClient
   # A user of your application.
   class User
-    # @return [Boolean] Whether the user is in the control group, meaning they do not receive emails or
-    #  other communications from Trophy.
-    attr_reader :control
-    # @return [DateTime] The date and time the user was created, in ISO 8601 format.
-    attr_reader :created
-    # @return [DateTime] The date and time the user was last updated, in ISO 8601 format.
-    attr_reader :updated
     # @return [String] The ID of the user in your database. Must be a string.
     attr_reader :id
-    # @return [String] The user's email address. Required if subscribeToEmails is true.
+    # @return [String] The user's email address.
     attr_reader :email
-    # @return [String] The name to refer to the user by in emails.
+    # @return [String] The name of the user.
     attr_reader :name
-    # @return [String] The user's timezone (used for email scheduling).
+    # @return [String] The user's timezone.
     attr_reader :tz
-    # @return [Array<String>] The user's device tokens, used for push notifications.
+    # @return [Array<String>] The user's device tokens.
     attr_reader :device_tokens
-    # @return [Boolean] Whether the user should receive Trophy-powered emails. If false, Trophy will not
-    #  store the user's email address.
+    # @return [Boolean] Whether the user is opted into receiving Trophy-powered emails.
     attr_reader :subscribe_to_emails
     # @return [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
     #  up in the Trophy dashboard.
     attr_reader :attributes
+    # @return [Boolean] Whether the user is in the control group, meaning they do not receive emails or
+    #  other communications from Trophy.
+    attr_reader :control
+    # @return [DateTime] The date and time the user was created, in ISO 8601 format.
+    attr_reader :created
+    # @return [DateTime] The date and time the user was last updated, in ISO 8601 format.
+    attr_reader :updated
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -38,45 +37,44 @@ class User
 
     OMIT = Object.new
 
+    # @param id [String] The ID of the user in your database. Must be a string.
+    # @param email [String] The user's email address.
+    # @param name [String] The name of the user.
+    # @param tz [String] The user's timezone.
+    # @param device_tokens [Array<String>] The user's device tokens.
+    # @param subscribe_to_emails [Boolean] Whether the user is opted into receiving Trophy-powered emails.
+    # @param attributes [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
+    #  up in the Trophy dashboard.
     # @param control [Boolean] Whether the user is in the control group, meaning they do not receive emails or
     #  other communications from Trophy.
     # @param created [DateTime] The date and time the user was created, in ISO 8601 format.
     # @param updated [DateTime] The date and time the user was last updated, in ISO 8601 format.
-    # @param id [String] The ID of the user in your database. Must be a string.
-    # @param email [String] The user's email address. Required if subscribeToEmails is true.
-    # @param name [String] The name to refer to the user by in emails.
-    # @param tz [String] The user's timezone (used for email scheduling).
-    # @param device_tokens [Array<String>] The user's device tokens, used for push notifications.
-    # @param subscribe_to_emails [Boolean] Whether the user should receive Trophy-powered emails. If false, Trophy will not
-    #  store the user's email address.
-    # @param attributes [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
-    #  up in the Trophy dashboard.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::User]
-    def initialize(control:, created:, updated:, id:, email:, name:, device_tokens:, subscribe_to_emails:, attributes:,
-                   tz: OMIT, additional_properties: nil)
-      @control = control
-      @created = created
-      @updated = updated
+    def initialize(id:, device_tokens:, subscribe_to_emails:, attributes:, control:, created:, updated:, email: OMIT,
+                   name: OMIT, tz: OMIT, additional_properties: nil)
       @id = id
-      @email = email
-      @name = name
+      @email = email if email != OMIT
+      @name = name if name != OMIT
       @tz = tz if tz != OMIT
       @device_tokens = device_tokens
       @subscribe_to_emails = subscribe_to_emails
       @attributes = attributes
+      @control = control
+      @created = created
+      @updated = updated
       @additional_properties = additional_properties
       @_field_set = {
-        "control": control,
-        "created": created,
-        "updated": updated,
         "id": id,
         "email": email,
         "name": name,
         "tz": tz,
         "deviceTokens": device_tokens,
         "subscribeToEmails": subscribe_to_emails,
-        "attributes": attributes
+        "attributes": attributes,
+        "control": control,
+        "created": created,
+        "updated": updated
       }.reject do |_k, v|
         v == OMIT
       end
@@ -89,27 +87,27 @@ def initialize(control:, created:, updated:, id:, email:, name:, device_tokens:,
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      control = parsed_json["control"]
-      created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
-      updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
       id = parsed_json["id"]
       email = parsed_json["email"]
       name = parsed_json["name"]
       tz = parsed_json["tz"]
       device_tokens = parsed_json["deviceTokens"]
       subscribe_to_emails = parsed_json["subscribeToEmails"]
       attributes = parsed_json["attributes"]
+      control = parsed_json["control"]
+      created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
+      updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
       new(
-        control: control,
-        created: created,
-        updated: updated,
         id: id,
         email: email,
         name: name,
         tz: tz,
         device_tokens: device_tokens,
         subscribe_to_emails: subscribe_to_emails,
         attributes: attributes,
+        control: control,
+        created: created,
+        updated: updated,
         additional_properties: struct
       )
     end
@@ -128,16 +126,16 @@ def to_json(*_args)
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.control.is_a?(Boolean) != false || raise("Passed value for field obj.control is not the expected type, validation failed.")
-      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
-      obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
       obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
-      obj.email.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-      obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
       obj.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
       obj.device_tokens.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
       obj.subscribe_to_emails.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
       obj.attributes.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
+      obj.control.is_a?(Boolean) != false || raise("Passed value for field obj.control is not the expected type, validation failed.")
+      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+      obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
     end
   end
 end