trophy_api_client 1.8.0 → 1.10.0

data/lib/trophy_api_client/types/update_tenant_request_item.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # A tenant to update.
+  class UpdateTenantRequestItem
+    # @return [String] The UUID of the tenant to update.
+    attr_reader :id
+    # @return [String] New external customer ID.
+    attr_reader :customer_id
+    # @return [String] New display name for the tenant.
+    attr_reader :name
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param id [String] The UUID of the tenant to update.
+    # @param customer_id [String] New external customer ID.
+    # @param name [String] New display name for the tenant.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UpdateTenantRequestItem]
+    def initialize(id:, customer_id: OMIT, name: OMIT, additional_properties: nil)
+      @id = id
+      @customer_id = customer_id if customer_id != OMIT
+      @name = name if name != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "id": id, "customerId": customer_id, "name": name }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of UpdateTenantRequestItem
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UpdateTenantRequestItem]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      id = parsed_json["id"]
+      customer_id = parsed_json["customerId"]
+      name = parsed_json["name"]
+      new(
+        id: id,
+        customer_id: customer_id,
+        name: name,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateTenantRequestItem to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @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.customer_id&.is_a?(String) != false || raise("Passed value for field obj.customer_id 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.")
+    end
+  end
+end

data/lib/trophy_api_client/types/update_tenants_request.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative "update_tenant_request_item"
+
+module TrophyApiClient
+  UPDATE_TENANTS_REQUEST = Array
+end

data/lib/trophy_api_client/types/update_tenants_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "admin_tenant"
+require_relative "admin_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing updated tenants and any issues.
+  class UpdateTenantsResponse
+    # @return [Array<TrophyApiClient::AdminTenant>] Array of successfully updated tenants.
+    attr_reader :updated
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during update.
+    attr_reader :issues
+    # @return [OpenStruct] Additional properties unmapped to the current class definition
+    attr_reader :additional_properties
+    # @return [Object]
+    attr_reader :_field_set
+    protected :_field_set
+
+    OMIT = Object.new
+
+    # @param updated [Array<TrophyApiClient::AdminTenant>] Array of successfully updated tenants.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during update.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::UpdateTenantsResponse]
+    def initialize(updated:, issues:, additional_properties: nil)
+      @updated = updated
+      @issues = issues
+      @additional_properties = additional_properties
+      @_field_set = { "updated": updated, "issues": issues }
+    end
+
+    # Deserialize a JSON object to an instance of UpdateTenantsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::UpdateTenantsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      updated = parsed_json["updated"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminTenant.from_json(json_object: item)
+      end
+      issues = parsed_json["issues"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::AdminIssue.from_json(json_object: item)
+      end
+      new(
+        updated: updated,
+        issues: issues,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of UpdateTenantsResponse to a JSON object
+    #
+    # @return [String]
+    def to_json(*_args)
+      @_field_set&.to_json
+    end
+
+    # Leveraged for Union-type generation, validate_raw attempts to parse the given
+    #  hash and check each fields type against the current object's property
+    #  definitions.
+    #
+    # @param obj [Object]
+    # @return [Void]
+    def self.validate_raw(obj:)
+      obj.updated.is_a?(Array) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
+      obj.issues.is_a?(Array) != false || raise("Passed value for field obj.issues is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/user_leaderboard_response.rb

@@ -82,8 +82,8 @@ module TrophyApiClient
     #  type. Null for one-time leaderboards.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::UserLeaderboardResponse]
-    def initialize(id:, name:, key:, rank_by:, breakdown_attributes:, start:, max_participants:, rank: OMIT,
-                   value: OMIT, breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
+    def initialize(id:, name:, key:, rank_by:, breakdown_attributes:, start:, rank: OMIT, value: OMIT,
+                   breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, max_participants: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
       @rank = rank if rank != OMIT
       @value = value if value != OMIT
       @id = id
@@ -99,7 +99,7 @@ module TrophyApiClient
       @description = description if description != OMIT
       @start = start
       @end_ = end_ if end_ != OMIT
-      @max_participants = max_participants
+      @max_participants = max_participants if max_participants != OMIT
       @run_unit = run_unit if run_unit != OMIT
       @run_interval = run_interval if run_interval != OMIT
       @additional_properties = additional_properties
@@ -204,7 +204,7 @@ module TrophyApiClient
       obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
       obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
       obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
-      obj.max_participants.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
+      obj.max_participants&.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
       obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
       obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
     end

data/lib/trophy_api_client/types/user_leaderboard_response_with_history.rb

@@ -86,8 +86,8 @@ module TrophyApiClient
     #  type. Null for one-time leaderboards.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::UserLeaderboardResponseWithHistory]
-    def initialize(history:, id:, name:, key:, rank_by:, breakdown_attributes:, start:, max_participants:, rank: OMIT,
-                   value: OMIT, breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
+    def initialize(history:, id:, name:, key:, rank_by:, breakdown_attributes:, start:, rank: OMIT, value: OMIT,
+                   breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, max_participants: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
       @history = history
       @rank = rank if rank != OMIT
       @value = value if value != OMIT
@@ -104,7 +104,7 @@ module TrophyApiClient
       @description = description if description != OMIT
       @start = start
       @end_ = end_ if end_ != OMIT
-      @max_participants = max_participants
+      @max_participants = max_participants if max_participants != OMIT
       @run_unit = run_unit if run_unit != OMIT
       @run_interval = run_interval if run_interval != OMIT
       @additional_properties = additional_properties
@@ -216,7 +216,7 @@ module TrophyApiClient
       obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
       obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
       obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
-      obj.max_participants.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
+      obj.max_participants&.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
       obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
       obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
     end

data/lib/trophy_api_client/types/webhook_user_leaderboard_response.rb

@@ -88,8 +88,8 @@ module TrophyApiClient
     #  type. Null for one-time leaderboards.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::WebhookUserLeaderboardResponse]
-    def initialize(id:, name:, key:, rank_by:, breakdown_attributes:, start:, max_participants:, previous_rank: OMIT, previous_value: OMIT, rank: OMIT, value: OMIT,
-                   breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
+    def initialize(id:, name:, key:, rank_by:, breakdown_attributes:, start:, previous_rank: OMIT, previous_value: OMIT, rank: OMIT, value: OMIT,
+                   breakdown_attribute: OMIT, metric_key: OMIT, metric_name: OMIT, points_system_key: OMIT, points_system_name: OMIT, description: OMIT, end_: OMIT, max_participants: OMIT, run_unit: OMIT, run_interval: OMIT, additional_properties: nil)
       @previous_rank = previous_rank if previous_rank != OMIT
       @previous_value = previous_value if previous_value != OMIT
       @rank = rank if rank != OMIT
@@ -107,7 +107,7 @@ module TrophyApiClient
       @description = description if description != OMIT
       @start = start
       @end_ = end_ if end_ != OMIT
-      @max_participants = max_participants
+      @max_participants = max_participants if max_participants != OMIT
       @run_unit = run_unit if run_unit != OMIT
       @run_interval = run_interval if run_interval != OMIT
       @additional_properties = additional_properties
@@ -220,7 +220,7 @@ module TrophyApiClient
       obj.description&.is_a?(String) != false || raise("Passed value for field obj.description is not the expected type, validation failed.")
       obj.start.is_a?(String) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
       obj.end_&.is_a?(String) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
-      obj.max_participants.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
+      obj.max_participants&.is_a?(Integer) != false || raise("Passed value for field obj.max_participants is not the expected type, validation failed.")
       obj.run_unit&.is_a?(TrophyApiClient::LeaderboardResponseRunUnit) != false || raise("Passed value for field obj.run_unit is not the expected type, validation failed.")
       obj.run_interval&.is_a?(Integer) != false || raise("Passed value for field obj.run_interval is not the expected type, validation failed.")
     end

data/lib/trophy_api_client/users/client.rb

@@ -54,6 +54,7 @@ module TrophyApiClient
       response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -84,6 +85,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -123,6 +125,7 @@ module TrophyApiClient
       response = @request_client.conn.put do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -160,6 +163,7 @@ module TrophyApiClient
       response = @request_client.conn.patch do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -190,6 +194,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -227,6 +232,7 @@ module TrophyApiClient
       response = @request_client.conn.patch do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -257,6 +263,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -294,6 +301,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -339,6 +347,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -382,6 +391,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -422,6 +432,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -461,6 +472,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -494,6 +506,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -544,6 +557,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -593,6 +607,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -630,6 +645,7 @@ module TrophyApiClient
       response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+        req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
         req.headers = {
       **(req.headers || {}),
       **@request_client.get_headers,
@@ -679,6 +695,7 @@ module TrophyApiClient
         response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -711,6 +728,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -752,6 +770,7 @@ module TrophyApiClient
         response = @request_client.conn.put do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -791,6 +810,7 @@ module TrophyApiClient
         response = @request_client.conn.patch do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -823,6 +843,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -863,6 +884,7 @@ module TrophyApiClient
         response = @request_client.conn.patch do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -896,6 +918,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -935,6 +958,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -982,6 +1006,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -1027,6 +1052,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -1069,6 +1095,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -1110,6 +1137,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -1145,6 +1173,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -1197,6 +1226,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -1248,6 +1278,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,
@@ -1287,6 +1318,7 @@ module TrophyApiClient
         response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["X-API-KEY"] = request_options.api_key unless request_options&.api_key.nil?
+          req.headers["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
           req.headers = {
         **(req.headers || {}),
         **@request_client.get_headers,

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.8.0"
+  VERSION = "1.10.0"
 end

data/lib/trophy_api_client.rb

@@ -33,15 +33,19 @@ module TrophyApiClient
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
     # @param api_key [String]
+    # @param tenant_id [String] The tenant identifier for multi-tenant organisations. Required when the
+    #  organisation has multi-tenancy enabled. The value should be your internal ID for
+    #  the tenant. Ignored for single-tenant organisations.
     # @return [TrophyApiClient::Client]
     def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::PRODUCTION, max_retries: nil,
-                   timeout_in_seconds: nil)
+                   timeout_in_seconds: nil, tenant_id: nil)
       @request_client = TrophyApiClient::RequestClient.new(
         base_url: base_url,
         environment: environment,
         max_retries: max_retries,
         timeout_in_seconds: timeout_in_seconds,
-        api_key: api_key
+        api_key: api_key,
+        tenant_id: tenant_id
       )
       @achievements = TrophyApiClient::AchievementsClient.new(request_client: @request_client)
       @metrics = TrophyApiClient::MetricsClient.new(request_client: @request_client)
@@ -74,15 +78,19 @@ module TrophyApiClient
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
     # @param api_key [String]
+    # @param tenant_id [String] The tenant identifier for multi-tenant organisations. Required when the
+    #  organisation has multi-tenancy enabled. The value should be your internal ID for
+    #  the tenant. Ignored for single-tenant organisations.
     # @return [TrophyApiClient::AsyncClient]
     def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::PRODUCTION, max_retries: nil,
-                   timeout_in_seconds: nil)
+                   timeout_in_seconds: nil, tenant_id: nil)
       @async_request_client = TrophyApiClient::AsyncRequestClient.new(
         base_url: base_url,
         environment: environment,
         max_retries: max_retries,
         timeout_in_seconds: timeout_in_seconds,
-        api_key: api_key
+        api_key: api_key,
+        tenant_id: tenant_id
       )
       @achievements = TrophyApiClient::AsyncAchievementsClient.new(request_client: @async_request_client)
       @metrics = TrophyApiClient::AsyncMetricsClient.new(request_client: @async_request_client)

data/lib/types_export.rb

@@ -208,3 +208,13 @@ require_relative "trophy_api_client/types/update_points_systems_request"
 require_relative "trophy_api_client/types/update_points_system_request_item_badge"
 require_relative "trophy_api_client/types/update_points_systems_response"
 require_relative "trophy_api_client/types/delete_points_systems_response"
+require_relative "trophy_api_client/types/admin_tenant_status"
+require_relative "trophy_api_client/types/admin_tenant"
+require_relative "trophy_api_client/types/list_tenants_response"
+require_relative "trophy_api_client/types/create_tenant_request_item"
+require_relative "trophy_api_client/types/create_tenants_request"
+require_relative "trophy_api_client/types/create_tenants_response"
+require_relative "trophy_api_client/types/update_tenant_request_item"
+require_relative "trophy_api_client/types/update_tenants_request"
+require_relative "trophy_api_client/types/update_tenants_response"
+require_relative "trophy_api_client/types/delete_tenants_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -113,6 +113,7 @@ files:
 - lib/trophy_api_client/admin/streaks/freezes/client.rb
 - lib/trophy_api_client/admin/streaks/freezes/types/create_streak_freezes_request_freezes_item.rb
 - lib/trophy_api_client/admin/streaks/types/restore_streaks_request_users_item.rb
+- lib/trophy_api_client/admin/tenants/client.rb
 - lib/trophy_api_client/leaderboards/client.rb
 - lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item.rb
 - lib/trophy_api_client/leaderboards/types/leaderboards_all_response_item_status.rb
@@ -150,6 +151,8 @@ files:
 - lib/trophy_api_client/types/admin_points_trigger_time_unit.rb
 - lib/trophy_api_client/types/admin_points_trigger_type.rb
 - lib/trophy_api_client/types/admin_points_trigger_user_attributes_item.rb
+- lib/trophy_api_client/types/admin_tenant.rb
+- lib/trophy_api_client/types/admin_tenant_status.rb
 - lib/trophy_api_client/types/base_streak_response.rb
 - lib/trophy_api_client/types/bulk_streak_response.rb
 - lib/trophy_api_client/types/bulk_streak_response_item.rb
@@ -189,6 +192,9 @@ files:
 - lib/trophy_api_client/types/create_points_triggers_request.rb
 - lib/trophy_api_client/types/create_points_triggers_response.rb
 - lib/trophy_api_client/types/create_streak_freezes_response.rb
+- lib/trophy_api_client/types/create_tenant_request_item.rb
+- lib/trophy_api_client/types/create_tenants_request.rb
+- lib/trophy_api_client/types/create_tenants_response.rb
 - lib/trophy_api_client/types/created_admin_points_system.rb
 - lib/trophy_api_client/types/created_metric.rb
 - lib/trophy_api_client/types/created_metric_unit_type.rb
@@ -199,6 +205,7 @@ files:
 - lib/trophy_api_client/types/delete_points_levels_response.rb
 - lib/trophy_api_client/types/delete_points_systems_response.rb
 - lib/trophy_api_client/types/delete_points_triggers_response.rb
+- lib/trophy_api_client/types/delete_tenants_response.rb
 - lib/trophy_api_client/types/deleted_resource.rb
 - lib/trophy_api_client/types/error_body.rb
 - lib/trophy_api_client/types/event_response.rb
@@ -217,6 +224,7 @@ files:
 - lib/trophy_api_client/types/list_points_levels_response.rb
 - lib/trophy_api_client/types/list_points_systems_response.rb
 - lib/trophy_api_client/types/list_points_triggers_response.rb
+- lib/trophy_api_client/types/list_tenants_response.rb
 - lib/trophy_api_client/types/metric_event_leaderboard_response.rb
 - lib/trophy_api_client/types/metric_event_leaderboard_response_breakdown_attribute_values_item.rb
 - lib/trophy_api_client/types/metric_event_points_response.rb
@@ -284,6 +292,9 @@ files:
 - lib/trophy_api_client/types/update_points_system_request_item_badge.rb
 - lib/trophy_api_client/types/update_points_systems_request.rb
 - lib/trophy_api_client/types/update_points_systems_response.rb
+- lib/trophy_api_client/types/update_tenant_request_item.rb
+- lib/trophy_api_client/types/update_tenants_request.rb
+- lib/trophy_api_client/types/update_tenants_response.rb
 - lib/trophy_api_client/types/updated_user.rb
 - lib/trophy_api_client/types/upserted_user.rb
 - lib/trophy_api_client/types/user.rb
@@ -346,7 +357,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Ruby library for the Trophy API.
 test_files: []