trophy_api_client 1.3.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4cb9d52fcaab5cf68909f48fb282a528d76efa4d788b57fe4ca290590a27126e
-  data.tar.gz: 07be917c807d0d55ff077b67e758f1265c5bf2e34e98af77fc7835ef14b525d0
+  metadata.gz: 7f93fc6f266f49a381617ca6d262f760e777a174f77daa80f902ced5676ee423
+  data.tar.gz: b67333cb8bd33fcee392d5b917b3b2f70bb48489779d8b42dec3554302f49160
 SHA512:
-  metadata.gz: d012a7bb3f7adf0a59a1e538a5e5baa3861b6ab771a88d0b54cbc30d837aa5cee38d21df5e8aa3b7dd70bb10b30cd05e1966d9cf90b48faef932ceb5b97ed5fb
-  data.tar.gz: a224b34e74c972fddbfad0ba495c1ca61327146d523120203e9c1401da8dc8a096ae4fcb40a21a76a717c0b58e23713a84f9b3f3a7346d1a03b083794c1511f7
+  metadata.gz: 42e60f2f9c52427320993227dd3d3d0afbfcb6f87f1abb4e8513c264c5df8e2a63fc216c54aeb6960cce81ea24f6c3b20b755cda22a7bbd6c77b8a79f56ef3e5
+  data.tar.gz: bf10f0374086942dc1c4967c3299e3664274bdae7cef0b3f91106f61dbd3480bf996389237ae5669501cbc70acfed11ed3c2f25526dac0218b26805d7aeed14c

data/lib/gemconfig.rb

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

data/lib/trophy_api_client/admin/points/boosts/client.rb

@@ -3,7 +3,7 @@
 require_relative "../../../../requests"
 require_relative "types/create_points_boosts_request_boosts_item"
 require_relative "../../../types/create_points_boosts_response"
-require_relative "../../../types/archive_points_boosts_response"
+require_relative "../../../types/delete_points_boosts_response"
 require "async"
 
 module TrophyApiClient
@@ -22,7 +22,7 @@ module TrophyApiClient
         # Create points boosts for multiple users.
         #
         # @param system_key [String] The key of the points system to create boosts for.
-        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 1,000 boosts per request.Request of type Array<TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem>, as a Hash
+        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 100 boosts per request.Request of type Array<TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem>, as a Hash
         #   * :user_id (String)
         #   * :name (String)
         #   * :start (String)
@@ -60,19 +60,19 @@ module TrophyApiClient
           TrophyApiClient::CreatePointsBoostsResponse.from_json(json_object: response.body)
         end
 
-        # Archive multiple points boosts by ID.
+        # Delete multiple points boosts by ID.
         #
         # @param ids [String] A list of up to 100 boost IDs.
         # @param request_options [TrophyApiClient::RequestOptions]
-        # @return [TrophyApiClient::ArchivePointsBoostsResponse]
+        # @return [TrophyApiClient::DeletePointsBoostsResponse]
         # @example
         #  api = TrophyApiClient::Client.new(
         #    base_url: "https://api.example.com",
         #    environment: TrophyApiClient::Environment::PRODUCTION,
         #    api_key: "YOUR_API_KEY"
         #  )
-        #  api.admin.points.boosts.batch_archive
-        def batch_archive(ids: nil, request_options: nil)
+        #  api.admin.points.boosts.delete
+        def delete(ids: nil, request_options: nil)
           response = @request_client.conn.delete 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?
@@ -87,39 +87,7 @@ module TrophyApiClient
             end
             req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/points/boosts"
           end
-          TrophyApiClient::ArchivePointsBoostsResponse.from_json(json_object: response.body)
-        end
-
-        # Archive a points boost by ID.
-        #
-        # @param id [String] The UUID of the points boost to archive
-        # @param request_options [TrophyApiClient::RequestOptions]
-        # @return [Void]
-        # @example
-        #  api = TrophyApiClient::Client.new(
-        #    base_url: "https://api.example.com",
-        #    environment: TrophyApiClient::Environment::PRODUCTION,
-        #    api_key: "YOUR_API_KEY"
-        #  )
-        #  api.admin.points.boosts.archive(id: "id")
-        def archive(id:, request_options: nil)
-          @request_client.conn.delete 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 = {
-          **(req.headers || {}),
-          **@request_client.get_headers,
-          **(request_options&.additional_headers || {})
-            }.compact
-            unless request_options.nil? || request_options&.additional_query_parameters.nil?
-              req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-            end
-            unless request_options.nil? || request_options&.additional_body_parameters.nil?
-              req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-            end
-            req.url "#{@request_client.get_url(environment: admin,
-                                               request_options: request_options)}/points/boosts/#{id}"
-          end
+          TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
         end
       end
 
@@ -136,7 +104,7 @@ module TrophyApiClient
         # Create points boosts for multiple users.
         #
         # @param system_key [String] The key of the points system to create boosts for.
-        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 1,000 boosts per request.Request of type Array<TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem>, as a Hash
+        # @param boosts [Array<Hash>] Array of boosts to create. Maximum 100 boosts per request.Request of type Array<TrophyApiClient::Admin::Points::Boosts::CreatePointsBoostsRequestBoostsItem>, as a Hash
         #   * :user_id (String)
         #   * :name (String)
         #   * :start (String)
@@ -176,19 +144,19 @@ module TrophyApiClient
           end
         end
 
-        # Archive multiple points boosts by ID.
+        # Delete multiple points boosts by ID.
         #
         # @param ids [String] A list of up to 100 boost IDs.
         # @param request_options [TrophyApiClient::RequestOptions]
-        # @return [TrophyApiClient::ArchivePointsBoostsResponse]
+        # @return [TrophyApiClient::DeletePointsBoostsResponse]
         # @example
         #  api = TrophyApiClient::Client.new(
         #    base_url: "https://api.example.com",
         #    environment: TrophyApiClient::Environment::PRODUCTION,
         #    api_key: "YOUR_API_KEY"
         #  )
-        #  api.admin.points.boosts.batch_archive
-        def batch_archive(ids: nil, request_options: nil)
+        #  api.admin.points.boosts.delete
+        def delete(ids: nil, request_options: nil)
           Async do
             response = @request_client.conn.delete do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -204,41 +172,7 @@ module TrophyApiClient
               end
               req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/points/boosts"
             end
-            TrophyApiClient::ArchivePointsBoostsResponse.from_json(json_object: response.body)
-          end
-        end
-
-        # Archive a points boost by ID.
-        #
-        # @param id [String] The UUID of the points boost to archive
-        # @param request_options [TrophyApiClient::RequestOptions]
-        # @return [Void]
-        # @example
-        #  api = TrophyApiClient::Client.new(
-        #    base_url: "https://api.example.com",
-        #    environment: TrophyApiClient::Environment::PRODUCTION,
-        #    api_key: "YOUR_API_KEY"
-        #  )
-        #  api.admin.points.boosts.archive(id: "id")
-        def archive(id:, request_options: nil)
-          Async do
-            @request_client.conn.delete 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 = {
-            **(req.headers || {}),
-            **@request_client.get_headers,
-            **(request_options&.additional_headers || {})
-              }.compact
-              unless request_options.nil? || request_options&.additional_query_parameters.nil?
-                req.params = { **(request_options&.additional_query_parameters || {}) }.compact
-              end
-              unless request_options.nil? || request_options&.additional_body_parameters.nil?
-                req.body = { **(request_options&.additional_body_parameters || {}) }.compact
-              end
-              req.url "#{@request_client.get_url(environment: admin,
-                                                 request_options: request_options)}/points/boosts/#{id}"
-            end
+            TrophyApiClient::DeletePointsBoostsResponse.from_json(json_object: response.body)
           end
         end
       end

data/lib/trophy_api_client/admin/streaks/client.rb

@@ -17,9 +17,11 @@ module TrophyApiClient
         @request_client = request_client
       end
 
-      # Restore streaks for multiple users to the maximum length in the last 90 days (in
-      #  the case of daily streaks), one year (in the case of weekly streaks), or two
-      #  years (in the case of monthly streaks).
+      # Restore streaks for multiple users to the maximum previously achieved streak
+      #  length found within the current restore window: the last 90 days for daily
+      #  streaks, weekly periods starting with the week containing the start of the
+      #  current calendar year for weekly streaks, and monthly periods starting at the
+      #  beginning of the previous calendar year for monthly streaks.
       #
       # @param users [Array<Hash>] Array of users to restore streaks for. Maximum 100 users per request.Request of type Array<TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem>, as a Hash
       #   * :id (String)
@@ -61,9 +63,11 @@ module TrophyApiClient
         @request_client = request_client
       end
 
-      # Restore streaks for multiple users to the maximum length in the last 90 days (in
-      #  the case of daily streaks), one year (in the case of weekly streaks), or two
-      #  years (in the case of monthly streaks).
+      # Restore streaks for multiple users to the maximum previously achieved streak
+      #  length found within the current restore window: the last 90 days for daily
+      #  streaks, weekly periods starting with the week containing the start of the
+      #  current calendar year for weekly streaks, and monthly periods starting at the
+      #  beginning of the previous calendar year for monthly streaks.
       #
       # @param users [Array<Hash>] Array of users to restore streaks for. Maximum 100 users per request.Request of type Array<TrophyApiClient::Admin::Streaks::RestoreStreaksRequestUsersItem>, as a Hash
       #   * :id (String)

data/lib/trophy_api_client/admin/streaks/freezes/client.rb

@@ -20,7 +20,7 @@ module TrophyApiClient
 
         # Create streak freezes for multiple users.
         #
-        # @param freezes [Array<Hash>] Array of freezes to create. Maximum 1,000 freezes per request.Request of type Array<TrophyApiClient::Admin::Streaks::Freezes::CreateStreakFreezesRequestFreezesItem>, as a Hash
+        # @param freezes [Array<Hash>] Array of freezes to create. Maximum 100 freezes per request.Request of type Array<TrophyApiClient::Admin::Streaks::Freezes::CreateStreakFreezesRequestFreezesItem>, as a Hash
         #   * :user_id (String)
         # @param request_options [TrophyApiClient::RequestOptions]
         # @return [TrophyApiClient::CreateStreakFreezesResponse]
@@ -62,7 +62,7 @@ module TrophyApiClient
 
         # Create streak freezes for multiple users.
         #
-        # @param freezes [Array<Hash>] Array of freezes to create. Maximum 1,000 freezes per request.Request of type Array<TrophyApiClient::Admin::Streaks::Freezes::CreateStreakFreezesRequestFreezesItem>, as a Hash
+        # @param freezes [Array<Hash>] Array of freezes to create. Maximum 100 freezes per request.Request of type Array<TrophyApiClient::Admin::Streaks::Freezes::CreateStreakFreezesRequestFreezesItem>, as a Hash
         #   * :user_id (String)
         # @param request_options [TrophyApiClient::RequestOptions]
         # @return [TrophyApiClient::CreateStreakFreezesResponse]

data/lib/trophy_api_client/types/admin_issue.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "admin_issue_severity"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # An issue encountered while processing an item in an admin API request.
+  class AdminIssue
+    # @return [String] The ID of the user the issue relates to, when applicable.
+    attr_reader :user_id
+    # @return [String] The ID of the points boost the issue relates to, when applicable.
+    attr_reader :boost_id
+    # @return [Integer] The zero-based index of the item the issue relates to, when no resource ID
+    #  exists yet.
+    attr_reader :index
+    # @return [TrophyApiClient::AdminIssueSeverity] The severity level of the issue.
+    attr_reader :severity
+    # @return [String] A human-readable description of the issue.
+    attr_reader :message
+    # @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 user_id [String] The ID of the user the issue relates to, when applicable.
+    # @param boost_id [String] The ID of the points boost the issue relates to, when applicable.
+    # @param index [Integer] The zero-based index of the item the issue relates to, when no resource ID
+    #  exists yet.
+    # @param severity [TrophyApiClient::AdminIssueSeverity] The severity level of the issue.
+    # @param message [String] A human-readable description of the issue.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::AdminIssue]
+    def initialize(severity:, message:, user_id: OMIT, boost_id: OMIT, index: OMIT, additional_properties: nil)
+      @user_id = user_id if user_id != OMIT
+      @boost_id = boost_id if boost_id != OMIT
+      @index = index if index != OMIT
+      @severity = severity
+      @message = message
+      @additional_properties = additional_properties
+      @_field_set = {
+        "userId": user_id,
+        "boostId": boost_id,
+        "index": index,
+        "severity": severity,
+        "message": message
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of AdminIssue
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::AdminIssue]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      user_id = parsed_json["userId"]
+      boost_id = parsed_json["boostId"]
+      index = parsed_json["index"]
+      severity = parsed_json["severity"]
+      message = parsed_json["message"]
+      new(
+        user_id: user_id,
+        boost_id: boost_id,
+        index: index,
+        severity: severity,
+        message: message,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of AdminIssue 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.user_id&.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
+      obj.boost_id&.is_a?(String) != false || raise("Passed value for field obj.boost_id is not the expected type, validation failed.")
+      obj.index&.is_a?(Integer) != false || raise("Passed value for field obj.index is not the expected type, validation failed.")
+      obj.severity.is_a?(TrophyApiClient::AdminIssueSeverity) != false || raise("Passed value for field obj.severity is not the expected type, validation failed.")
+      obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/trophy_api_client/types/{bulk_insert_issue_level.rb → admin_issue_severity.rb}

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   # The severity level of the issue.
-  class BulkInsertIssueLevel
+  class AdminIssueSeverity
     ERROR = "error"
     WARNING = "warning"
   end

data/lib/trophy_api_client/types/create_points_boosts_response.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "created_points_boost"
-require_relative "bulk_insert_issue"
+require_relative "admin_issue"
 require "ostruct"
 require "json"
 
@@ -11,7 +11,7 @@ module TrophyApiClient
   class CreatePointsBoostsResponse
     # @return [Array<TrophyApiClient::CreatedPointsBoost>] Array of successfully created boosts.
     attr_reader :created
-    # @return [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during boost creation.
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost creation.
     attr_reader :issues
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -22,7 +22,7 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param created [Array<TrophyApiClient::CreatedPointsBoost>] Array of successfully created boosts.
-    # @param issues [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during boost creation.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost creation.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::CreatePointsBoostsResponse]
     def initialize(created:, issues:, additional_properties: nil)
@@ -45,7 +45,7 @@ module TrophyApiClient
       end
       issues = parsed_json["issues"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::BulkInsertIssue.from_json(json_object: item)
+        TrophyApiClient::AdminIssue.from_json(json_object: item)
       end
       new(
         created: created,

data/lib/trophy_api_client/types/create_streak_freezes_response.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "bulk_insert_issue"
+require_relative "admin_issue"
 require "ostruct"
 require "json"
 
 module TrophyApiClient
   # Response containing any issues encountered while creating streak freezes.
   class CreateStreakFreezesResponse
-    # @return [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during freeze creation.
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during freeze creation.
     attr_reader :issues
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -17,7 +17,7 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param issues [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during freeze creation.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during freeze creation.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::CreateStreakFreezesResponse]
     def initialize(issues:, additional_properties: nil)
@@ -35,7 +35,7 @@ module TrophyApiClient
       parsed_json = JSON.parse(json_object)
       issues = parsed_json["issues"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::BulkInsertIssue.from_json(json_object: item)
+        TrophyApiClient::AdminIssue.from_json(json_object: item)
       end
       new(issues: issues, additional_properties: struct)
     end

data/lib/trophy_api_client/types/delete_points_boosts_response.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require_relative "deleted_resource"
+require_relative "admin_issue"
+require "ostruct"
+require "json"
+
+module TrophyApiClient
+  # Response containing the points boosts that were deleted and any per-item issues.
+  class DeletePointsBoostsResponse
+    # @return [Array<TrophyApiClient::DeletedResource>] Array of deleted points boosts represented by ID.
+    attr_reader :deleted
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost archival.
+    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 deleted [Array<TrophyApiClient::DeletedResource>] Array of deleted points boosts represented by ID.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during boost archival.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [TrophyApiClient::DeletePointsBoostsResponse]
+    def initialize(deleted:, issues:, additional_properties: nil)
+      @deleted = deleted
+      @issues = issues
+      @additional_properties = additional_properties
+      @_field_set = { "deleted": deleted, "issues": issues }
+    end
+
+    # Deserialize a JSON object to an instance of DeletePointsBoostsResponse
+    #
+    # @param json_object [String]
+    # @return [TrophyApiClient::DeletePointsBoostsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      deleted = parsed_json["deleted"]&.map do |item|
+        item = item.to_json
+        TrophyApiClient::DeletedResource.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(
+        deleted: deleted,
+        issues: issues,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of DeletePointsBoostsResponse 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.deleted.is_a?(Array) != false || raise("Passed value for field obj.deleted 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/{archive_points_boosts_response.rb → deleted_resource.rb}

@@ -4,10 +4,10 @@ require "ostruct"
 require "json"
 
 module TrophyApiClient
-  # Response containing the count of archived points boosts.
-  class ArchivePointsBoostsResponse
-    # @return [Integer] The number of boosts that were archived.
-    attr_reader :archived_count
+  # A deleted resource represented by ID.
+  class DeletedResource
+    # @return [String] The ID of the deleted resource.
+    attr_reader :id
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
     # @return [Object]
@@ -16,27 +16,27 @@ module TrophyApiClient
 
     OMIT = Object.new
 
-    # @param archived_count [Integer] The number of boosts that were archived.
+    # @param id [String] The ID of the deleted resource.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::ArchivePointsBoostsResponse]
-    def initialize(archived_count:, additional_properties: nil)
-      @archived_count = archived_count
+    # @return [TrophyApiClient::DeletedResource]
+    def initialize(id:, additional_properties: nil)
+      @id = id
       @additional_properties = additional_properties
-      @_field_set = { "archivedCount": archived_count }
+      @_field_set = { "id": id }
     end
 
-    # Deserialize a JSON object to an instance of ArchivePointsBoostsResponse
+    # Deserialize a JSON object to an instance of DeletedResource
     #
     # @param json_object [String]
-    # @return [TrophyApiClient::ArchivePointsBoostsResponse]
+    # @return [TrophyApiClient::DeletedResource]
     def self.from_json(json_object:)
       struct = JSON.parse(json_object, object_class: OpenStruct)
       parsed_json = JSON.parse(json_object)
-      archived_count = parsed_json["archivedCount"]
-      new(archived_count: archived_count, additional_properties: struct)
+      id = parsed_json["id"]
+      new(id: id, additional_properties: struct)
     end
 
-    # Serialize an instance of ArchivePointsBoostsResponse to a JSON object
+    # Serialize an instance of DeletedResource to a JSON object
     #
     # @return [String]
     def to_json(*_args)
@@ -50,7 +50,7 @@ module TrophyApiClient
     # @param obj [Object]
     # @return [Void]
     def self.validate_raw(obj:)
-      obj.archived_count.is_a?(Integer) != false || raise("Passed value for field obj.archived_count 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.")
     end
   end
 end

data/lib/trophy_api_client/types/restore_streaks_response.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "bulk_insert_issue"
+require_relative "admin_issue"
 require "ostruct"
 require "json"
 
@@ -9,7 +9,7 @@ module TrophyApiClient
   class RestoreStreaksResponse
     # @return [Array<String>] Array of user IDs whose streaks were successfully restored.
     attr_reader :restored_users
-    # @return [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during streak restoration.
+    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during streak restoration.
     attr_reader :issues
     # @return [OpenStruct] Additional properties unmapped to the current class definition
     attr_reader :additional_properties
@@ -20,7 +20,7 @@ module TrophyApiClient
     OMIT = Object.new
 
     # @param restored_users [Array<String>] Array of user IDs whose streaks were successfully restored.
-    # @param issues [Array<TrophyApiClient::BulkInsertIssue>] Array of issues encountered during streak restoration.
+    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during streak restoration.
     # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
     # @return [TrophyApiClient::RestoreStreaksResponse]
     def initialize(restored_users:, issues:, additional_properties: nil)
@@ -40,7 +40,7 @@ module TrophyApiClient
       restored_users = parsed_json["restoredUsers"]
       issues = parsed_json["issues"]&.map do |item|
         item = item.to_json
-        TrophyApiClient::BulkInsertIssue.from_json(json_object: item)
+        TrophyApiClient::AdminIssue.from_json(json_object: item)
       end
       new(
         restored_users: restored_users,

data/lib/trophy_api_client/version.rb

@@ -1,3 +1,3 @@
 module MyGem
-  VERSION = "1.3.4"
+  VERSION = "1.5.0"
 end

data/lib/types_export.rb

@@ -94,10 +94,11 @@ require_relative "trophy_api_client/types/created_points_boost_status"
 require_relative "trophy_api_client/types/created_points_boost_rounding"
 require_relative "trophy_api_client/types/created_points_boost"
 require_relative "trophy_api_client/types/create_points_boosts_response"
-require_relative "trophy_api_client/types/archive_points_boosts_response"
+require_relative "trophy_api_client/types/delete_points_boosts_response"
 require_relative "trophy_api_client/types/restore_streaks_response"
-require_relative "trophy_api_client/types/bulk_insert_issue_level"
-require_relative "trophy_api_client/types/bulk_insert_issue"
+require_relative "trophy_api_client/types/admin_issue_severity"
+require_relative "trophy_api_client/types/admin_issue"
+require_relative "trophy_api_client/types/deleted_resource"
 require_relative "trophy_api_client/types/wrapped_metric_by_attribute_value_value"
 require_relative "trophy_api_client/types/wrapped_metric"
 require_relative "trophy_api_client/types/wrapped_points"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trophy_api_client
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Trophy Labs, Inc
@@ -123,10 +123,9 @@ files:
 - lib/trophy_api_client/types/achievement_response_trigger.rb
 - lib/trophy_api_client/types/achievement_response_user_attributes_item.rb
 - lib/trophy_api_client/types/achievement_with_stats_response.rb
-- lib/trophy_api_client/types/archive_points_boosts_response.rb
+- lib/trophy_api_client/types/admin_issue.rb
+- lib/trophy_api_client/types/admin_issue_severity.rb
 - lib/trophy_api_client/types/base_streak_response.rb
-- lib/trophy_api_client/types/bulk_insert_issue.rb
-- lib/trophy_api_client/types/bulk_insert_issue_level.rb
 - lib/trophy_api_client/types/bulk_streak_response.rb
 - lib/trophy_api_client/types/bulk_streak_response_item.rb
 - lib/trophy_api_client/types/create_points_boosts_response.rb
@@ -134,6 +133,8 @@ files:
 - lib/trophy_api_client/types/created_points_boost.rb
 - lib/trophy_api_client/types/created_points_boost_rounding.rb
 - lib/trophy_api_client/types/created_points_boost_status.rb
+- lib/trophy_api_client/types/delete_points_boosts_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
 - lib/trophy_api_client/types/get_user_points_response.rb

data/lib/trophy_api_client/types/bulk_insert_issue.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "bulk_insert_issue_level"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An issue encountered while bulk inserting data.
-  class BulkInsertIssue
-    # @return [String] The ID of the user the issue relates to.
-    attr_reader :user_id
-    # @return [TrophyApiClient::BulkInsertIssueLevel] The severity level of the issue.
-    attr_reader :level
-    # @return [String] A human-readable description of the issue.
-    attr_reader :reason
-    # @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 user_id [String] The ID of the user the issue relates to.
-    # @param level [TrophyApiClient::BulkInsertIssueLevel] The severity level of the issue.
-    # @param reason [String] A human-readable description of the issue.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::BulkInsertIssue]
-    def initialize(user_id:, level:, reason:, additional_properties: nil)
-      @user_id = user_id
-      @level = level
-      @reason = reason
-      @additional_properties = additional_properties
-      @_field_set = { "userId": user_id, "level": level, "reason": reason }
-    end
-
-    # Deserialize a JSON object to an instance of BulkInsertIssue
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::BulkInsertIssue]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      user_id = parsed_json["userId"]
-      level = parsed_json["level"]
-      reason = parsed_json["reason"]
-      new(
-        user_id: user_id,
-        level: level,
-        reason: reason,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of BulkInsertIssue 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.user_id.is_a?(String) != false || raise("Passed value for field obj.user_id is not the expected type, validation failed.")
-      obj.level.is_a?(TrophyApiClient::BulkInsertIssueLevel) != false || raise("Passed value for field obj.level is not the expected type, validation failed.")
-      obj.reason.is_a?(String) != false || raise("Passed value for field obj.reason is not the expected type, validation failed.")
-    end
-  end
-end