trophy_api_client 1.13.0 → 1.26.1

data/lib/trophy_api_client/types/admin_points_trigger_user_attributes_item.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  class AdminPointsTriggerUserAttributesItem
-    # @return [String]
-    attr_reader :attribute_id
-    # @return [String]
-    attr_reader :attribute_value
-    # @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 attribute_id [String]
-    # @param attribute_value [String]
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::AdminPointsTriggerUserAttributesItem]
-    def initialize(attribute_id:, attribute_value:, additional_properties: nil)
-      @attribute_id = attribute_id
-      @attribute_value = attribute_value
-      @additional_properties = additional_properties
-      @_field_set = { "attributeId": attribute_id, "attributeValue": attribute_value }
-    end
-
-    # Deserialize a JSON object to an instance of AdminPointsTriggerUserAttributesItem
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::AdminPointsTriggerUserAttributesItem]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      attribute_id = parsed_json["attributeId"]
-      attribute_value = parsed_json["attributeValue"]
-      new(
-        attribute_id: attribute_id,
-        attribute_value: attribute_value,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of AdminPointsTriggerUserAttributesItem 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.attribute_id.is_a?(String) != false || raise("Passed value for field obj.attribute_id is not the expected type, validation failed.")
-      obj.attribute_value.is_a?(String) != false || raise("Passed value for field obj.attribute_value is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/admin_tenant.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_tenant_status"
-require "date"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # A tenant in a multi-tenant environment.
-  class AdminTenant
-    # @return [String] The tenant UUID.
-    attr_reader :id
-    # @return [String] The external customer ID for this tenant.
-    attr_reader :customer_id
-    # @return [String] Human-readable name for the tenant.
-    attr_reader :name
-    # @return [TrophyApiClient::AdminTenantStatus] The lifecycle status of the tenant.
-    attr_reader :status
-    # @return [DateTime] When the tenant was created.
-    attr_reader :created
-    # @return [DateTime] When the tenant was last updated.
-    attr_reader :updated
-    # @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 tenant UUID.
-    # @param customer_id [String] The external customer ID for this tenant.
-    # @param name [String] Human-readable name for the tenant.
-    # @param status [TrophyApiClient::AdminTenantStatus] The lifecycle status of the tenant.
-    # @param created [DateTime] When the tenant was created.
-    # @param updated [DateTime] When the tenant was last updated.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::AdminTenant]
-    def initialize(id:, customer_id:, name:, status:, created:, updated:, additional_properties: nil)
-      @id = id
-      @customer_id = customer_id
-      @name = name
-      @status = status
-      @created = created
-      @updated = updated
-      @additional_properties = additional_properties
-      @_field_set = {
-        "id": id,
-        "customerId": customer_id,
-        "name": name,
-        "status": status,
-        "created": created,
-        "updated": updated
-      }
-    end
-
-    # Deserialize a JSON object to an instance of AdminTenant
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::AdminTenant]
-    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"]
-      status = parsed_json["status"]
-      created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
-      updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
-      new(
-        id: id,
-        customer_id: customer_id,
-        name: name,
-        status: status,
-        created: created,
-        updated: updated,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of AdminTenant 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.")
-      obj.status.is_a?(TrophyApiClient::AdminTenantStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
-      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
-      obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/admin_tenant_status.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module TrophyApiClient
-  # The lifecycle status of the tenant.
-  class AdminTenantStatus
-    ACTIVE = "active"
-    ARCHIVED = "archived"
-  end
-end

data/lib/trophy_api_client/types/base_streak_response.rb

@@ -1,144 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "streak_frequency"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  class BaseStreakResponse
-    # @return [Integer] The length of the user's current streak.
-    attr_reader :length
-    # @return [TrophyApiClient::StreakFrequency] The frequency of the streak.
-    attr_reader :frequency
-    # @return [String] The date the streak started.
-    attr_reader :started
-    # @return [String] The start date of the current streak period.
-    attr_reader :period_start
-    # @return [String] The end date of the current streak period.
-    attr_reader :period_end
-    # @return [String] The date the streak will expire if the user does not increment a metric.
-    attr_reader :expires
-    # @return [Integer] The number of available streak freezes. Only present if the organization has
-    #  enabled streak freezes.
-    attr_reader :freezes
-    # @return [Integer] The maximum number of streak freezes a user can have. Only present if the
-    #  organization has enabled streak freezes.
-    attr_reader :max_freezes
-    # @return [Integer] The interval at which the user will earn streak freezes, in days. Only present
-    #  if the organization has enabled streak freeze auto-earn.
-    attr_reader :freeze_auto_earn_interval
-    # @return [Integer] The amount of streak freezes the user will earn per interval. Only present if
-    #  the organization has enabled streak freeze auto-earn.
-    attr_reader :freeze_auto_earn_amount
-    # @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 length [Integer] The length of the user's current streak.
-    # @param frequency [TrophyApiClient::StreakFrequency] The frequency of the streak.
-    # @param started [String] The date the streak started.
-    # @param period_start [String] The start date of the current streak period.
-    # @param period_end [String] The end date of the current streak period.
-    # @param expires [String] The date the streak will expire if the user does not increment a metric.
-    # @param freezes [Integer] The number of available streak freezes. Only present if the organization has
-    #  enabled streak freezes.
-    # @param max_freezes [Integer] The maximum number of streak freezes a user can have. Only present if the
-    #  organization has enabled streak freezes.
-    # @param freeze_auto_earn_interval [Integer] The interval at which the user will earn streak freezes, in days. Only present
-    #  if the organization has enabled streak freeze auto-earn.
-    # @param freeze_auto_earn_amount [Integer] The amount of streak freezes the user will earn per interval. Only present if
-    #  the organization has enabled streak freeze auto-earn.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::BaseStreakResponse]
-    def initialize(length:, frequency:, started: OMIT, period_start: OMIT, period_end: OMIT, expires: OMIT,
-                   freezes: OMIT, max_freezes: OMIT, freeze_auto_earn_interval: OMIT, freeze_auto_earn_amount: OMIT, additional_properties: nil)
-      @length = length
-      @frequency = frequency
-      @started = started if started != OMIT
-      @period_start = period_start if period_start != OMIT
-      @period_end = period_end if period_end != OMIT
-      @expires = expires if expires != OMIT
-      @freezes = freezes if freezes != OMIT
-      @max_freezes = max_freezes if max_freezes != OMIT
-      @freeze_auto_earn_interval = freeze_auto_earn_interval if freeze_auto_earn_interval != OMIT
-      @freeze_auto_earn_amount = freeze_auto_earn_amount if freeze_auto_earn_amount != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "length": length,
-        "frequency": frequency,
-        "started": started,
-        "periodStart": period_start,
-        "periodEnd": period_end,
-        "expires": expires,
-        "freezes": freezes,
-        "maxFreezes": max_freezes,
-        "freezeAutoEarnInterval": freeze_auto_earn_interval,
-        "freezeAutoEarnAmount": freeze_auto_earn_amount
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of BaseStreakResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::BaseStreakResponse]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      length = parsed_json["length"]
-      frequency = parsed_json["frequency"]
-      started = parsed_json["started"]
-      period_start = parsed_json["periodStart"]
-      period_end = parsed_json["periodEnd"]
-      expires = parsed_json["expires"]
-      freezes = parsed_json["freezes"]
-      max_freezes = parsed_json["maxFreezes"]
-      freeze_auto_earn_interval = parsed_json["freezeAutoEarnInterval"]
-      freeze_auto_earn_amount = parsed_json["freezeAutoEarnAmount"]
-      new(
-        length: length,
-        frequency: frequency,
-        started: started,
-        period_start: period_start,
-        period_end: period_end,
-        expires: expires,
-        freezes: freezes,
-        max_freezes: max_freezes,
-        freeze_auto_earn_interval: freeze_auto_earn_interval,
-        freeze_auto_earn_amount: freeze_auto_earn_amount,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of BaseStreakResponse 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.length.is_a?(Integer) != false || raise("Passed value for field obj.length is not the expected type, validation failed.")
-      obj.frequency.is_a?(TrophyApiClient::StreakFrequency) != false || raise("Passed value for field obj.frequency is not the expected type, validation failed.")
-      obj.started&.is_a?(String) != false || raise("Passed value for field obj.started is not the expected type, validation failed.")
-      obj.period_start&.is_a?(String) != false || raise("Passed value for field obj.period_start is not the expected type, validation failed.")
-      obj.period_end&.is_a?(String) != false || raise("Passed value for field obj.period_end is not the expected type, validation failed.")
-      obj.expires&.is_a?(String) != false || raise("Passed value for field obj.expires is not the expected type, validation failed.")
-      obj.freezes&.is_a?(Integer) != false || raise("Passed value for field obj.freezes is not the expected type, validation failed.")
-      obj.max_freezes&.is_a?(Integer) != false || raise("Passed value for field obj.max_freezes is not the expected type, validation failed.")
-      obj.freeze_auto_earn_interval&.is_a?(Integer) != false || raise("Passed value for field obj.freeze_auto_earn_interval is not the expected type, validation failed.")
-      obj.freeze_auto_earn_amount&.is_a?(Integer) != false || raise("Passed value for field obj.freeze_auto_earn_amount is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/bulk_streak_response.rb

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

data/lib/trophy_api_client/types/bulk_streak_response_item.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  class BulkStreakResponseItem
-    # @return [String] The ID of the user.
-    attr_reader :user_id
-    # @return [Integer] The length of the user's streak.
-    attr_reader :streak_length
-    # @return [String] The timestamp the streak was extended, as a string. Null if the streak is not
-    #  active.
-    attr_reader :extended
-    # @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.
-    # @param streak_length [Integer] The length of the user's streak.
-    # @param extended [String] The timestamp the streak was extended, as a string. Null if the streak is not
-    #  active.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::BulkStreakResponseItem]
-    def initialize(user_id:, streak_length:, extended: OMIT, additional_properties: nil)
-      @user_id = user_id
-      @streak_length = streak_length
-      @extended = extended if extended != OMIT
-      @additional_properties = additional_properties
-      @_field_set = { "userId": user_id, "streakLength": streak_length, "extended": extended }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of BulkStreakResponseItem
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::BulkStreakResponseItem]
-    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"]
-      streak_length = parsed_json["streakLength"]
-      extended = parsed_json["extended"]
-      new(
-        user_id: user_id,
-        streak_length: streak_length,
-        extended: extended,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of BulkStreakResponseItem 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.streak_length.is_a?(Integer) != false || raise("Passed value for field obj.streak_length is not the expected type, validation failed.")
-      obj.extended&.is_a?(String) != false || raise("Passed value for field obj.extended is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/create_attribute_request_item.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "create_attribute_request_item_type"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An attribute to create.
-  class CreateAttributeRequestItem
-    # @return [String] The attribute name.
-    attr_reader :name
-    # @return [String] The attribute key. Only alphanumeric characters, hyphens, and underscores are
-    #  permitted.
-    attr_reader :key
-    # @return [TrophyApiClient::CreateAttributeRequestItemType] The attribute type.
-    attr_reader :type
-    # @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 name [String] The attribute name.
-    # @param key [String] The attribute key. Only alphanumeric characters, hyphens, and underscores are
-    #  permitted.
-    # @param type [TrophyApiClient::CreateAttributeRequestItemType] The attribute type.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::CreateAttributeRequestItem]
-    def initialize(name:, key:, type:, additional_properties: nil)
-      @name = name
-      @key = key
-      @type = type
-      @additional_properties = additional_properties
-      @_field_set = { "name": name, "key": key, "type": type }
-    end
-
-    # Deserialize a JSON object to an instance of CreateAttributeRequestItem
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::CreateAttributeRequestItem]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      name = parsed_json["name"]
-      key = parsed_json["key"]
-      type = parsed_json["type"]
-      new(
-        name: name,
-        key: key,
-        type: type,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of CreateAttributeRequestItem 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.key.is_a?(String) != false || raise("Passed value for field obj.key is not the expected type, validation failed.")
-      obj.type.is_a?(TrophyApiClient::CreateAttributeRequestItemType) != false || raise("Passed value for field obj.type is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/create_attribute_request_item_type.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module TrophyApiClient
-  # The attribute type.
-  class CreateAttributeRequestItemType
-    USER = "user"
-    EVENT = "event"
-  end
-end

data/lib/trophy_api_client/types/create_attributes_request.rb

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

data/lib/trophy_api_client/types/create_attributes_response.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_attribute"
-require_relative "admin_issue"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # Response containing created attributes and any per-item issues.
-  class CreateAttributesResponse
-    # @return [Array<TrophyApiClient::AdminAttribute>] Array of successfully created attributes.
-    attr_reader :created
-    # @return [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during attribute creation.
-    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 created [Array<TrophyApiClient::AdminAttribute>] Array of successfully created attributes.
-    # @param issues [Array<TrophyApiClient::AdminIssue>] Array of issues encountered during attribute creation.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::CreateAttributesResponse]
-    def initialize(created:, issues:, additional_properties: nil)
-      @created = created
-      @issues = issues
-      @additional_properties = additional_properties
-      @_field_set = { "created": created, "issues": issues }
-    end
-
-    # Deserialize a JSON object to an instance of CreateAttributesResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::CreateAttributesResponse]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      created = parsed_json["created"]&.map do |item|
-        item = item.to_json
-        TrophyApiClient::AdminAttribute.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(
-        created: created,
-        issues: issues,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of CreateAttributesResponse 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.created.is_a?(Array) != false || raise("Passed value for field obj.created 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