trophy_api_client 1.8.0 → 1.9.1

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.9.1"
 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.9.1
 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: []