ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/import_type.rb

@@ -0,0 +1,36 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Mention type of Import
+  class ImportType
+    IMPORT_TYPE = [
+      # TODO: Write general description for DBT_CLOUD
+      DBT_CLOUD = 'DBT_CLOUD'.freeze,
+
+      # TODO: Write general description for ZIP_FILE
+      ZIP_FILE = 'ZIP_FILE'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = DBT_CLOUD)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'dbt_cloud' then DBT_CLOUD
+      when 'zip_file' then ZIP_FILE
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/import_user.rb

@@ -0,0 +1,282 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ImportUser Model.
+  class ImportUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of the user.
+    # @return [String]
+    attr_accessor :user_identifier
+
+    # Display name of the user.
+    # @return [String]
+    attr_accessor :display_name
+
+    # Password of the user.
+    # @return [String]
+    attr_accessor :password
+
+    # Type of the user account.
+    # @return [AccountType]
+    attr_accessor :account_type
+
+    # Status of the user account.
+    # @return [AccountStatus]
+    attr_accessor :account_status
+
+    # Email address of the user.
+    # @return [String]
+    attr_accessor :email
+
+    # ID or name of the Orgs to which the user belongs.
+    # @return [Array[String]]
+    attr_accessor :org_identifiers
+
+    # ID or name of the groups to which the user belongs.
+    # @return [Array[String]]
+    attr_accessor :group_identifiers
+
+    # Visibility of the users. The SHARABLE property makes a user visible to
+    # other users and group, who can share objects with the user.
+    # @return [Visibility3]
+    attr_accessor :visibility
+
+    # Notify user when other users or groups share metadata objects
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_on_share
+
+    # Show or hide the new user onboarding walkthroughs
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_onboarding_experience
+
+    # Revisit the new user onboarding walkthroughs
+    # @return [TrueClass | FalseClass]
+    attr_accessor :onboarding_experience_completed
+
+    # Unique ID or name of the default Liveboard assigned to the user.
+    # @return [String]
+    attr_accessor :home_liveboard_identifier
+
+    # Metadata objects to add to the user's favorites list.
+    # @return [Array[FavoriteMetadataInput]]
+    attr_accessor :favorite_metadata
+
+    # Locale for the user. When setting this value, do not set
+    # use_browser_language to true, otherwise the browser's language setting
+    # will take precedence and the preferred_locale value will be ignored.
+    # @return [PreferredLocale]
+    attr_accessor :preferred_locale
+
+    # Flag to indicate whether to use the browser locale for the user in the UI.
+    # When set to true, the preferred_locale value is unset and the browser's
+    # language setting takes precedence. <br/>  <span
+    # class="since-beta-tag">Version: 26.3.0.cl or later</span>
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_browser_language
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user_identifier'] = 'user_identifier'
+      @_hash['display_name'] = 'display_name'
+      @_hash['password'] = 'password'
+      @_hash['account_type'] = 'account_type'
+      @_hash['account_status'] = 'account_status'
+      @_hash['email'] = 'email'
+      @_hash['org_identifiers'] = 'org_identifiers'
+      @_hash['group_identifiers'] = 'group_identifiers'
+      @_hash['visibility'] = 'visibility'
+      @_hash['notify_on_share'] = 'notify_on_share'
+      @_hash['show_onboarding_experience'] = 'show_onboarding_experience'
+      @_hash['onboarding_experience_completed'] =
+        'onboarding_experience_completed'
+      @_hash['home_liveboard_identifier'] = 'home_liveboard_identifier'
+      @_hash['favorite_metadata'] = 'favorite_metadata'
+      @_hash['preferred_locale'] = 'preferred_locale'
+      @_hash['use_browser_language'] = 'use_browser_language'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        password
+        account_type
+        account_status
+        email
+        org_identifiers
+        group_identifiers
+        visibility
+        notify_on_share
+        show_onboarding_experience
+        onboarding_experience_completed
+        home_liveboard_identifier
+        favorite_metadata
+        preferred_locale
+        use_browser_language
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        password
+        account_type
+        account_status
+        email
+        org_identifiers
+        group_identifiers
+        visibility
+        notify_on_share
+        show_onboarding_experience
+        onboarding_experience_completed
+        home_liveboard_identifier
+        favorite_metadata
+        preferred_locale
+        use_browser_language
+      ]
+    end
+
+    def initialize(user_identifier:, display_name:, password: SKIP,
+                   account_type: AccountType::LOCAL_USER,
+                   account_status: AccountStatus::ACTIVE, email: SKIP,
+                   org_identifiers: SKIP, group_identifiers: SKIP,
+                   visibility: SKIP, notify_on_share: true,
+                   show_onboarding_experience: SKIP,
+                   onboarding_experience_completed: SKIP,
+                   home_liveboard_identifier: SKIP, favorite_metadata: SKIP,
+                   preferred_locale: SKIP, use_browser_language: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_identifier = user_identifier
+      @display_name = display_name
+      @password = password unless password == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @account_status = account_status unless account_status == SKIP
+      @email = email unless email == SKIP
+      @org_identifiers = org_identifiers unless org_identifiers == SKIP
+      @group_identifiers = group_identifiers unless group_identifiers == SKIP
+      @visibility = visibility unless visibility == SKIP
+      @notify_on_share = notify_on_share unless notify_on_share == SKIP
+      unless show_onboarding_experience == SKIP
+        @show_onboarding_experience =
+          show_onboarding_experience
+      end
+      unless onboarding_experience_completed == SKIP
+        @onboarding_experience_completed =
+          onboarding_experience_completed
+      end
+      unless home_liveboard_identifier == SKIP
+        @home_liveboard_identifier =
+          home_liveboard_identifier
+      end
+      @favorite_metadata = favorite_metadata unless favorite_metadata == SKIP
+      @preferred_locale = preferred_locale unless preferred_locale == SKIP
+      @use_browser_language = use_browser_language unless use_browser_language == 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_identifier =
+        hash.key?('user_identifier') ? hash['user_identifier'] : nil
+      display_name = hash.key?('display_name') ? hash['display_name'] : nil
+      password = hash.key?('password') ? hash['password'] : SKIP
+      account_type = hash['account_type'] ||= AccountType::LOCAL_USER
+      account_status = hash['account_status'] ||= AccountStatus::ACTIVE
+      email = hash.key?('email') ? hash['email'] : SKIP
+      org_identifiers =
+        hash.key?('org_identifiers') ? hash['org_identifiers'] : SKIP
+      group_identifiers =
+        hash.key?('group_identifiers') ? hash['group_identifiers'] : SKIP
+      visibility = hash.key?('visibility') ? hash['visibility'] : SKIP
+      notify_on_share = hash['notify_on_share'] ||= true
+      show_onboarding_experience =
+        hash.key?('show_onboarding_experience') ? hash['show_onboarding_experience'] : SKIP
+      onboarding_experience_completed =
+        hash.key?('onboarding_experience_completed') ? hash['onboarding_experience_completed'] : SKIP
+      home_liveboard_identifier =
+        hash.key?('home_liveboard_identifier') ? hash['home_liveboard_identifier'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      favorite_metadata = nil
+      unless hash['favorite_metadata'].nil?
+        favorite_metadata = []
+        hash['favorite_metadata'].each do |structure|
+          favorite_metadata << (FavoriteMetadataInput.from_hash(structure) if structure)
+        end
+      end
+
+      favorite_metadata = SKIP unless hash.key?('favorite_metadata')
+      preferred_locale =
+        hash.key?('preferred_locale') ? hash['preferred_locale'] : SKIP
+      use_browser_language =
+        hash.key?('use_browser_language') ? hash['use_browser_language'] : 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.
+      ImportUser.new(user_identifier: user_identifier,
+                     display_name: display_name,
+                     password: password,
+                     account_type: account_type,
+                     account_status: account_status,
+                     email: email,
+                     org_identifiers: org_identifiers,
+                     group_identifiers: group_identifiers,
+                     visibility: visibility,
+                     notify_on_share: notify_on_share,
+                     show_onboarding_experience: show_onboarding_experience,
+                     onboarding_experience_completed: onboarding_experience_completed,
+                     home_liveboard_identifier: home_liveboard_identifier,
+                     favorite_metadata: favorite_metadata,
+                     preferred_locale: preferred_locale,
+                     use_browser_language: use_browser_language,
+                     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_identifier: #{@user_identifier}, display_name: #{@display_name},"\
+      " password: #{@password}, account_type: #{@account_type}, account_status:"\
+      " #{@account_status}, email: #{@email}, org_identifiers: #{@org_identifiers},"\
+      " group_identifiers: #{@group_identifiers}, visibility: #{@visibility}, notify_on_share:"\
+      " #{@notify_on_share}, show_onboarding_experience: #{@show_onboarding_experience},"\
+      " onboarding_experience_completed: #{@onboarding_experience_completed},"\
+      " home_liveboard_identifier: #{@home_liveboard_identifier}, favorite_metadata:"\
+      " #{@favorite_metadata}, preferred_locale: #{@preferred_locale}, use_browser_language:"\
+      " #{@use_browser_language}, 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_identifier: #{@user_identifier.inspect}, display_name:"\
+      " #{@display_name.inspect}, password: #{@password.inspect}, account_type:"\
+      " #{@account_type.inspect}, account_status: #{@account_status.inspect}, email:"\
+      " #{@email.inspect}, org_identifiers: #{@org_identifiers.inspect}, group_identifiers:"\
+      " #{@group_identifiers.inspect}, visibility: #{@visibility.inspect}, notify_on_share:"\
+      " #{@notify_on_share.inspect}, show_onboarding_experience:"\
+      " #{@show_onboarding_experience.inspect}, onboarding_experience_completed:"\
+      " #{@onboarding_experience_completed.inspect}, home_liveboard_identifier:"\
+      " #{@home_liveboard_identifier.inspect}, favorite_metadata: #{@favorite_metadata.inspect},"\
+      " preferred_locale: #{@preferred_locale.inspect}, use_browser_language:"\
+      " #{@use_browser_language.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/import_user_groups_request.rb

@@ -0,0 +1,113 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ImportUserGroupsRequest Model.
+  class ImportUserGroupsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Details of groups which are to be imported
+    # @return [Array[GroupsImportListInput]]
+    attr_accessor :groups
+
+    # If set to true, removes groups that are not specified in the API request.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :delete_unspecified_groups
+
+    # If true, the API performs a test operation and returns user IDs whose
+    # data will be edited after the import.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :dry_run
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['groups'] = 'groups'
+      @_hash['delete_unspecified_groups'] = 'delete_unspecified_groups'
+      @_hash['dry_run'] = 'dry_run'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        groups
+        delete_unspecified_groups
+        dry_run
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        delete_unspecified_groups
+        dry_run
+      ]
+    end
+
+    def initialize(groups: SKIP, delete_unspecified_groups: false,
+                   dry_run: true, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @groups = groups unless groups == SKIP
+      unless delete_unspecified_groups == SKIP
+        @delete_unspecified_groups =
+          delete_unspecified_groups
+      end
+      @dry_run = dry_run unless dry_run == 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.
+      # Parameter is an array, so we need to iterate through it
+      groups = nil
+      unless hash['groups'].nil?
+        groups = []
+        hash['groups'].each do |structure|
+          groups << (GroupsImportListInput.from_hash(structure) if structure)
+        end
+      end
+
+      groups = SKIP unless hash.key?('groups')
+      delete_unspecified_groups = hash['delete_unspecified_groups'] ||= false
+      dry_run = hash['dry_run'] ||= true
+
+      # 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.
+      ImportUserGroupsRequest.new(groups: groups,
+                                  delete_unspecified_groups: delete_unspecified_groups,
+                                  dry_run: dry_run,
+                                  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} groups: #{@groups}, delete_unspecified_groups:"\
+      " #{@delete_unspecified_groups}, dry_run: #{@dry_run}, 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} groups: #{@groups.inspect}, delete_unspecified_groups:"\
+      " #{@delete_unspecified_groups.inspect}, dry_run: #{@dry_run.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/import_user_groups_response.rb

@@ -0,0 +1,119 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ImportUserGroupsResponse Model.
+  class ImportUserGroupsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The groups which are added into the system.
+    # @return [Array[UserGroup]]
+    attr_accessor :groups_added
+
+    # The groups which are deleted from the system.
+    # @return [Array[UserGroup]]
+    attr_accessor :groups_deleted
+
+    # The groups which are updated in the system.
+    # @return [Array[UserGroup]]
+    attr_accessor :groups_updated
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['groups_added'] = 'groups_added'
+      @_hash['groups_deleted'] = 'groups_deleted'
+      @_hash['groups_updated'] = 'groups_updated'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(groups_added:, groups_deleted:, groups_updated:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @groups_added = groups_added
+      @groups_deleted = groups_deleted
+      @groups_updated = groups_updated
+      @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
+      groups_added = nil
+      unless hash['groups_added'].nil?
+        groups_added = []
+        hash['groups_added'].each do |structure|
+          groups_added << (UserGroup.from_hash(structure) if structure)
+        end
+      end
+
+      groups_added = nil unless hash.key?('groups_added')
+      # Parameter is an array, so we need to iterate through it
+      groups_deleted = nil
+      unless hash['groups_deleted'].nil?
+        groups_deleted = []
+        hash['groups_deleted'].each do |structure|
+          groups_deleted << (UserGroup.from_hash(structure) if structure)
+        end
+      end
+
+      groups_deleted = nil unless hash.key?('groups_deleted')
+      # Parameter is an array, so we need to iterate through it
+      groups_updated = nil
+      unless hash['groups_updated'].nil?
+        groups_updated = []
+        hash['groups_updated'].each do |structure|
+          groups_updated << (UserGroup.from_hash(structure) if structure)
+        end
+      end
+
+      groups_updated = nil unless hash.key?('groups_updated')
+
+      # 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.
+      ImportUserGroupsResponse.new(groups_added: groups_added,
+                                   groups_deleted: groups_deleted,
+                                   groups_updated: groups_updated,
+                                   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} groups_added: #{@groups_added}, groups_deleted: #{@groups_deleted},"\
+      " groups_updated: #{@groups_updated}, 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} groups_added: #{@groups_added.inspect}, groups_deleted:"\
+      " #{@groups_deleted.inspect}, groups_updated: #{@groups_updated.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/import_user_type.rb

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