ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/filter_rules.rb

@@ -0,0 +1,120 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Filter Rules to be applied on Objects.
+  class FilterRules < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of the column to apply the filter on.
+    # @return [String]
+    attr_accessor :column_name
+
+    # The operator to use for filtering. Example: EQ (equals), GT(greater than),
+    # etc.
+    # @return [Operator1]
+    attr_accessor :operator
+
+    # The values to filter on. To get all records, use TS_WILDCARD_ALL as
+    # values.
+    # @return [Array[Object]]
+    attr_accessor :values
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['column_name'] = 'column_name'
+      @_hash['operator'] = 'operator'
+      @_hash['values'] = 'values'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(column_name:, operator:, values:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @column_name = column_name
+      @operator = operator
+      @values = values
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      column_name = hash.key?('column_name') ? hash['column_name'] : nil
+      operator = hash.key?('operator') ? hash['operator'] : nil
+      values = hash.key?('values') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:FilterRulesValues), hash['values']
+      ) : nil
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FilterRules.new(column_name: column_name,
+                      operator: operator,
+                      values: values,
+                      additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [FilterRules | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.column_name,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.operator,
+                                  ->(val) { Operator1.validate(val) }) and
+            UnionTypeLookUp.get(:FilterRulesValues)
+                           .validate(value.values)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['column_name'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['operator'],
+                                ->(val) { Operator1.validate(val) }) and
+          UnionTypeLookUp.get(:FilterRulesValues)
+                         .validate(value['values'])
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} column_name: #{@column_name}, operator: #{@operator}, values: #{@values},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} column_name: #{@column_name.inspect}, operator: #{@operator.inspect},"\
+      " values: #{@values.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/force_logout_users_request.rb

@@ -0,0 +1,77 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ForceLogoutUsersRequest Model.
+  class ForceLogoutUsersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID or name of the users for force logging out their sessions.
+    # @return [Array[String]]
+    attr_accessor :user_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_identifiers'] = 'user_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user_identifiers: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_identifiers = user_identifiers unless user_identifiers == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      user_identifiers =
+        hash.key?('user_identifiers') ? hash['user_identifiers'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      ForceLogoutUsersRequest.new(user_identifiers: user_identifiers,
+                                  additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user_identifiers: #{@user_identifiers}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user_identifiers: #{@user_identifiers.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/frequency.rb

@@ -0,0 +1,75 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Configuration of schedule with cron expression
+  class Frequency < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Schedule selected cron expression.
+    # @return [CronExpression]
+    attr_accessor :cron_expression
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cron_expression'] = 'cron_expression'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cron_expression:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cron_expression = cron_expression
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      cron_expression = CronExpression.from_hash(hash['cron_expression']) if
+        hash['cron_expression']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Frequency.new(cron_expression: cron_expression,
+                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cron_expression: #{@cron_expression}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cron_expression: #{@cron_expression.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/frequency_input.rb

@@ -0,0 +1,75 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Configuration of schedule with cron expression
+  class FrequencyInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Schedule selected cron expression.
+    # @return [CronExpressionInput]
+    attr_accessor :cron_expression
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cron_expression'] = 'cron_expression'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cron_expression:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cron_expression = cron_expression
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      cron_expression = CronExpressionInput.from_hash(hash['cron_expression']) if
+        hash['cron_expression']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      FrequencyInput.new(cron_expression: cron_expression,
+                         additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cron_expression: #{@cron_expression}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cron_expression: #{@cron_expression.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/gcp_web_identity_setup.rb

@@ -0,0 +1,144 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Setup information for GCP clusters using STS AssumeRoleWithWebIdentity.
+  # ThoughtSpot will use its GCP service account to obtain OIDC tokens for AWS
+  # access. Example: {   "thoughtspot_gcp_service_account_id":
+  # "115663769112811637952",   "oidc_provider": "accounts.google.com",
+  # "trust_policy_template": {     "Version": "2012-10-17",     "Statement": [{
+  #      "Effect": "Allow",       "Principal": { "Federated":
+  # "arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com" },
+  #  "Action": "sts:AssumeRoleWithWebIdentity",       "Condition": {
+  # "StringEquals": { "accounts.google.com:sub": "115663769112811637952" } }
+  # }]   },   "setup_instructions": [     "1. Add accounts.google.com as an
+  # Identity Provider in AWS IAM",     "2. Create an IAM role with Web Identity
+  # Federation trust",     "3. Configure the trust policy with ThoughtSpot's GCP
+  # service account ID",     "4. Attach S3 permissions (s3:PutObject,
+  # s3:PutObjectAcl) to the role",     "5. Use the role ARN in your webhook
+  # storage configuration"   ] }
+  class GcpWebIdentitySetup < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ThoughtSpot's GCP service account unique ID (numeric).
+    # This is the 'sub' claim in OIDC tokens and must be included in your
+    # IAM role's trust policy condition.
+    # Example: "115663769112811637952"
+    # @return [String]
+    attr_accessor :thoughtspot_gcp_service_account_id
+
+    # The OIDC identity provider URL. For GCP, this is always
+    # 'accounts.google.com'.
+    # You must configure this as an Identity Provider in AWS IAM.
+    # Example: "accounts.google.com"
+    # @return [String]
+    attr_accessor :oidc_provider
+
+    # Sample IAM trust policy JSON object for Web Identity Federation.
+    # This policy allows ThoughtSpot's GCP service account to assume your AWS
+    # role.
+    # Example: { "Version": "2012-10-17", "Statement": [{ "Effect": "Allow",
+    # "Principal": { "Federated":
+    # "arn:aws:iam::YOUR_AWS_ACCOUNT_ID:oidc-provider/accounts.google.com" },
+    # "Action": "sts:AssumeRoleWithWebIdentity", "Condition": { "StringEquals":
+    # { "accounts.google.com:sub": "115663769112811637952" } } }] }
+    # @return [Object]
+    attr_accessor :trust_policy_template
+
+    # Step-by-step instructions to configure AWS for GCP Web Identity
+    # Federation.
+    # Example: ["1. Add accounts.google.com as an Identity Provider in AWS IAM",
+    # "2. Create an IAM role with Web Identity Federation trust"]
+    # @return [Array[String]]
+    attr_accessor :setup_instructions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['thoughtspot_gcp_service_account_id'] =
+        'thoughtspot_gcp_service_account_id'
+      @_hash['oidc_provider'] = 'oidc_provider'
+      @_hash['trust_policy_template'] = 'trust_policy_template'
+      @_hash['setup_instructions'] = 'setup_instructions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        oidc_provider
+        setup_instructions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        oidc_provider
+        setup_instructions
+      ]
+    end
+
+    def initialize(thoughtspot_gcp_service_account_id:, trust_policy_template:,
+                   oidc_provider: SKIP, setup_instructions: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @thoughtspot_gcp_service_account_id = thoughtspot_gcp_service_account_id
+      @oidc_provider = oidc_provider unless oidc_provider == SKIP
+      @trust_policy_template = trust_policy_template
+      @setup_instructions = setup_instructions unless setup_instructions == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      thoughtspot_gcp_service_account_id =
+        hash.key?('thoughtspot_gcp_service_account_id') ? hash['thoughtspot_gcp_service_account_id'] : nil
+      trust_policy_template =
+        hash.key?('trust_policy_template') ? hash['trust_policy_template'] : nil
+      oidc_provider = hash.key?('oidc_provider') ? hash['oidc_provider'] : SKIP
+      setup_instructions =
+        hash.key?('setup_instructions') ? hash['setup_instructions'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      GcpWebIdentitySetup.new(thoughtspot_gcp_service_account_id: thoughtspot_gcp_service_account_id,
+                              trust_policy_template: trust_policy_template,
+                              oidc_provider: oidc_provider,
+                              setup_instructions: setup_instructions,
+                              additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} thoughtspot_gcp_service_account_id: #{@thoughtspot_gcp_service_account_id},"\
+      " oidc_provider: #{@oidc_provider}, trust_policy_template: #{@trust_policy_template},"\
+      " setup_instructions: #{@setup_instructions}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} thoughtspot_gcp_service_account_id:"\
+      " #{@thoughtspot_gcp_service_account_id.inspect}, oidc_provider: #{@oidc_provider.inspect},"\
+      " trust_policy_template: #{@trust_policy_template.inspect}, setup_instructions:"\
+      " #{@setup_instructions.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/generate_csv_request.rb

@@ -0,0 +1,140 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # GenerateCsvRequest Model.
+  class GenerateCsvRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Start date for the calendar in `MM/dd/yyyy` format.
+    # @return [String]
+    attr_accessor :start_date
+
+    # End date for the calendar in `MM/dd/yyyy` format.
+    # @return [String]
+    attr_accessor :end_date
+
+    # Type of the calendar.
+    # @return [CalendarType]
+    attr_accessor :calendar_type
+
+    # Month offset to start calendar from `January`.
+    # @return [MonthOffset1]
+    attr_accessor :month_offset
+
+    # Specify the starting day of the week.
+    # @return [StartDayOfWeek]
+    attr_accessor :start_day_of_week
+
+    # Prefix to add before the quarter.
+    # @return [String]
+    attr_accessor :quarter_name_prefix
+
+    # Prefix to add before the year.
+    # @return [String]
+    attr_accessor :year_name_prefix
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['start_date'] = 'start_date'
+      @_hash['end_date'] = 'end_date'
+      @_hash['calendar_type'] = 'calendar_type'
+      @_hash['month_offset'] = 'month_offset'
+      @_hash['start_day_of_week'] = 'start_day_of_week'
+      @_hash['quarter_name_prefix'] = 'quarter_name_prefix'
+      @_hash['year_name_prefix'] = 'year_name_prefix'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        calendar_type
+        month_offset
+        start_day_of_week
+        quarter_name_prefix
+        year_name_prefix
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(start_date:, end_date:,
+                   calendar_type: CalendarType::MONTH_OFFSET,
+                   month_offset: MonthOffset1::JANUARY,
+                   start_day_of_week: StartDayOfWeek::SUNDAY,
+                   quarter_name_prefix: SKIP, year_name_prefix: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @start_date = start_date
+      @end_date = end_date
+      @calendar_type = calendar_type unless calendar_type == SKIP
+      @month_offset = month_offset unless month_offset == SKIP
+      @start_day_of_week = start_day_of_week unless start_day_of_week == SKIP
+      @quarter_name_prefix = quarter_name_prefix unless quarter_name_prefix == SKIP
+      @year_name_prefix = year_name_prefix unless year_name_prefix == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      start_date = hash.key?('start_date') ? hash['start_date'] : nil
+      end_date = hash.key?('end_date') ? hash['end_date'] : nil
+      calendar_type = hash['calendar_type'] ||= CalendarType::MONTH_OFFSET
+      month_offset = hash['month_offset'] ||= MonthOffset1::JANUARY
+      start_day_of_week = hash['start_day_of_week'] ||= StartDayOfWeek::SUNDAY
+      quarter_name_prefix =
+        hash.key?('quarter_name_prefix') ? hash['quarter_name_prefix'] : SKIP
+      year_name_prefix =
+        hash.key?('year_name_prefix') ? hash['year_name_prefix'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      GenerateCsvRequest.new(start_date: start_date,
+                             end_date: end_date,
+                             calendar_type: calendar_type,
+                             month_offset: month_offset,
+                             start_day_of_week: start_day_of_week,
+                             quarter_name_prefix: quarter_name_prefix,
+                             year_name_prefix: year_name_prefix,
+                             additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date}, end_date: #{@end_date}, calendar_type:"\
+      " #{@calendar_type}, month_offset: #{@month_offset}, start_day_of_week:"\
+      " #{@start_day_of_week}, quarter_name_prefix: #{@quarter_name_prefix}, year_name_prefix:"\
+      " #{@year_name_prefix}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} start_date: #{@start_date.inspect}, end_date: #{@end_date.inspect},"\
+      " calendar_type: #{@calendar_type.inspect}, month_offset: #{@month_offset.inspect},"\
+      " start_day_of_week: #{@start_day_of_week.inspect}, quarter_name_prefix:"\
+      " #{@quarter_name_prefix.inspect}, year_name_prefix: #{@year_name_prefix.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end