test_sdk 0.0.4

data/lib/test_sdk/types/financial_metrics.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class FinancialMetrics
+    # @return [String] The date of the financial metrics.
+    attr_reader :date
+    # @return [Float] The lifetime gross margin, integrated over all time.
+    attr_reader :lifetime_gross_margin
+    # @return [Float] The lifetime operating margin, integrated over all time.
+    attr_reader :lifetime_operating_margin
+    # @return [Float] The rule of 40, defined as the year over year growth plus the operating margin,
+    #  with slight smoothing to handle variations.
+    attr_reader :rule_of40
+    # @return [Float] The magic number, defined as the revenue growth divided by the offset sales and
+    #  marketing cost, with slight smoothing to handle variations.
+    attr_reader :magic_number
+    # @return [Float] The burn multiple, defined as the cash burn divided by the revenue growth, with
+    #  slight smoothing to handle variations. The operating margin is used in place of
+    #  the cash burn if the cash burn is not available. Not defined if the revenue
+    #  growth is negative.
+    attr_reader :burn_multiple
+    # @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 date [String] The date of the financial metrics.
+    # @param lifetime_gross_margin [Float] The lifetime gross margin, integrated over all time.
+    # @param lifetime_operating_margin [Float] The lifetime operating margin, integrated over all time.
+    # @param rule_of40 [Float] The rule of 40, defined as the year over year growth plus the operating margin,
+    #  with slight smoothing to handle variations.
+    # @param magic_number [Float] The magic number, defined as the revenue growth divided by the offset sales and
+    #  marketing cost, with slight smoothing to handle variations.
+    # @param burn_multiple [Float] The burn multiple, defined as the cash burn divided by the revenue growth, with
+    #  slight smoothing to handle variations. The operating margin is used in place of
+    #  the cash burn if the cash burn is not available. Not defined if the revenue
+    #  growth is negative.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::FinancialMetrics]
+    def initialize(date:, lifetime_gross_margin: OMIT, lifetime_operating_margin: OMIT, rule_of40: OMIT,
+                   magic_number: OMIT, burn_multiple: OMIT, additional_properties: nil)
+      @date = date
+      @lifetime_gross_margin = lifetime_gross_margin if lifetime_gross_margin != OMIT
+      @lifetime_operating_margin = lifetime_operating_margin if lifetime_operating_margin != OMIT
+      @rule_of40 = rule_of40 if rule_of40 != OMIT
+      @magic_number = magic_number if magic_number != OMIT
+      @burn_multiple = burn_multiple if burn_multiple != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "date": date,
+        "lifetime_gross_margin": lifetime_gross_margin,
+        "lifetime_operating_margin": lifetime_operating_margin,
+        "rule_of_40": rule_of40,
+        "magic_number": magic_number,
+        "burn_multiple": burn_multiple
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FinancialMetrics
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::FinancialMetrics]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      date = parsed_json["date"]
+      lifetime_gross_margin = parsed_json["lifetime_gross_margin"]
+      lifetime_operating_margin = parsed_json["lifetime_operating_margin"]
+      rule_of40 = parsed_json["rule_of_40"]
+      magic_number = parsed_json["magic_number"]
+      burn_multiple = parsed_json["burn_multiple"]
+      new(
+        date: date,
+        lifetime_gross_margin: lifetime_gross_margin,
+        lifetime_operating_margin: lifetime_operating_margin,
+        rule_of40: rule_of40,
+        magic_number: magic_number,
+        burn_multiple: burn_multiple,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FinancialMetrics 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.date.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
+      obj.lifetime_gross_margin&.is_a?(Float) != false || raise("Passed value for field obj.lifetime_gross_margin is not the expected type, validation failed.")
+      obj.lifetime_operating_margin&.is_a?(Float) != false || raise("Passed value for field obj.lifetime_operating_margin is not the expected type, validation failed.")
+      obj.rule_of40&.is_a?(Float) != false || raise("Passed value for field obj.rule_of40 is not the expected type, validation failed.")
+      obj.magic_number&.is_a?(Float) != false || raise("Passed value for field obj.magic_number is not the expected type, validation failed.")
+      obj.burn_multiple&.is_a?(Float) != false || raise("Passed value for field obj.burn_multiple is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/financials_response.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require_relative "frequency"
+require_relative "income_statement_entry"
+require_relative "category_growth_rates"
+require_relative "financial_metrics"
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class FinancialsResponse
+    # @return [NewDemoApiClient::Frequency] The frequency of the financial data.
+    attr_reader :freq
+    # @return [Array<NewDemoApiClient::IncomeStatementEntry>] The entries in the income statement.
+    attr_reader :income_statement
+    # @return [Array<NewDemoApiClient::CategoryGrowthRates>] The growth rates for each category. The c{x}gr values will occur where x matches
+    #  the frequency.
+    attr_reader :category_growth_rates
+    # @return [Array<NewDemoApiClient::FinancialMetrics>] Derived financial metrics for the company.
+    attr_reader :financial_metrics
+    # @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 freq [NewDemoApiClient::Frequency] The frequency of the financial data.
+    # @param income_statement [Array<NewDemoApiClient::IncomeStatementEntry>] The entries in the income statement.
+    # @param category_growth_rates [Array<NewDemoApiClient::CategoryGrowthRates>] The growth rates for each category. The c{x}gr values will occur where x matches
+    #  the frequency.
+    # @param financial_metrics [Array<NewDemoApiClient::FinancialMetrics>] Derived financial metrics for the company.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::FinancialsResponse]
+    def initialize(freq: OMIT, income_statement: OMIT, category_growth_rates: OMIT, financial_metrics: OMIT,
+                   additional_properties: nil)
+      @freq = freq if freq != OMIT
+      @income_statement = income_statement if income_statement != OMIT
+      @category_growth_rates = category_growth_rates if category_growth_rates != OMIT
+      @financial_metrics = financial_metrics if financial_metrics != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "freq": freq,
+        "income_statement": income_statement,
+        "category_growth_rates": category_growth_rates,
+        "financial_metrics": financial_metrics
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of FinancialsResponse
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::FinancialsResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      freq = parsed_json["freq"]
+      income_statement = parsed_json["income_statement"]&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::IncomeStatementEntry.from_json(json_object: item)
+      end
+      category_growth_rates = parsed_json["category_growth_rates"]&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::CategoryGrowthRates.from_json(json_object: item)
+      end
+      financial_metrics = parsed_json["financial_metrics"]&.map do |item|
+        item = item.to_json
+        NewDemoApiClient::FinancialMetrics.from_json(json_object: item)
+      end
+      new(
+        freq: freq,
+        income_statement: income_statement,
+        category_growth_rates: category_growth_rates,
+        financial_metrics: financial_metrics,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FinancialsResponse 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.freq&.is_a?(NewDemoApiClient::Frequency) != false || raise("Passed value for field obj.freq is not the expected type, validation failed.")
+      obj.income_statement&.is_a?(Array) != false || raise("Passed value for field obj.income_statement is not the expected type, validation failed.")
+      obj.category_growth_rates&.is_a?(Array) != false || raise("Passed value for field obj.category_growth_rates is not the expected type, validation failed.")
+      obj.financial_metrics&.is_a?(Array) != false || raise("Passed value for field obj.financial_metrics is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/frequency.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module NewDemoApiClient
+  class Frequency
+    M = "M"
+    Q = "Q"
+    A = "A"
+  end
+end

data/lib/test_sdk/types/function_level_growth_accounting.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  # Represents the growth accounting metrics at the function level for a company.
+  #  This model captures the changes in employee count within specific functions over
+  #  time.
+  class FunctionLevelGrowthAccounting
+    # @return [String] The function or department within the company.
+    attr_reader :function
+    # @return [String] The date of the entry in YYYYQ format.
+    attr_reader :date
+    # @return [Integer] The number of active employees in the function during the period.
+    attr_reader :active
+    # @return [Integer] The number of new employees in the function during the period.
+    attr_reader :new
+    # @return [Integer] The number of employees retained in the function from the last period.
+    attr_reader :retained
+    # @return [Integer] The number of employees who left and returned to the function.
+    attr_reader :resurrected
+    # @return [Integer] The number of employees who left the function during the period.
+    attr_reader :churned
+    # @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 function [String] The function or department within the company.
+    # @param date [String] The date of the entry in YYYYQ format.
+    # @param active [Integer] The number of active employees in the function during the period.
+    # @param new [Integer] The number of new employees in the function during the period.
+    # @param retained [Integer] The number of employees retained in the function from the last period.
+    # @param resurrected [Integer] The number of employees who left and returned to the function.
+    # @param churned [Integer] The number of employees who left the function during the period.
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::FunctionLevelGrowthAccounting]
+    def initialize(function:, date:, active:, new:, retained:, resurrected:, churned:, additional_properties: nil)
+      @function = function
+      @date = date
+      @active = active
+      @new = new
+      @retained = retained
+      @resurrected = resurrected
+      @churned = churned
+      @additional_properties = additional_properties
+      @_field_set = {
+        "function": function,
+        "date": date,
+        "active": active,
+        "new": new,
+        "retained": retained,
+        "resurrected": resurrected,
+        "churned": churned
+      }
+    end
+
+    # Deserialize a JSON object to an instance of FunctionLevelGrowthAccounting
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::FunctionLevelGrowthAccounting]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      function = parsed_json["function"]
+      date = parsed_json["date"]
+      active = parsed_json["active"]
+      new = parsed_json["new"]
+      retained = parsed_json["retained"]
+      resurrected = parsed_json["resurrected"]
+      churned = parsed_json["churned"]
+      new(
+        function: function,
+        date: date,
+        active: active,
+        new: new,
+        retained: retained,
+        resurrected: resurrected,
+        churned: churned,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of FunctionLevelGrowthAccounting 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.function.is_a?(String) != false || raise("Passed value for field obj.function is not the expected type, validation failed.")
+      obj.date.is_a?(String) != false || raise("Passed value for field obj.date is not the expected type, validation failed.")
+      obj.active.is_a?(Integer) != false || raise("Passed value for field obj.active is not the expected type, validation failed.")
+      obj.new.is_a?(Integer) != false || raise("Passed value for field obj.new is not the expected type, validation failed.")
+      obj.retained.is_a?(Integer) != false || raise("Passed value for field obj.retained is not the expected type, validation failed.")
+      obj.resurrected.is_a?(Integer) != false || raise("Passed value for field obj.resurrected is not the expected type, validation failed.")
+      obj.churned.is_a?(Integer) != false || raise("Passed value for field obj.churned is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/gcs_signed_url_response.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class GcsSignedURLResponse
+    # @return [String]
+    attr_reader :method
+    # @return [String]
+    attr_reader :url
+    # @return [Hash{String => Object}]
+    attr_reader :fields
+    # @return [Hash{String => Object}]
+    attr_reader :headers
+    # @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 method [String]
+    # @param url [String]
+    # @param fields [Hash{String => Object}]
+    # @param headers [Hash{String => Object}]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::GcsSignedURLResponse]
+    def initialize(method:, url:, fields: OMIT, headers: OMIT, additional_properties: nil)
+      @method = method
+      @url = url
+      @fields = fields if fields != OMIT
+      @headers = headers if headers != OMIT
+      @additional_properties = additional_properties
+      @_field_set = { "method": method, "url": url, "fields": fields, "headers": headers }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of GcsSignedURLResponse
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::GcsSignedURLResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      method = parsed_json["method"]
+      url = parsed_json["url"]
+      fields = parsed_json["fields"]
+      headers = parsed_json["headers"]
+      new(
+        method: method,
+        url: url,
+        fields: fields,
+        headers: headers,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of GcsSignedURLResponse 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.method.is_a?(String) != false || raise("Passed value for field obj.method is not the expected type, validation failed.")
+      obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
+      obj.fields&.is_a?(Hash) != false || raise("Passed value for field obj.fields is not the expected type, validation failed.")
+      obj.headers&.is_a?(Hash) != false || raise("Passed value for field obj.headers is not the expected type, validation failed.")
+    end
+  end
+end

data/lib/test_sdk/types/group_response.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+require "date"
+require_relative "account_manager_response"
+require "ostruct"
+require "json"
+
+module NewDemoApiClient
+  class GroupResponse
+    # @return [String]
+    attr_reader :name
+    # @return [String] The domain of the group
+    attr_reader :domain
+    # @return [String] The thumbnail URL of the group
+    attr_reader :thumbnail_url
+    # @return [String] The email address for analysis to be sent to
+    attr_reader :analysis_email
+    # @return [Boolean] Whether the group has access to the data API
+    attr_reader :data_api_access
+    # @return [Integer]
+    attr_reader :id
+    # @return [DateTime]
+    attr_reader :created_at
+    # @return [DateTime]
+    attr_reader :updated_at
+    # @return [Boolean]
+    attr_reader :is_archived
+    # @return [NewDemoApiClient::AccountManagerResponse]
+    attr_reader :account_manager
+    # @return [Integer]
+    attr_reader :user_count
+    # @return [Integer]
+    attr_reader :deal_count
+    # @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 name [String]
+    # @param domain [String] The domain of the group
+    # @param thumbnail_url [String] The thumbnail URL of the group
+    # @param analysis_email [String] The email address for analysis to be sent to
+    # @param data_api_access [Boolean] Whether the group has access to the data API
+    # @param id [Integer]
+    # @param created_at [DateTime]
+    # @param updated_at [DateTime]
+    # @param is_archived [Boolean]
+    # @param account_manager [NewDemoApiClient::AccountManagerResponse]
+    # @param user_count [Integer]
+    # @param deal_count [Integer]
+    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    # @return [NewDemoApiClient::GroupResponse]
+    def initialize(name:, domain:, id:, thumbnail_url: OMIT, analysis_email: OMIT, data_api_access: OMIT,
+                   created_at: OMIT, updated_at: OMIT, is_archived: OMIT, account_manager: OMIT, user_count: OMIT, deal_count: OMIT, additional_properties: nil)
+      @name = name
+      @domain = domain
+      @thumbnail_url = thumbnail_url if thumbnail_url != OMIT
+      @analysis_email = analysis_email if analysis_email != OMIT
+      @data_api_access = data_api_access if data_api_access != OMIT
+      @id = id
+      @created_at = created_at if created_at != OMIT
+      @updated_at = updated_at if updated_at != OMIT
+      @is_archived = is_archived if is_archived != OMIT
+      @account_manager = account_manager if account_manager != OMIT
+      @user_count = user_count if user_count != OMIT
+      @deal_count = deal_count if deal_count != OMIT
+      @additional_properties = additional_properties
+      @_field_set = {
+        "name": name,
+        "domain": domain,
+        "thumbnail_url": thumbnail_url,
+        "analysis_email": analysis_email,
+        "data_api_access": data_api_access,
+        "id": id,
+        "created_at": created_at,
+        "updated_at": updated_at,
+        "is_archived": is_archived,
+        "account_manager": account_manager,
+        "user_count": user_count,
+        "deal_count": deal_count
+      }.reject do |_k, v|
+        v == OMIT
+      end
+    end
+
+    # Deserialize a JSON object to an instance of GroupResponse
+    #
+    # @param json_object [String]
+    # @return [NewDemoApiClient::GroupResponse]
+    def self.from_json(json_object:)
+      struct = JSON.parse(json_object, object_class: OpenStruct)
+      parsed_json = JSON.parse(json_object)
+      name = parsed_json["name"]
+      domain = parsed_json["domain"]
+      thumbnail_url = parsed_json["thumbnail_url"]
+      analysis_email = parsed_json["analysis_email"]
+      data_api_access = parsed_json["data_api_access"]
+      id = parsed_json["id"]
+      created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+      updated_at = (DateTime.parse(parsed_json["updated_at"]) unless parsed_json["updated_at"].nil?)
+      is_archived = parsed_json["is_archived"]
+      if parsed_json["account_manager"].nil?
+        account_manager = nil
+      else
+        account_manager = parsed_json["account_manager"].to_json
+        account_manager = NewDemoApiClient::AccountManagerResponse.from_json(json_object: account_manager)
+      end
+      user_count = parsed_json["user_count"]
+      deal_count = parsed_json["deal_count"]
+      new(
+        name: name,
+        domain: domain,
+        thumbnail_url: thumbnail_url,
+        analysis_email: analysis_email,
+        data_api_access: data_api_access,
+        id: id,
+        created_at: created_at,
+        updated_at: updated_at,
+        is_archived: is_archived,
+        account_manager: account_manager,
+        user_count: user_count,
+        deal_count: deal_count,
+        additional_properties: struct
+      )
+    end
+
+    # Serialize an instance of GroupResponse 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.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+      obj.domain.is_a?(String) != false || raise("Passed value for field obj.domain is not the expected type, validation failed.")
+      obj.thumbnail_url&.is_a?(String) != false || raise("Passed value for field obj.thumbnail_url is not the expected type, validation failed.")
+      obj.analysis_email&.is_a?(String) != false || raise("Passed value for field obj.analysis_email is not the expected type, validation failed.")
+      obj.data_api_access&.is_a?(Boolean) != false || raise("Passed value for field obj.data_api_access is not the expected type, validation failed.")
+      obj.id.is_a?(Integer) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+      obj.created_at&.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+      obj.updated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.updated_at is not the expected type, validation failed.")
+      obj.is_archived&.is_a?(Boolean) != false || raise("Passed value for field obj.is_archived is not the expected type, validation failed.")
+      obj.account_manager.nil? || NewDemoApiClient::AccountManagerResponse.validate_raw(obj: obj.account_manager)
+      obj.user_count&.is_a?(Integer) != false || raise("Passed value for field obj.user_count is not the expected type, validation failed.")
+      obj.deal_count&.is_a?(Integer) != false || raise("Passed value for field obj.deal_count is not the expected type, validation failed.")
+    end
+  end
+end