test_sdk 0.0.4

data/lib/test_sdk/macro/client.rb

@@ -0,0 +1,422 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require "json"
+require_relative "../types/weather_metadata"
+require_relative "../types/weather_gauge"
+require_relative "../types/weather_components"
+require_relative "../types/weather_market_context"
+require "async"
+
+module NewDemoApiClient
+  class MacroClient
+    # @return [NewDemoApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [NewDemoApiClient::RequestClient]
+    # @return [NewDemoApiClient::MacroClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Returns the available segmentations for the weather module.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<String>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_segmentations
+    def get_segmentations(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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/segmentations"
+      end
+      JSON.parse(response.body)
+    end
+
+    # Returns segmentation metadata for each of the classes of segmentations "geo" and
+    #  "sector".
+    #  The geography ("geo") segmentation type refers to major geographic
+    #  segmentations.
+    #  The "sector" segmentation type refers to major business model categories in the
+    #  USA geography.
+    #  The metadata includes parameters used to generate the respective indicators, and
+    #  the metadata needed to
+    #  retrieve the series from the API.
+    #
+    # @param segmentation [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherMetadata>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_metadata(segmentation: "segmentation")
+    def get_metadata(segmentation:, 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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/metadata"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::WeatherMetadata.from_json(json_object: item)
+      end
+    end
+
+    # Returns the overall weather indicator, combined across all stages, for the given
+    #  segmentation slug(s).
+    #  If no slug is provided, the endpoint will return the gauge for all available
+    #  segmentations.
+    #
+    # @param segmentation [String]
+    # @param slug [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherGauge>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_gauge(segmentation: "segmentation")
+    def get_gauge(segmentation:, slug: 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["Authorization"] = request_options.token unless request_options&.token.nil?
+        req.headers = {
+      **(req.headers || {}),
+      **@request_client.get_headers,
+      **(request_options&.additional_headers || {})
+        }.compact
+        req.params = { **(request_options&.additional_query_parameters || {}), "slug": slug }.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/gauges"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::WeatherGauge.from_json(json_object: item)
+      end
+    end
+
+    # Returns the individual components of the weather indicator and some of the
+    #  underlying inputs of those component gauges for the given segmentation slug.
+    #
+    # @param segmentation [String]
+    # @param slug [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherComponents>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_components(segmentation: "segmentation", slug: "slug")
+    def get_components(segmentation:, slug:, 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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/#{slug}/components"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::WeatherComponents.from_json(json_object: item)
+      end
+    end
+
+    # Returns simplified contextual metrics about relevant stages and market activity
+    #  for the given segmentation slug.
+    #
+    # @param segmentation [String]
+    # @param slug [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherMarketContext>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_market_context(segmentation: "segmentation", slug: "slug")
+    def get_market_context(segmentation:, slug:, 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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/#{slug}/market-context"
+      end
+      parsed_json = JSON.parse(response.body)
+      parsed_json&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::WeatherMarketContext.from_json(json_object: item)
+      end
+    end
+  end
+
+  class AsyncMacroClient
+    # @return [NewDemoApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [NewDemoApiClient::AsyncRequestClient]
+    # @return [NewDemoApiClient::AsyncMacroClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Returns the available segmentations for the weather module.
+    #
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<String>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_segmentations
+    def get_segmentations(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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/segmentations"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json
+      end
+    end
+
+    # Returns segmentation metadata for each of the classes of segmentations "geo" and
+    #  "sector".
+    #  The geography ("geo") segmentation type refers to major geographic
+    #  segmentations.
+    #  The "sector" segmentation type refers to major business model categories in the
+    #  USA geography.
+    #  The metadata includes parameters used to generate the respective indicators, and
+    #  the metadata needed to
+    #  retrieve the series from the API.
+    #
+    # @param segmentation [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherMetadata>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_metadata(segmentation: "segmentation")
+    def get_metadata(segmentation:, 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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/metadata"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::WeatherMetadata.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Returns the overall weather indicator, combined across all stages, for the given
+    #  segmentation slug(s).
+    #  If no slug is provided, the endpoint will return the gauge for all available
+    #  segmentations.
+    #
+    # @param segmentation [String]
+    # @param slug [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherGauge>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_gauge(segmentation: "segmentation")
+    def get_gauge(segmentation:, slug: 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["Authorization"] = request_options.token unless request_options&.token.nil?
+          req.headers = {
+        **(req.headers || {}),
+        **@request_client.get_headers,
+        **(request_options&.additional_headers || {})
+          }.compact
+          req.params = { **(request_options&.additional_query_parameters || {}), "slug": slug }.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/gauges"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::WeatherGauge.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Returns the individual components of the weather indicator and some of the
+    #  underlying inputs of those component gauges for the given segmentation slug.
+    #
+    # @param segmentation [String]
+    # @param slug [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherComponents>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_components(segmentation: "segmentation", slug: "slug")
+    def get_components(segmentation:, slug:, 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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/#{slug}/components"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::WeatherComponents.from_json(json_object: item)
+        end
+      end
+    end
+
+    # Returns simplified contextual metrics about relevant stages and market activity
+    #  for the given segmentation slug.
+    #
+    # @param segmentation [String]
+    # @param slug [String]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [Array<NewDemoApiClient::WeatherMarketContext>]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.macro.get_market_context(segmentation: "segmentation", slug: "slug")
+    def get_market_context(segmentation:, slug:, 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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/data/weather/#{segmentation}/#{slug}/market-context"
+        end
+        parsed_json = JSON.parse(response.body)
+        parsed_json&.map do |item|
+          item = item.to_json
+          NewDemoApiClient::WeatherMarketContext.from_json(json_object: item)
+        end
+      end
+    end
+  end
+end

data/lib/test_sdk/metadata/client.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "../types/all_data_metadata_response"
+require "async"
+
+module NewDemoApiClient
+  class MetadataClient
+    # @return [NewDemoApiClient::RequestClient]
+    attr_reader :request_client
+
+    # @param request_client [NewDemoApiClient::RequestClient]
+    # @return [NewDemoApiClient::MetadataClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieve select metadata about all diligence data for a group.
+    #
+    # @param group_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AllDataMetadataResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.metadata.get_diligence_metadata(group_id: 1)
+    def get_diligence_metadata(group_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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/group/#{group_id}/data/metadata"
+      end
+      NewDemoApiClient::AllDataMetadataResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncMetadataClient
+    # @return [NewDemoApiClient::AsyncRequestClient]
+    attr_reader :request_client
+
+    # @param request_client [NewDemoApiClient::AsyncRequestClient]
+    # @return [NewDemoApiClient::AsyncMetadataClient]
+    def initialize(request_client:)
+      @request_client = request_client
+    end
+
+    # Retrieve select metadata about all diligence data for a group.
+    #
+    # @param group_id [Integer]
+    # @param request_options [NewDemoApiClient::RequestOptions]
+    # @return [NewDemoApiClient::AllDataMetadataResponse]
+    # @example
+    #  api = NewDemoApiClient::Client.new(
+    #    base_url: "https://api.example.com",
+    #    environment: NewDemoApiClient::Environment::DEFAULT,
+    #    token: "YOUR_AUTH_TOKEN"
+    #  )
+    #  api.metadata.get_diligence_metadata(group_id: 1)
+    def get_diligence_metadata(group_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["Authorization"] = request_options.token unless request_options&.token.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(request_options: request_options)}/api/v1/group/#{group_id}/data/metadata"
+        end
+        NewDemoApiClient::AllDataMetadataResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end