trophy_api_client 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f93fc6f266f49a381617ca6d262f760e777a174f77daa80f902ced5676ee423
-  data.tar.gz: b67333cb8bd33fcee392d5b917b3b2f70bb48489779d8b42dec3554302f49160
+  metadata.gz: bca4f0a4b33b4764665874e1091b268c9a30d496bc684bbe5d0a6278e4c94c32
+  data.tar.gz: b7ed5377499eced710ba24c76946f5c4502ca4973a3dba684c369dc0a92479ef
 SHA512:
-  metadata.gz: 42e60f2f9c52427320993227dd3d3d0afbfcb6f87f1abb4e8513c264c5df8e2a63fc216c54aeb6960cce81ea24f6c3b20b755cda22a7bbd6c77b8a79f56ef3e5
-  data.tar.gz: bf10f0374086942dc1c4967c3299e3664274bdae7cef0b3f91106f61dbd3480bf996389237ae5669501cbc70acfed11ed3c2f25526dac0218b26805d7aeed14c
+  metadata.gz: f72261a738ecae4692446dc9dbe37fa205dc3ce177fcabd9847dc1f6af1613d7c19cf5be5d99b3cd24b0558450f06098e39fa6415f15046785a6226f2590f0bb
+  data.tar.gz: d8feb721e3fa1b4ee49635d3d7f330cc93f3fdf8692792d947eb3dd0131cf8876985d84b01d17da5e050d773f6224ef4310786e55533e17480cc0fb8affa8718

data/lib/gemconfig.rb

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

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

@@ -0,0 +1,368 @@
+# frozen_string_literal: true
+
+require_relative "../../../requests"
+require_relative "../../types/list_attributes_response"
+require "json"
+require_relative "../../types/create_attributes_request"
+require_relative "../../types/create_attributes_response"
+require_relative "../../types/delete_attributes_response"
+require_relative "../../types/update_attributes_request"
+require_relative "../../types/update_attributes_response"
+require_relative "../../types/admin_attribute"
+require "async"
+
+module TrophyApiClient
+  module Admin
+    class AttributesClient
+      # @return [TrophyApiClient::RequestClient]
+      attr_reader :request_client
+
+      # @param request_client [TrophyApiClient::RequestClient]
+      # @return [TrophyApiClient::Admin::AttributesClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # List attributes.
+      #
+      # @param limit [Integer] Number of records to return.
+      # @param skip [Integer] Number of records to skip from the start of the list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::LIST_ATTRIBUTES_RESPONSE]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.list(limit: 1, skip: 1)
+      def list(limit: nil, skip: nil, request_options: nil)
+        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 = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "limit": limit, "skip": skip }.compact
+          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)}/attributes"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          TrophyApiClient::AdminAttribute.from_json(json_object: item)
+        end
+      end
+
+      # Create attributes.
+      #
+      # @param request [TrophyApiClient::CREATE_ATTRIBUTES_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreateAttributesResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.create(request: [{ name: "Plan", key: "plan", type: USER }, { name: "Device", key: "device", type: EVENT }])
+      def create(request:, request_options: nil)
+        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 = {
+        **(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
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/attributes"
+        end
+        TrophyApiClient::CreateAttributesResponse.from_json(json_object: response.body)
+      end
+
+      # Delete attributes by ID.
+      #
+      # @param ids [String] Attribute IDs to delete. Repeat the query param or provide a comma-separated
+      #  list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::DeleteAttributesResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.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?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "ids": ids }.compact
+          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)}/attributes"
+        end
+        TrophyApiClient::DeleteAttributesResponse.from_json(json_object: response.body)
+      end
+
+      # Update attributes by ID.
+      #
+      # @param request [TrophyApiClient::UPDATE_ATTRIBUTES_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::UpdateAttributesResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.update(request: [{ id: "550e8400-e29b-41d4-a716-446655440000", name: "Subscription Plan" }])
+      def update(request:, request_options: nil)
+        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 = {
+        **(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
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+          req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/attributes"
+        end
+        TrophyApiClient::UpdateAttributesResponse.from_json(json_object: response.body)
+      end
+
+      # Get an attribute by ID.
+      #
+      # @param id [String] The UUID of the attribute to retrieve.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::AdminAttribute]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.get(id: "550e8400-e29b-41d4-a716-446655440000")
+      def get(id:, request_options: nil)
+        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 = {
+        **(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)}/attributes/#{id}"
+        end
+        TrophyApiClient::AdminAttribute.from_json(json_object: response.body)
+      end
+    end
+
+    class AsyncAttributesClient
+      # @return [TrophyApiClient::AsyncRequestClient]
+      attr_reader :request_client
+
+      # @param request_client [TrophyApiClient::AsyncRequestClient]
+      # @return [TrophyApiClient::Admin::AsyncAttributesClient]
+      def initialize(request_client:)
+        @request_client = request_client
+      end
+
+      # List attributes.
+      #
+      # @param limit [Integer] Number of records to return.
+      # @param skip [Integer] Number of records to skip from the start of the list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::LIST_ATTRIBUTES_RESPONSE]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.list(limit: 1, skip: 1)
+      def list(limit: nil, skip: nil, request_options: nil)
+        Async do
+          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 = {
+          **(req.headers || {}),
+          **@request_client.get_headers,
+          **(request_options&.additional_headers || {})
+            }.compact
+            req.params = {
+              **(request_options&.additional_query_parameters || {}),
+              "limit": limit,
+              "skip": skip
+            }.compact
+            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)}/attributes"
+          end
+          parsed_json = JSON.parse(response.body)
+          parsed_json&.map do |item|
+            item = item.to_json
+            TrophyApiClient::AdminAttribute.from_json(json_object: item)
+          end
+        end
+      end
+
+      # Create attributes.
+      #
+      # @param request [TrophyApiClient::CREATE_ATTRIBUTES_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::CreateAttributesResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.create(request: [{ name: "Plan", key: "plan", type: USER }, { name: "Device", key: "device", type: EVENT }])
+      def create(request:, request_options: nil)
+        Async do
+          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 = {
+          **(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
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/attributes"
+          end
+          TrophyApiClient::CreateAttributesResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Delete attributes by ID.
+      #
+      # @param ids [String] Attribute IDs to delete. Repeat the query param or provide a comma-separated
+      #  list.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::DeleteAttributesResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.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?
+            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
+            req.params = { **(request_options&.additional_query_parameters || {}), "ids": ids }.compact
+            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)}/attributes"
+          end
+          TrophyApiClient::DeleteAttributesResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Update attributes by ID.
+      #
+      # @param request [TrophyApiClient::UPDATE_ATTRIBUTES_REQUEST]
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::UpdateAttributesResponse]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.update(request: [{ id: "550e8400-e29b-41d4-a716-446655440000", name: "Subscription Plan" }])
+      def update(request:, request_options: nil)
+        Async do
+          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 = {
+          **(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
+            req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+            req.url "#{@request_client.get_url(environment: admin, request_options: request_options)}/attributes"
+          end
+          TrophyApiClient::UpdateAttributesResponse.from_json(json_object: response.body)
+        end
+      end
+
+      # Get an attribute by ID.
+      #
+      # @param id [String] The UUID of the attribute to retrieve.
+      # @param request_options [TrophyApiClient::RequestOptions]
+      # @return [TrophyApiClient::AdminAttribute]
+      # @example
+      #  api = TrophyApiClient::Client.new(
+      #    base_url: "https://api.example.com",
+      #    environment: TrophyApiClient::Environment::PRODUCTION,
+      #    api_key: "YOUR_API_KEY"
+      #  )
+      #  api.admin.attributes.get(id: "550e8400-e29b-41d4-a716-446655440000")
+      def get(id:, request_options: nil)
+        Async do
+          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 = {
+          **(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)}/attributes/#{id}"
+          end
+          TrophyApiClient::AdminAttribute.from_json(json_object: response.body)
+        end
+      end
+    end
+  end
+end

data/lib/trophy_api_client/admin/client.rb

@@ -1,12 +1,21 @@
 # frozen_string_literal: true
 
 require_relative "../../requests"
+require_relative "attributes/client"
+require_relative "metrics/client"
+require_relative "leaderboards/client"
 require_relative "streaks/client"
 require_relative "points/client"
 
 module TrophyApiClient
   module Admin
     class Client
+      # @return [TrophyApiClient::Admin::AttributesClient]
+      attr_reader :attributes
+      # @return [TrophyApiClient::Admin::MetricsClient]
+      attr_reader :metrics
+      # @return [TrophyApiClient::Admin::LeaderboardsClient]
+      attr_reader :leaderboards
       # @return [TrophyApiClient::Admin::StreaksClient]
       attr_reader :streaks
       # @return [TrophyApiClient::Admin::Points::Client]
@@ -15,12 +24,21 @@ module TrophyApiClient
       # @param request_client [TrophyApiClient::RequestClient]
       # @return [TrophyApiClient::Admin::Client]
       def initialize(request_client:)
+        @attributes = TrophyApiClient::Admin::AttributesClient.new(request_client: request_client)
+        @metrics = TrophyApiClient::Admin::MetricsClient.new(request_client: request_client)
+        @leaderboards = TrophyApiClient::Admin::LeaderboardsClient.new(request_client: request_client)
         @streaks = TrophyApiClient::Admin::StreaksClient.new(request_client: request_client)
         @admin = TrophyApiClient::Admin::Points::Client.new(request_client: request_client)
       end
     end
 
     class AsyncClient
+      # @return [TrophyApiClient::Admin::AsyncAttributesClient]
+      attr_reader :attributes
+      # @return [TrophyApiClient::Admin::AsyncMetricsClient]
+      attr_reader :metrics
+      # @return [TrophyApiClient::Admin::AsyncLeaderboardsClient]
+      attr_reader :leaderboards
       # @return [TrophyApiClient::Admin::AsyncStreaksClient]
       attr_reader :streaks
       # @return [TrophyApiClient::Admin::Points::AsyncClient]
@@ -29,6 +47,9 @@ module TrophyApiClient
       # @param request_client [TrophyApiClient::AsyncRequestClient]
       # @return [TrophyApiClient::Admin::AsyncClient]
       def initialize(request_client:)
+        @attributes = TrophyApiClient::Admin::AsyncAttributesClient.new(request_client: request_client)
+        @metrics = TrophyApiClient::Admin::AsyncMetricsClient.new(request_client: request_client)
+        @leaderboards = TrophyApiClient::Admin::AsyncLeaderboardsClient.new(request_client: request_client)
         @streaks = TrophyApiClient::Admin::AsyncStreaksClient.new(request_client: request_client)
         @admin = TrophyApiClient::Admin::Points::AsyncClient.new(request_client: request_client)
       end