ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/storage_destination.rb

@@ -0,0 +1,80 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Storage destination configuration for webhook payload delivery.
+  class StorageDestination < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of storage destination (e.g., AWS_S3).
+    # @return [String]
+    attr_reader :storage_type
+
+    # Storage configuration containing provider-specific settings.
+    # @return [StorageConfig]
+    attr_accessor :storage_config
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['storage_type'] = 'storage_type'
+      @_hash['storage_config'] = 'storage_config'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(storage_config:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @storage_type = 'AWS_S3'
+      @storage_config = storage_config
+      @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.
+      storage_config = StorageConfig.from_hash(hash['storage_config']) if hash['storage_config']
+
+      # 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.
+      StorageDestination.new(storage_config: storage_config,
+                             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} storage_type: #{@storage_type}, storage_config: #{@storage_config},"\
+      " 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} storage_type: #{@storage_type.inspect}, storage_config:"\
+      " #{@storage_config.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/storage_destination_input.rb

@@ -0,0 +1,82 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Input type for storage destination configuration.
+  class StorageDestinationInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of storage destination.
+    # Example: "AWS_S3"
+    # @return [String]
+    attr_reader :storage_type
+
+    # Input type for storage configuration.
+    # @return [StorageConfigInput]
+    attr_accessor :storage_config
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['storage_type'] = 'storage_type'
+      @_hash['storage_config'] = 'storage_config'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(storage_config:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @storage_type = 'AWS_S3'
+      @storage_config = storage_config
+      @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.
+      storage_config = StorageConfigInput.from_hash(hash['storage_config']) if
+        hash['storage_config']
+
+      # 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.
+      StorageDestinationInput.new(storage_config: storage_config,
+                                  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} storage_type: #{@storage_type}, storage_config: #{@storage_config},"\
+      " 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} storage_type: #{@storage_type.inspect}, storage_config:"\
+      " #{@storage_config.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/storage_setup_info.rb

@@ -0,0 +1,175 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Setup information for customer-managed storage configuration. Provides
+  # ThoughtSpot's identity information and IAM policy configuration required for
+  # customers to set up cross-account access to their S3 buckets. The response
+  # contains cluster-specific configuration based on the cluster_type: - For AWS
+  # clusters: aws_config will be populated - For GCP clusters: gcp_config will
+  # be populated Example query: ```graphql query {
+  # getWebhookStorageConfig(webhook_identifier: "my-webhook") {     cluster_type
+  #     storage_type     aws_config {       thoughtspot_aws_account_id
+  # trust_policy_template       setup_instructions     }     gcp_config {
+  # thoughtspot_gcp_service_account_id       oidc_provider
+  # trust_policy_template       setup_instructions     }   } } ``` Example AWS
+  # response: {   "cluster_type": "AWS",   "storage_type": "AWS_S3",
+  # "aws_config": {     "thoughtspot_aws_account_id": "123456789012",
+  # "trust_policy_template": { "Version": "2012-10-17", "Statement": [...] },
+  #  "setup_instructions": ["1. Create an IAM role...", "2. Add trust
+  # policy..."]   },   "gcp_config": null } Example GCP response: {
+  # "cluster_type": "GCP",   "storage_type": "AWS_S3",   "aws_config": null,
+  # "gcp_config": {     "thoughtspot_gcp_service_account_id":
+  # "115663769112811637952",     "oidc_provider": "accounts.google.com",
+  # "trust_policy_template": { "Version": "2012-10-17", "Statement": [...] },
+  #  "setup_instructions": ["1. Add accounts.google.com as Identity
+  # Provider..."]   } }
+  class StorageSetupInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of ThoughtSpot cluster deployment.
+    # Determines which authentication method is used for S3 access.
+    # Example: "AWS" or "GCP"
+    # @return [ClusterType]
+    attr_accessor :cluster_type
+
+    # Type of storage destination (e.g., AWS_S3).
+    # @return [String]
+    attr_reader :storage_type
+
+    # Setup information for AWS clusters using STS AssumeRole.
+    # ThoughtSpot will use its AWS IAM role to assume your role in your AWS
+    # account.
+    # Example:
+    # {
+    #   "thoughtspot_aws_account_id": "123456789012",
+    #   "trust_policy_template": {
+    #     "Version": "2012-10-17",
+    #     "Statement": [{
+    #       "Effect": "Allow",
+    #       "Principal": { "AWS": "arn:aws:iam::123456789012:root" },
+    #       "Action": "sts:AssumeRole",
+    #       "Condition": { "StringEquals": { "sts:ExternalId":
+    # "your-external-id" } }
+    #     }]
+    #   },
+    #   "setup_instructions": [
+    #     "1. Create an IAM role in your AWS account",
+    #     "2. Copy the trust policy template and attach it to your role",
+    #     "3. Attach S3 permissions (s3:PutObject, s3:PutObjectAcl) to the
+    # role",
+    #     "4. Use the role ARN in your webhook storage configuration"
+    #   ]
+    # }
+    # @return [AwsAssumeRoleSetup]
+    attr_accessor :aws_config
+
+    # 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"
+    #   ]
+    # }
+    # @return [GcpWebIdentitySetup]
+    attr_accessor :gcp_config
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cluster_type'] = 'cluster_type'
+      @_hash['storage_type'] = 'storage_type'
+      @_hash['aws_config'] = 'aws_config'
+      @_hash['gcp_config'] = 'gcp_config'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        aws_config
+        gcp_config
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cluster_type:, aws_config: SKIP, gcp_config: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @cluster_type = cluster_type
+      @storage_type = 'AWS_S3'
+      @aws_config = aws_config unless aws_config == SKIP
+      @gcp_config = gcp_config unless gcp_config == 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.
+      cluster_type = hash.key?('cluster_type') ? hash['cluster_type'] : nil
+      aws_config = AwsAssumeRoleSetup.from_hash(hash['aws_config']) if hash['aws_config']
+      gcp_config = GcpWebIdentitySetup.from_hash(hash['gcp_config']) if hash['gcp_config']
+
+      # 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.
+      StorageSetupInfo.new(cluster_type: cluster_type,
+                           aws_config: aws_config,
+                           gcp_config: gcp_config,
+                           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} cluster_type: #{@cluster_type}, storage_type: #{@storage_type}, aws_config:"\
+      " #{@aws_config}, gcp_config: #{@gcp_config}, 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} cluster_type: #{@cluster_type.inspect}, storage_type:"\
+      " #{@storage_type.inspect}, aws_config: #{@aws_config.inspect}, gcp_config:"\
+      " #{@gcp_config.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/subtype.rb

@@ -0,0 +1,52 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Subtype.
+  class Subtype
+    SUBTYPE = [
+      # TODO: Write general description for ONE_TO_ONE_LOGICAL
+      ONE_TO_ONE_LOGICAL = 'ONE_TO_ONE_LOGICAL'.freeze,
+
+      # TODO: Write general description for WORKSHEET
+      WORKSHEET = 'WORKSHEET'.freeze,
+
+      # TODO: Write general description for PRIVATE_WORKSHEET
+      PRIVATE_WORKSHEET = 'PRIVATE_WORKSHEET'.freeze,
+
+      # TODO: Write general description for USER_DEFINED
+      USER_DEFINED = 'USER_DEFINED'.freeze,
+
+      # TODO: Write general description for AGGR_WORKSHEET
+      AGGR_WORKSHEET = 'AGGR_WORKSHEET'.freeze,
+
+      # TODO: Write general description for SQL_VIEW
+      SQL_VIEW = 'SQL_VIEW'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = ONE_TO_ONE_LOGICAL)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'one_to_one_logical' then ONE_TO_ONE_LOGICAL
+      when 'worksheet' then WORKSHEET
+      when 'private_worksheet' then PRIVATE_WORKSHEET
+      when 'user_defined' then USER_DEFINED
+      when 'aggr_worksheet' then AGGR_WORKSHEET
+      when 'sql_view' then SQL_VIEW
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/system_config.rb

@@ -0,0 +1,102 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SystemConfig Model.
+  class SystemConfig < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :onboarding_content_url
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :saml_enabled
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :okta_enabled
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['onboarding_content_url'] = 'onboarding_content_url'
+      @_hash['saml_enabled'] = 'saml_enabled'
+      @_hash['okta_enabled'] = 'okta_enabled'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        onboarding_content_url
+        saml_enabled
+        okta_enabled
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        onboarding_content_url
+        saml_enabled
+        okta_enabled
+      ]
+    end
+
+    def initialize(onboarding_content_url: SKIP, saml_enabled: SKIP,
+                   okta_enabled: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @onboarding_content_url = onboarding_content_url unless onboarding_content_url == SKIP
+      @saml_enabled = saml_enabled unless saml_enabled == SKIP
+      @okta_enabled = okta_enabled unless okta_enabled == 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.
+      onboarding_content_url =
+        hash.key?('onboarding_content_url') ? hash['onboarding_content_url'] : SKIP
+      saml_enabled = hash.key?('saml_enabled') ? hash['saml_enabled'] : SKIP
+      okta_enabled = hash.key?('okta_enabled') ? hash['okta_enabled'] : 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.
+      SystemConfig.new(onboarding_content_url: onboarding_content_url,
+                       saml_enabled: saml_enabled,
+                       okta_enabled: okta_enabled,
+                       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} onboarding_content_url: #{@onboarding_content_url}, saml_enabled:"\
+      " #{@saml_enabled}, okta_enabled: #{@okta_enabled}, 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} onboarding_content_url: #{@onboarding_content_url.inspect}, saml_enabled:"\
+      " #{@saml_enabled.inspect}, okta_enabled: #{@okta_enabled.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end