trophy_api_client 1.14.0 → 1.26.1

data/lib/requests.rb

@@ -1,189 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "environment"
-require "faraday"
-require "faraday/retry"
-require "async/http/faraday"
-
-module TrophyApiClient
-  class RequestClient
-    # @return [Faraday]
-    attr_reader :conn
-    # @return [String]
-    attr_reader :base_url
-    # @return [String]
-    attr_reader :api_key
-    # @return [String]
-    attr_reader :default_environment
-
-    # @param base_url [String]
-    # @param environment [TrophyApiClient::Environment]
-    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
-    # @param timeout_in_seconds [Long]
-    # @param api_key [String]
-    # @param tenant_id [String] The tenant identifier for multi-tenant organisations. Required when the
-    #  organisation has multi-tenancy enabled. The value should be your internal ID for
-    #  the tenant. Ignored for single-tenant organisations.
-    # @return [TrophyApiClient::RequestClient]
-    def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::PRODUCTION, max_retries: nil,
-                   timeout_in_seconds: nil, tenant_id: nil)
-      @default_environment = environment
-      @api_key = api_key
-      @headers = {}
-      @headers["Tenant-ID"] = tenant_id unless tenant_id.nil?
-      @conn = Faraday.new(headers: @headers) do |faraday|
-        faraday.request :json
-        faraday.response :raise_error, include_request: true
-        faraday.request :retry, { max: max_retries } unless max_retries.nil?
-        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
-      end
-    end
-
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @param environment [String]
-    # @return [String]
-    def get_url(environment:, request_options: nil)
-      request_options&.base_url || @default_environment[environment] || @base_url
-    end
-
-    # @return [Hash{String => String}]
-    def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "trophy_api_client" }
-      headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
-      headers
-    end
-  end
-
-  class AsyncRequestClient
-    # @return [Faraday]
-    attr_reader :conn
-    # @return [String]
-    attr_reader :base_url
-    # @return [String]
-    attr_reader :api_key
-    # @return [String]
-    attr_reader :default_environment
-
-    # @param base_url [String]
-    # @param environment [TrophyApiClient::Environment]
-    # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
-    # @param timeout_in_seconds [Long]
-    # @param api_key [String]
-    # @param tenant_id [String] The tenant identifier for multi-tenant organisations. Required when the
-    #  organisation has multi-tenancy enabled. The value should be your internal ID for
-    #  the tenant. Ignored for single-tenant organisations.
-    # @return [TrophyApiClient::AsyncRequestClient]
-    def initialize(api_key:, base_url: nil, environment: TrophyApiClient::Environment::PRODUCTION, max_retries: nil,
-                   timeout_in_seconds: nil, tenant_id: nil)
-      @default_environment = environment
-      @api_key = api_key
-      @headers = {}
-      @headers["Tenant-ID"] = tenant_id unless tenant_id.nil?
-      @conn = Faraday.new(headers: @headers) do |faraday|
-        faraday.request :json
-        faraday.response :raise_error, include_request: true
-        faraday.adapter :async_http
-        faraday.request :retry, { max: max_retries } unless max_retries.nil?
-        faraday.options.timeout = timeout_in_seconds unless timeout_in_seconds.nil?
-      end
-    end
-
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @param environment [String]
-    # @return [String]
-    def get_url(environment:, request_options: nil)
-      request_options&.base_url || @default_environment[environment] || @base_url
-    end
-
-    # @return [Hash{String => String}]
-    def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "trophy_api_client" }
-      headers["X-API-KEY"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
-      headers
-    end
-  end
-
-  # Additional options for request-specific configuration when calling APIs via the
-  #  SDK.
-  class RequestOptions
-    # @return [String]
-    attr_reader :base_url
-    # @return [String]
-    attr_reader :api_key
-    # @return [String] The tenant identifier for multi-tenant organisations. Required when the
-    #  organisation has multi-tenancy enabled. The value should be your internal ID for
-    #  the tenant. Ignored for single-tenant organisations.
-    attr_reader :tenant_id
-    # @return [Hash{String => Object}]
-    attr_reader :additional_headers
-    # @return [Hash{String => Object}]
-    attr_reader :additional_query_parameters
-    # @return [Hash{String => Object}]
-    attr_reader :additional_body_parameters
-    # @return [Long]
-    attr_reader :timeout_in_seconds
-
-    # @param base_url [String]
-    # @param api_key [String]
-    # @param tenant_id [String] The tenant identifier for multi-tenant organisations. Required when the
-    #  organisation has multi-tenancy enabled. The value should be your internal ID for
-    #  the tenant. Ignored for single-tenant organisations.
-    # @param additional_headers [Hash{String => Object}]
-    # @param additional_query_parameters [Hash{String => Object}]
-    # @param additional_body_parameters [Hash{String => Object}]
-    # @param timeout_in_seconds [Long]
-    # @return [TrophyApiClient::RequestOptions]
-    def initialize(base_url: nil, api_key: nil, tenant_id: nil, additional_headers: nil,
-                   additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil)
-      @base_url = base_url
-      @api_key = api_key
-      @tenant_id = tenant_id
-      @additional_headers = additional_headers
-      @additional_query_parameters = additional_query_parameters
-      @additional_body_parameters = additional_body_parameters
-      @timeout_in_seconds = timeout_in_seconds
-    end
-  end
-
-  # Additional options for request-specific configuration when calling APIs via the
-  #  SDK.
-  class IdempotencyRequestOptions
-    # @return [String]
-    attr_reader :base_url
-    # @return [String]
-    attr_reader :api_key
-    # @return [String] The tenant identifier for multi-tenant organisations. Required when the
-    #  organisation has multi-tenancy enabled. The value should be your internal ID for
-    #  the tenant. Ignored for single-tenant organisations.
-    attr_reader :tenant_id
-    # @return [Hash{String => Object}]
-    attr_reader :additional_headers
-    # @return [Hash{String => Object}]
-    attr_reader :additional_query_parameters
-    # @return [Hash{String => Object}]
-    attr_reader :additional_body_parameters
-    # @return [Long]
-    attr_reader :timeout_in_seconds
-
-    # @param base_url [String]
-    # @param api_key [String]
-    # @param tenant_id [String] The tenant identifier for multi-tenant organisations. Required when the
-    #  organisation has multi-tenancy enabled. The value should be your internal ID for
-    #  the tenant. Ignored for single-tenant organisations.
-    # @param additional_headers [Hash{String => Object}]
-    # @param additional_query_parameters [Hash{String => Object}]
-    # @param additional_body_parameters [Hash{String => Object}]
-    # @param timeout_in_seconds [Long]
-    # @return [TrophyApiClient::IdempotencyRequestOptions]
-    def initialize(base_url: nil, api_key: nil, tenant_id: nil, additional_headers: nil,
-                   additional_query_parameters: nil, additional_body_parameters: nil, timeout_in_seconds: nil)
-      @base_url = base_url
-      @api_key = api_key
-      @tenant_id = tenant_id
-      @additional_headers = additional_headers
-      @additional_query_parameters = additional_query_parameters
-      @additional_body_parameters = additional_body_parameters
-      @timeout_in_seconds = timeout_in_seconds
-    end
-  end
-end

data/lib/trophy_api_client/achievements/client.rb

@@ -1,196 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../requests"
-require_relative "../types/achievement_with_stats_response"
-require "json"
-require_relative "../types/upserted_user"
-require_relative "../types/achievement_completion_response"
-require "async"
-
-module TrophyApiClient
-  class AchievementsClient
-    # @return [TrophyApiClient::RequestClient]
-    attr_reader :request_client
-
-    # @param request_client [TrophyApiClient::RequestClient]
-    # @return [TrophyApiClient::AchievementsClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Get all achievements and their completion stats.
-    #
-    # @param user_attributes [String] Optional colon-delimited user attributes in the format
-    #  attribute:value,attribute:value. Only achievements accessible to a user with the
-    #  provided attributes will be returned.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.achievements.all(user_attributes: "plan-type:premium,region:us-east")
-    def all(user_attributes: 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-        req.headers = {
-      **(req.headers || {}),
-      **@request_client.get_headers,
-      **(request_options&.additional_headers || {})
-        }.compact
-        req.params = {
-          **(request_options&.additional_query_parameters || {}),
-          "userAttributes": user_attributes
-        }.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: api, request_options: request_options)}/achievements"
-      end
-      parsed_json = JSON.parse(response.body)
-      parsed_json&.map do |item|
-        item = item.to_json
-        TrophyApiClient::AchievementWithStatsResponse.from_json(json_object: item)
-      end
-    end
-
-    # Mark an achievement as completed for a user.
-    #
-    # @param key [String] Unique reference of the achievement as set when created.
-    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpsertedUser, as a Hash
-    #   * :id (String)
-    #   * :email (String)
-    #   * :name (String)
-    #   * :tz (String)
-    #   * :device_tokens (Array<String>)
-    #   * :subscribe_to_emails (Boolean)
-    #   * :attributes (Hash{String => String})
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::AchievementCompletionResponse]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
-    def complete(key:, user:, 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.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_options&.additional_body_parameters || {}), user: user }.compact
-        req.url "#{@request_client.get_url(environment: api,
-                                           request_options: request_options)}/achievements/#{key}/complete"
-      end
-      TrophyApiClient::AchievementCompletionResponse.from_json(json_object: response.body)
-    end
-  end
-
-  class AsyncAchievementsClient
-    # @return [TrophyApiClient::AsyncRequestClient]
-    attr_reader :request_client
-
-    # @param request_client [TrophyApiClient::AsyncRequestClient]
-    # @return [TrophyApiClient::AsyncAchievementsClient]
-    def initialize(request_client:)
-      @request_client = request_client
-    end
-
-    # Get all achievements and their completion stats.
-    #
-    # @param user_attributes [String] Optional colon-delimited user attributes in the format
-    #  attribute:value,attribute:value. Only achievements accessible to a user with the
-    #  provided attributes will be returned.
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [Array<TrophyApiClient::AchievementWithStatsResponse>]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.achievements.all(user_attributes: "plan-type:premium,region:us-east")
-    def all(user_attributes: 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.nil?
-          req.headers = {
-        **(req.headers || {}),
-        **@request_client.get_headers,
-        **(request_options&.additional_headers || {})
-          }.compact
-          req.params = {
-            **(request_options&.additional_query_parameters || {}),
-            "userAttributes": user_attributes
-          }.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: api, request_options: request_options)}/achievements"
-        end
-        parsed_json = JSON.parse(response.body)
-        parsed_json&.map do |item|
-          item = item.to_json
-          TrophyApiClient::AchievementWithStatsResponse.from_json(json_object: item)
-        end
-      end
-    end
-
-    # Mark an achievement as completed for a user.
-    #
-    # @param key [String] Unique reference of the achievement as set when created.
-    # @param user [Hash] The user that completed the achievement.Request of type TrophyApiClient::UpsertedUser, as a Hash
-    #   * :id (String)
-    #   * :email (String)
-    #   * :name (String)
-    #   * :tz (String)
-    #   * :device_tokens (Array<String>)
-    #   * :subscribe_to_emails (Boolean)
-    #   * :attributes (Hash{String => String})
-    # @param request_options [TrophyApiClient::RequestOptions]
-    # @return [TrophyApiClient::AchievementCompletionResponse]
-    # @example
-    #  api = TrophyApiClient::Client.new(
-    #    base_url: "https://api.example.com",
-    #    environment: TrophyApiClient::Environment::PRODUCTION,
-    #    api_key: "YOUR_API_KEY"
-    #  )
-    #  api.achievements.complete(key: "finish-onboarding", user: { email: "user@example.com", tz: "Europe/London", id: "user-id" })
-    def complete(key:, user:, 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["Tenant-ID"] = request_options.tenant_id unless request_options&.tenant_id.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_options&.additional_body_parameters || {}), user: user }.compact
-          req.url "#{@request_client.get_url(environment: api,
-                                             request_options: request_options)}/achievements/#{key}/complete"
-        end
-        TrophyApiClient::AchievementCompletionResponse.from_json(json_object: response.body)
-      end
-    end
-  end
-end