trophy_api_client 1.13.0 → 1.26.1

data/lib/trophy_api_client/types/update_points_systems_response.rb

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "admin_points_system"
-require_relative "admin_issue"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # Response containing updated points systems and any per-item issues.
-  class UpdatePointsSystemsResponse
-    # @return [Array<TrophyApiClient::AdminPointsSystem>] Array of successfully updated points systems.
-    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::AdminPointsSystem>] Array of successfully updated points systems.
-    # @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::UpdatePointsSystemsResponse]
-    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 UpdatePointsSystemsResponse
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::UpdatePointsSystemsResponse]
-    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::AdminPointsSystem.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 UpdatePointsSystemsResponse 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/update_tenant_request_item.rb

@@ -1,75 +0,0 @@
-# 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

@@ -1,7 +0,0 @@
-# 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

@@ -1,74 +0,0 @@
-# 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/updated_user.rb

@@ -1,108 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An object with editable user fields.
-  class UpdatedUser
-    # @return [String] The user's email address. Required if subscribeToEmails is true.
-    attr_reader :email
-    # @return [String] The name to refer to the user by in emails.
-    attr_reader :name
-    # @return [String] The user's timezone (used for email scheduling).
-    attr_reader :tz
-    # @return [Array<String>] The user's device tokens, used for push notifications.
-    attr_reader :device_tokens
-    # @return [Boolean] Whether the user should receive Trophy-powered emails. If false, Trophy will not
-    #  store the user's email address.
-    attr_reader :subscribe_to_emails
-    # @return [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
-    #  up in the Trophy dashboard.
-    attr_reader :attributes
-    # @return [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 email [String] The user's email address. Required if subscribeToEmails is true.
-    # @param name [String] The name to refer to the user by in emails.
-    # @param tz [String] The user's timezone (used for email scheduling).
-    # @param device_tokens [Array<String>] The user's device tokens, used for push notifications.
-    # @param subscribe_to_emails [Boolean] Whether the user should receive Trophy-powered emails. If false, Trophy will not
-    #  store the user's email address.
-    # @param attributes [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
-    #  up in the Trophy dashboard.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::UpdatedUser]
-    def initialize(email: OMIT, name: OMIT, tz: OMIT, device_tokens: OMIT, subscribe_to_emails: OMIT, attributes: OMIT,
-                   additional_properties: nil)
-      @email = email if email != OMIT
-      @name = name if name != OMIT
-      @tz = tz if tz != OMIT
-      @device_tokens = device_tokens if device_tokens != OMIT
-      @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
-      @attributes = attributes if attributes != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "email": email,
-        "name": name,
-        "tz": tz,
-        "deviceTokens": device_tokens,
-        "subscribeToEmails": subscribe_to_emails,
-        "attributes": attributes
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of UpdatedUser
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::UpdatedUser]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      email = parsed_json["email"]
-      name = parsed_json["name"]
-      tz = parsed_json["tz"]
-      device_tokens = parsed_json["deviceTokens"]
-      subscribe_to_emails = parsed_json["subscribeToEmails"]
-      attributes = parsed_json["attributes"]
-      new(
-        email: email,
-        name: name,
-        tz: tz,
-        device_tokens: device_tokens,
-        subscribe_to_emails: subscribe_to_emails,
-        attributes: attributes,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of UpdatedUser 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.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
-      obj.device_tokens&.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
-      obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
-      obj.attributes&.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/upserted_user.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # An object with editable user fields.
-  class UpsertedUser
-    # @return [String] The ID of the user in your database. Must be a string.
-    attr_reader :id
-    # @return [String] The user's email address. Required if subscribeToEmails is true.
-    attr_reader :email
-    # @return [String] The name to refer to the user by in emails.
-    attr_reader :name
-    # @return [String] The user's timezone (used for email scheduling).
-    attr_reader :tz
-    # @return [Array<String>] The user's device tokens, used for push notifications.
-    attr_reader :device_tokens
-    # @return [Boolean] Whether the user should receive Trophy-powered emails. If false, Trophy will not
-    #  store the user's email address.
-    attr_reader :subscribe_to_emails
-    # @return [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
-    #  up in the Trophy dashboard.
-    attr_reader :attributes
-    # @return [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 ID of the user in your database. Must be a string.
-    # @param email [String] The user's email address. Required if subscribeToEmails is true.
-    # @param name [String] The name to refer to the user by in emails.
-    # @param tz [String] The user's timezone (used for email scheduling).
-    # @param device_tokens [Array<String>] The user's device tokens, used for push notifications.
-    # @param subscribe_to_emails [Boolean] Whether the user should receive Trophy-powered emails. If false, Trophy will not
-    #  store the user's email address.
-    # @param attributes [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
-    #  up in the Trophy dashboard.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::UpsertedUser]
-    def initialize(id:, email: OMIT, name: OMIT, tz: OMIT, device_tokens: OMIT, subscribe_to_emails: OMIT,
-                   attributes: OMIT, additional_properties: nil)
-      @id = id
-      @email = email if email != OMIT
-      @name = name if name != OMIT
-      @tz = tz if tz != OMIT
-      @device_tokens = device_tokens if device_tokens != OMIT
-      @subscribe_to_emails = subscribe_to_emails if subscribe_to_emails != OMIT
-      @attributes = attributes if attributes != OMIT
-      @additional_properties = additional_properties
-      @_field_set = {
-        "id": id,
-        "email": email,
-        "name": name,
-        "tz": tz,
-        "deviceTokens": device_tokens,
-        "subscribeToEmails": subscribe_to_emails,
-        "attributes": attributes
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of UpsertedUser
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::UpsertedUser]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      id = parsed_json["id"]
-      email = parsed_json["email"]
-      name = parsed_json["name"]
-      tz = parsed_json["tz"]
-      device_tokens = parsed_json["deviceTokens"]
-      subscribe_to_emails = parsed_json["subscribeToEmails"]
-      attributes = parsed_json["attributes"]
-      new(
-        id: id,
-        email: email,
-        name: name,
-        tz: tz,
-        device_tokens: device_tokens,
-        subscribe_to_emails: subscribe_to_emails,
-        attributes: attributes,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of UpsertedUser 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.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
-      obj.device_tokens&.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
-      obj.subscribe_to_emails&.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
-      obj.attributes&.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
-    end
-  end
-end

data/lib/trophy_api_client/types/user.rb

@@ -1,141 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-require "ostruct"
-require "json"
-
-module TrophyApiClient
-  # A user of your application.
-  class User
-    # @return [String] The ID of the user in your database. Must be a string.
-    attr_reader :id
-    # @return [String] The user's email address.
-    attr_reader :email
-    # @return [String] The name of the user.
-    attr_reader :name
-    # @return [String] The user's timezone.
-    attr_reader :tz
-    # @return [Array<String>] The user's device tokens.
-    attr_reader :device_tokens
-    # @return [Boolean] Whether the user is opted into receiving Trophy-powered emails.
-    attr_reader :subscribe_to_emails
-    # @return [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
-    #  up in the Trophy dashboard.
-    attr_reader :attributes
-    # @return [Boolean] Whether the user is in the control group, meaning they do not receive emails or
-    #  other communications from Trophy.
-    attr_reader :control
-    # @return [DateTime] The date and time the user was created, in ISO 8601 format.
-    attr_reader :created
-    # @return [DateTime] The date and time the user was last updated, in ISO 8601 format.
-    attr_reader :updated
-    # @return [OpenStruct] Additional properties unmapped to the current class definition
-    attr_reader :additional_properties
-    # @return [Object]
-    attr_reader :_field_set
-    protected :_field_set
-
-    OMIT = Object.new
-
-    # @param id [String] The ID of the user in your database. Must be a string.
-    # @param email [String] The user's email address.
-    # @param name [String] The name of the user.
-    # @param tz [String] The user's timezone.
-    # @param device_tokens [Array<String>] The user's device tokens.
-    # @param subscribe_to_emails [Boolean] Whether the user is opted into receiving Trophy-powered emails.
-    # @param attributes [Hash{String => String}] User attributes as key-value pairs. Keys must match existing user attributes set
-    #  up in the Trophy dashboard.
-    # @param control [Boolean] Whether the user is in the control group, meaning they do not receive emails or
-    #  other communications from Trophy.
-    # @param created [DateTime] The date and time the user was created, in ISO 8601 format.
-    # @param updated [DateTime] The date and time the user was last updated, in ISO 8601 format.
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-    # @return [TrophyApiClient::User]
-    def initialize(id:, subscribe_to_emails:, attributes:, control:, created:, updated:, email: OMIT, name: OMIT,
-                   tz: OMIT, device_tokens: OMIT, additional_properties: nil)
-      @id = id
-      @email = email if email != OMIT
-      @name = name if name != OMIT
-      @tz = tz if tz != OMIT
-      @device_tokens = device_tokens if device_tokens != OMIT
-      @subscribe_to_emails = subscribe_to_emails
-      @attributes = attributes
-      @control = control
-      @created = created
-      @updated = updated
-      @additional_properties = additional_properties
-      @_field_set = {
-        "id": id,
-        "email": email,
-        "name": name,
-        "tz": tz,
-        "deviceTokens": device_tokens,
-        "subscribeToEmails": subscribe_to_emails,
-        "attributes": attributes,
-        "control": control,
-        "created": created,
-        "updated": updated
-      }.reject do |_k, v|
-        v == OMIT
-      end
-    end
-
-    # Deserialize a JSON object to an instance of User
-    #
-    # @param json_object [String]
-    # @return [TrophyApiClient::User]
-    def self.from_json(json_object:)
-      struct = JSON.parse(json_object, object_class: OpenStruct)
-      parsed_json = JSON.parse(json_object)
-      id = parsed_json["id"]
-      email = parsed_json["email"]
-      name = parsed_json["name"]
-      tz = parsed_json["tz"]
-      device_tokens = parsed_json["deviceTokens"]
-      subscribe_to_emails = parsed_json["subscribeToEmails"]
-      attributes = parsed_json["attributes"]
-      control = parsed_json["control"]
-      created = (DateTime.parse(parsed_json["created"]) unless parsed_json["created"].nil?)
-      updated = (DateTime.parse(parsed_json["updated"]) unless parsed_json["updated"].nil?)
-      new(
-        id: id,
-        email: email,
-        name: name,
-        tz: tz,
-        device_tokens: device_tokens,
-        subscribe_to_emails: subscribe_to_emails,
-        attributes: attributes,
-        control: control,
-        created: created,
-        updated: updated,
-        additional_properties: struct
-      )
-    end
-
-    # Serialize an instance of User 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.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
-      obj.name&.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
-      obj.tz&.is_a?(String) != false || raise("Passed value for field obj.tz is not the expected type, validation failed.")
-      obj.device_tokens&.is_a?(Array) != false || raise("Passed value for field obj.device_tokens is not the expected type, validation failed.")
-      obj.subscribe_to_emails.is_a?(Boolean) != false || raise("Passed value for field obj.subscribe_to_emails is not the expected type, validation failed.")
-      obj.attributes.is_a?(Hash) != false || raise("Passed value for field obj.attributes is not the expected type, validation failed.")
-      obj.control.is_a?(Boolean) != false || raise("Passed value for field obj.control is not the expected type, validation failed.")
-      obj.created.is_a?(DateTime) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
-      obj.updated.is_a?(DateTime) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
-    end
-  end
-end