trophy_api_client 1.4.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7604c5f6f0a271ed7eae0b4878f29932ba518ac374f61c0854a4c5afb5a58c6d
-  data.tar.gz: 5b8a86b550c0aba78eb4edae772cfd3799f4108727eb2acac4770e9358fc7c41
+  metadata.gz: 5c1c32e3a98727d1752b80b4d07849c4a41714660879d8c453d6d72885ebf8b9
+  data.tar.gz: f05cc73b2ba4bfd387dcde4fc95e3782da25aec7ba34cac8d6dd543a6b9c1e03
 SHA512:
-  metadata.gz: f31395b433ab72efbd23a45a2e8dbda31c6ba589841e2d3eae7260f5744831948f3460d810cce0e91035c87ac112e47b1abbddc78b5ea9360c745169d364a61f
-  data.tar.gz: 92f5324cb1d892cacdda6303f7617d52e70eb17a3e41df09c93041dc90437eefd9637911fe3da12bc70e31e481c09800845c268084eb9bce03d195920959fae0
+  metadata.gz: d900ec0aa57b4dd88305bd101dc4454f76f39b21be653f2ced8d38dbe8960116b8b856f100712b026b9fdc8aaa4fe6de1d6ae78b969ae10c4ee06daaf048ef05
+  data.tar.gz: 2dbfcfc043fc01d82950b5858b22ee2ce2786aedc595a5d793a1487f69383fb9b89b4834df18927cb75b451ee5658e05270a1edde93752eccdd8de5501de85cf

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module TrophyApiClient
   module Gemconfig
-    VERSION = "1.4.0"
+    VERSION = "1.6.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 in bulk.
+      #
+      # @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 in bulk 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 in bulk 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 in bulk.
+      #
+      # @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 in bulk 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 in bulk 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

@@ -2,6 +2,8 @@
 
 require_relative "../../requests"
 require_relative "streaks/client"
+require_relative "attributes/client"
+require_relative "metrics/client"
 require_relative "points/client"
 
 module TrophyApiClient
@@ -9,6 +11,10 @@ module TrophyApiClient
     class Client
       # @return [TrophyApiClient::Admin::StreaksClient]
       attr_reader :streaks
+      # @return [TrophyApiClient::Admin::AttributesClient]
+      attr_reader :attributes
+      # @return [TrophyApiClient::Admin::MetricsClient]
+      attr_reader :metrics
       # @return [TrophyApiClient::Admin::Points::Client]
       attr_reader :admin
 
@@ -16,6 +22,8 @@ module TrophyApiClient
       # @return [TrophyApiClient::Admin::Client]
       def initialize(request_client:)
         @streaks = TrophyApiClient::Admin::StreaksClient.new(request_client: request_client)
+        @attributes = TrophyApiClient::Admin::AttributesClient.new(request_client: request_client)
+        @metrics = TrophyApiClient::Admin::MetricsClient.new(request_client: request_client)
         @admin = TrophyApiClient::Admin::Points::Client.new(request_client: request_client)
       end
     end
@@ -23,6 +31,10 @@ module TrophyApiClient
     class AsyncClient
       # @return [TrophyApiClient::Admin::AsyncStreaksClient]
       attr_reader :streaks
+      # @return [TrophyApiClient::Admin::AsyncAttributesClient]
+      attr_reader :attributes
+      # @return [TrophyApiClient::Admin::AsyncMetricsClient]
+      attr_reader :metrics
       # @return [TrophyApiClient::Admin::Points::AsyncClient]
       attr_reader :admin
 
@@ -30,6 +42,8 @@ module TrophyApiClient
       # @return [TrophyApiClient::Admin::AsyncClient]
       def initialize(request_client:)
         @streaks = TrophyApiClient::Admin::AsyncStreaksClient.new(request_client: request_client)
+        @attributes = TrophyApiClient::Admin::AsyncAttributesClient.new(request_client: request_client)
+        @metrics = TrophyApiClient::Admin::AsyncMetricsClient.new(request_client: request_client)
         @admin = TrophyApiClient::Admin::Points::AsyncClient.new(request_client: request_client)
       end
     end