ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/update_calendar_request.rb

@@ -0,0 +1,173 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UpdateCalendarRequest Model.
+  class UpdateCalendarRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of update operation.
+    # @return [UpdateMethod]
+    attr_accessor :update_method
+
+    # Table reference containing connection identifier and table details in this
+    # format: `{"connection_identifier":"conn1", "database_name":"db1",
+    # "schema_name":"sc1", "table_name":"tb1"}`.
+    # @return [ExternalTableInput]
+    attr_accessor :table_reference
+
+    # Start date for the calendar in `MM/dd/yyyy` format. This parameter is
+    # mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.
+    # @return [String]
+    attr_accessor :start_date
+
+    # End date for the calendar in `MM/dd/yyyy` format. This parameter is
+    # mandatory if `update_method` is set as `FROM_INPUT_PARAMS`.
+    # @return [String]
+    attr_accessor :end_date
+
+    # Type of the calendar.
+    # @return [CalendarType]
+    attr_accessor :calendar_type
+
+    # Specify the month in which the fiscal or custom calendar year should
+    # start. For example, if you set `month_offset` to "April", the custom
+    # calendar will treat "April" as the first month of the year, and the
+    # related attributes such as quarters and start date will be based on this
+    # offset. The default value is `January`, which represents the standard
+    # calendar year (January to December).
+    # @return [MonthOffset]
+    attr_accessor :month_offset
+
+    # Specify the starting day of the week
+    # @return [StartDayOfWeek2]
+    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['update_method'] = 'update_method'
+      @_hash['table_reference'] = 'table_reference'
+      @_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[
+        update_method
+        start_date
+        end_date
+        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(table_reference:,
+                   update_method: UpdateMethod::FROM_INPUT_PARAMS,
+                   start_date: SKIP, end_date: SKIP,
+                   calendar_type: CalendarType::MONTH_OFFSET,
+                   month_offset: MonthOffset::JANUARY,
+                   start_day_of_week: StartDayOfWeek2::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?
+
+      @update_method = update_method unless update_method == SKIP
+      @table_reference = table_reference
+      @start_date = start_date unless start_date == SKIP
+      @end_date = end_date unless end_date == SKIP
+      @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.
+      table_reference = ExternalTableInput.from_hash(hash['table_reference']) if
+        hash['table_reference']
+      update_method = hash['update_method'] ||= UpdateMethod::FROM_INPUT_PARAMS
+      start_date = hash.key?('start_date') ? hash['start_date'] : SKIP
+      end_date = hash.key?('end_date') ? hash['end_date'] : SKIP
+      calendar_type = hash['calendar_type'] ||= CalendarType::MONTH_OFFSET
+      month_offset = hash['month_offset'] ||= MonthOffset::JANUARY
+      start_day_of_week = hash['start_day_of_week'] ||= StartDayOfWeek2::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.
+      UpdateCalendarRequest.new(table_reference: table_reference,
+                                update_method: update_method,
+                                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} update_method: #{@update_method}, table_reference: #{@table_reference},"\
+      " 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} update_method: #{@update_method.inspect}, table_reference:"\
+      " #{@table_reference.inspect}, 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

data/lib/thought_spot_public_rest_api/models/update_collection_request.rb

@@ -0,0 +1,114 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UpdateCollectionRequest Model.
+  class UpdateCollectionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the collection.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the collection.
+    # @return [String]
+    attr_accessor :description
+
+    # Metadata objects to add, remove, or replace in the collection.
+    # @return [Array[CollectionMetadataInput]]
+    attr_accessor :metadata
+
+    # Type of update operation. Default operation type is REPLACE.
+    # @return [Operation3]
+    attr_accessor :operation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['metadata'] = 'metadata'
+      @_hash['operation'] = 'operation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        description
+        metadata
+        operation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, description: SKIP, metadata: SKIP,
+                   operation: Operation3::REPLACE, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @description = description unless description == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @operation = operation unless operation == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (CollectionMetadataInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = SKIP unless hash.key?('metadata')
+      operation = hash['operation'] ||= Operation3::REPLACE
+
+      # 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.
+      UpdateCollectionRequest.new(name: name,
+                                  description: description,
+                                  metadata: metadata,
+                                  operation: operation,
+                                  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} name: #{@name}, description: #{@description}, metadata: #{@metadata},"\
+      " operation: #{@operation}, 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} name: #{@name.inspect}, description: #{@description.inspect}, metadata:"\
+      " #{@metadata.inspect}, operation: #{@operation.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/update_column_security_rules_request.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
+  # UpdateColumnSecurityRulesRequest Model.
+  class UpdateColumnSecurityRulesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID or name of the table for which we want to create column security
+    # rules
+    # @return [String]
+    attr_accessor :identifier
+
+    # The object ID of the table
+    # @return [String]
+    attr_accessor :obj_identifier
+
+    # If true, then all the secured columns will be marked as unprotected, and
+    # all the group associations will be removed
+    # @return [TrueClass | FalseClass]
+    attr_accessor :clear_csr
+
+    # Array where each object defines the security rule for a specific column
+    # @return [Array[ColumnSecurityRuleUpdate]]
+    attr_accessor :column_security_rules
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['identifier'] = 'identifier'
+      @_hash['obj_identifier'] = 'obj_identifier'
+      @_hash['clear_csr'] = 'clear_csr'
+      @_hash['column_security_rules'] = 'column_security_rules'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        identifier
+        obj_identifier
+        clear_csr
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        clear_csr
+      ]
+    end
+
+    def initialize(column_security_rules:, identifier: SKIP,
+                   obj_identifier: SKIP, clear_csr: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @identifier = identifier unless identifier == SKIP
+      @obj_identifier = obj_identifier unless obj_identifier == SKIP
+      @clear_csr = clear_csr unless clear_csr == SKIP
+      @column_security_rules = column_security_rules
+      @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.
+      # Parameter is an array, so we need to iterate through it
+      column_security_rules = nil
+      unless hash['column_security_rules'].nil?
+        column_security_rules = []
+        hash['column_security_rules'].each do |structure|
+          column_security_rules << (ColumnSecurityRuleUpdate.from_hash(structure) if structure)
+        end
+      end
+
+      column_security_rules = nil unless hash.key?('column_security_rules')
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      obj_identifier =
+        hash.key?('obj_identifier') ? hash['obj_identifier'] : SKIP
+      clear_csr = hash.key?('clear_csr') ? hash['clear_csr'] : 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.
+      UpdateColumnSecurityRulesRequest.new(column_security_rules: column_security_rules,
+                                           identifier: identifier,
+                                           obj_identifier: obj_identifier,
+                                           clear_csr: clear_csr,
+                                           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} identifier: #{@identifier}, obj_identifier: #{@obj_identifier}, clear_csr:"\
+      " #{@clear_csr}, column_security_rules: #{@column_security_rules}, 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} identifier: #{@identifier.inspect}, obj_identifier:"\
+      " #{@obj_identifier.inspect}, clear_csr: #{@clear_csr.inspect}, column_security_rules:"\
+      " #{@column_security_rules.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/update_config_request.rb

@@ -0,0 +1,161 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UpdateConfigRequest Model.
+  class UpdateConfigRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Username to authenticate connection to version control system
+    # @return [String]
+    attr_accessor :username
+
+    # Access token corresponding to the user to authenticate connection to
+    # version control system
+    # @return [String]
+    attr_accessor :access_token
+
+    # Applicable when Orgs is enabled in the cluster
+    #    
+    # List of Org ids or name. Provide value -1 for cluster level. Example :
+    # ["OrgID1-or-Name1", "OrgID2-or-Name2"] 
+    #    
+    # Note: If no value is specified, then the configurations will be returned
+    # for all orgs the user has access to  <br/>  <span
+    # class="since-beta-tag">Version: 9.5.0.cl or later</span>
+    # @return [String]
+    attr_accessor :org_identifier
+
+    # List the remote branches to configure. Example:[development, production]
+    # @return [Array[String]]
+    attr_accessor :branch_names
+
+    # Name of the remote branch where objects from this Thoughtspot instance
+    # will be versioned. <br/>  <span class="since-beta-tag">Version: 9.7.0.cl
+    # or later</span>
+    # @return [String]
+    attr_accessor :commit_branch_name
+
+    # Maintain mapping of guid for the deployment to an instance <br/>  <span
+    # class="since-beta-tag">Version: 9.4.0.cl or later</span>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :enable_guid_mapping
+
+    # Name of the branch where the configuration files related to operations
+    # between Thoughtspot and version control repo should be maintained. <br/>
+    # <span class="since-beta-tag">Version: 9.7.0.cl or later</span>
+    # @return [String]
+    attr_accessor :configuration_branch_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['username'] = 'username'
+      @_hash['access_token'] = 'access_token'
+      @_hash['org_identifier'] = 'org_identifier'
+      @_hash['branch_names'] = 'branch_names'
+      @_hash['commit_branch_name'] = 'commit_branch_name'
+      @_hash['enable_guid_mapping'] = 'enable_guid_mapping'
+      @_hash['configuration_branch_name'] = 'configuration_branch_name'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        username
+        access_token
+        org_identifier
+        branch_names
+        commit_branch_name
+        enable_guid_mapping
+        configuration_branch_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        enable_guid_mapping
+      ]
+    end
+
+    def initialize(username: SKIP, access_token: SKIP, org_identifier: SKIP,
+                   branch_names: SKIP, commit_branch_name: SKIP,
+                   enable_guid_mapping: SKIP, configuration_branch_name: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @username = username unless username == SKIP
+      @access_token = access_token unless access_token == SKIP
+      @org_identifier = org_identifier unless org_identifier == SKIP
+      @branch_names = branch_names unless branch_names == SKIP
+      @commit_branch_name = commit_branch_name unless commit_branch_name == SKIP
+      @enable_guid_mapping = enable_guid_mapping unless enable_guid_mapping == SKIP
+      unless configuration_branch_name == SKIP
+        @configuration_branch_name =
+          configuration_branch_name
+      end
+      @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.
+      username = hash.key?('username') ? hash['username'] : SKIP
+      access_token = hash.key?('access_token') ? hash['access_token'] : SKIP
+      org_identifier =
+        hash.key?('org_identifier') ? hash['org_identifier'] : SKIP
+      branch_names = hash.key?('branch_names') ? hash['branch_names'] : SKIP
+      commit_branch_name =
+        hash.key?('commit_branch_name') ? hash['commit_branch_name'] : SKIP
+      enable_guid_mapping =
+        hash.key?('enable_guid_mapping') ? hash['enable_guid_mapping'] : SKIP
+      configuration_branch_name =
+        hash.key?('configuration_branch_name') ? hash['configuration_branch_name'] : 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.
+      UpdateConfigRequest.new(username: username,
+                              access_token: access_token,
+                              org_identifier: org_identifier,
+                              branch_names: branch_names,
+                              commit_branch_name: commit_branch_name,
+                              enable_guid_mapping: enable_guid_mapping,
+                              configuration_branch_name: configuration_branch_name,
+                              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} username: #{@username}, access_token: #{@access_token}, org_identifier:"\
+      " #{@org_identifier}, branch_names: #{@branch_names}, commit_branch_name:"\
+      " #{@commit_branch_name}, enable_guid_mapping: #{@enable_guid_mapping},"\
+      " configuration_branch_name: #{@configuration_branch_name}, 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} username: #{@username.inspect}, access_token: #{@access_token.inspect},"\
+      " org_identifier: #{@org_identifier.inspect}, branch_names: #{@branch_names.inspect},"\
+      " commit_branch_name: #{@commit_branch_name.inspect}, enable_guid_mapping:"\
+      " #{@enable_guid_mapping.inspect}, configuration_branch_name:"\
+      " #{@configuration_branch_name.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end