ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/create_tag_request.rb

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

data/lib/thought_spot_public_rest_api/models/create_user_group_request.rb

@@ -0,0 +1,179 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # CreateUserGroupRequest Model.
+  class CreateUserGroupRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the group. The group name must be unique.
+    # @return [String]
+    attr_accessor :name
+
+    # Display name for the group.
+    # @return [String]
+    attr_accessor :display_name
+
+    # GUID of the Liveboards to assign as default Liveboards to the users in the
+    # group.
+    # @return [Array[String]]
+    attr_accessor :default_liveboard_identifiers
+
+    # Description of the group
+    # @return [String]
+    attr_accessor :description
+
+    # Privileges to assign to the group
+    # @return [Array[Privilege1]]
+    attr_accessor :privileges
+
+    # GUID or name of the sub groups. A subgroup is a group assigned to a parent
+    # group.
+    # @return [Array[String]]
+    attr_accessor :sub_group_identifiers
+
+    # Group type.
+    # @return [Type29]
+    attr_accessor :type
+
+    # GUID or name of the users to assign to the group.
+    # @return [Array[String]]
+    attr_accessor :user_identifiers
+
+    # Visibility of the group. To make a group visible to other users and
+    # groups,
+    # set the visibility to SHAREABLE.
+    # @return [Visibility5]
+    attr_accessor :visibility
+
+    # Role identifiers of the roles that should be assigned to the group.
+    # @return [Array[String]]
+    attr_accessor :role_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['display_name'] = 'display_name'
+      @_hash['default_liveboard_identifiers'] =
+        'default_liveboard_identifiers'
+      @_hash['description'] = 'description'
+      @_hash['privileges'] = 'privileges'
+      @_hash['sub_group_identifiers'] = 'sub_group_identifiers'
+      @_hash['type'] = 'type'
+      @_hash['user_identifiers'] = 'user_identifiers'
+      @_hash['visibility'] = 'visibility'
+      @_hash['role_identifiers'] = 'role_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        default_liveboard_identifiers
+        description
+        privileges
+        sub_group_identifiers
+        type
+        user_identifiers
+        visibility
+        role_identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, display_name:, default_liveboard_identifiers: SKIP,
+                   description: SKIP, privileges: SKIP,
+                   sub_group_identifiers: SKIP, type: Type29::LOCAL_GROUP,
+                   user_identifiers: SKIP, visibility: Visibility5::SHARABLE,
+                   role_identifiers: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @display_name = display_name
+      unless default_liveboard_identifiers == SKIP
+        @default_liveboard_identifiers =
+          default_liveboard_identifiers
+      end
+      @description = description unless description == SKIP
+      @privileges = privileges unless privileges == SKIP
+      @sub_group_identifiers = sub_group_identifiers unless sub_group_identifiers == SKIP
+      @type = type unless type == SKIP
+      @user_identifiers = user_identifiers unless user_identifiers == SKIP
+      @visibility = visibility unless visibility == SKIP
+      @role_identifiers = role_identifiers unless role_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.
+      name = hash.key?('name') ? hash['name'] : nil
+      display_name = hash.key?('display_name') ? hash['display_name'] : nil
+      default_liveboard_identifiers =
+        hash.key?('default_liveboard_identifiers') ? hash['default_liveboard_identifiers'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      privileges = hash.key?('privileges') ? hash['privileges'] : SKIP
+      sub_group_identifiers =
+        hash.key?('sub_group_identifiers') ? hash['sub_group_identifiers'] : SKIP
+      type = hash['type'] ||= Type29::LOCAL_GROUP
+      user_identifiers =
+        hash.key?('user_identifiers') ? hash['user_identifiers'] : SKIP
+      visibility = hash['visibility'] ||= Visibility5::SHARABLE
+      role_identifiers =
+        hash.key?('role_identifiers') ? hash['role_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.
+      CreateUserGroupRequest.new(name: name,
+                                 display_name: display_name,
+                                 default_liveboard_identifiers: default_liveboard_identifiers,
+                                 description: description,
+                                 privileges: privileges,
+                                 sub_group_identifiers: sub_group_identifiers,
+                                 type: type,
+                                 user_identifiers: user_identifiers,
+                                 visibility: visibility,
+                                 role_identifiers: role_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} name: #{@name}, display_name: #{@display_name},"\
+      " default_liveboard_identifiers: #{@default_liveboard_identifiers}, description:"\
+      " #{@description}, privileges: #{@privileges}, sub_group_identifiers:"\
+      " #{@sub_group_identifiers}, type: #{@type}, user_identifiers: #{@user_identifiers},"\
+      " visibility: #{@visibility}, role_identifiers: #{@role_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} name: #{@name.inspect}, display_name: #{@display_name.inspect},"\
+      " default_liveboard_identifiers: #{@default_liveboard_identifiers.inspect}, description:"\
+      " #{@description.inspect}, privileges: #{@privileges.inspect}, sub_group_identifiers:"\
+      " #{@sub_group_identifiers.inspect}, type: #{@type.inspect}, user_identifiers:"\
+      " #{@user_identifiers.inspect}, visibility: #{@visibility.inspect}, role_identifiers:"\
+      " #{@role_identifiers.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/create_user_request.rb

@@ -0,0 +1,330 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # CreateUserRequest Model.
+  class CreateUserRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the user. The username string must be unique.
+    # @return [String]
+    attr_accessor :name
+
+    # A unique display name string for the user account, usually their first and
+    # last name
+    # @return [String]
+    attr_accessor :display_name
+
+    # Password for the user account. For IAMv2 users, you must set this password
+    # if you do not want to trigger an activation email.
+    # @return [String]
+    attr_accessor :password
+
+    # Email of the user account
+    # @return [String]
+    attr_accessor :email
+
+    # Type of the account.
+    # @return [AccountType2]
+    attr_accessor :account_type
+
+    # Current status of the user account. The `SUSPENDED` user state indicates a
+    # transitional state applicable to IAMv2 users only.
+    # @return [AccountStatus2]
+    attr_accessor :account_status
+
+    # List of Org IDs to which the user belongs.
+    # @return [Array[String]]
+    attr_accessor :org_identifiers
+
+    # GUIDs or names of the groups to which the newly created user belongs.
+    # @return [Array[String]]
+    attr_accessor :group_identifiers
+
+    # Visibility of the users. When set to SHARABLE, the user is visible to
+    # other users and groups when they try to share an object.
+    # @return [Visibility9]
+    attr_accessor :visibility
+
+    # User preference for receiving email notifications when another ThoughtSpot
+    # user shares a metadata object such as Answer, Liveboard, or Worksheet.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :notify_on_share
+
+    # The user preference for revisiting the onboarding experience.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_onboarding_experience
+
+    # flag to get the on-boarding experience is completed or not.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :onboarding_experience_completed
+
+    # GUID of the Liveboard to set a default Liveboard for the user.
+    # ThoughtSpot displays this Liveboard on the Home page when the user logs
+    # in.
+    # @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 [PreferredLocale1]
+    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
+
+    # Properties for the user
+    # @return [Object]
+    attr_accessor :extended_properties
+
+    # Preferences for the user
+    # @return [Object]
+    attr_accessor :extended_preferences
+
+    # Flag to indicate whether welcome email should be sent to user. This
+    # parameter is applied only on clusters on which IAM is disabled.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :trigger_welcome_email
+
+    # Flag to indicate whether activation email should be sent to the user.
+    # Default value for IAMv2 users is set to true. Users must either set this
+    # to false, or enter a valid 
+    # password if they do not want to trigger an activation email.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :trigger_activation_email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['display_name'] = 'display_name'
+      @_hash['password'] = 'password'
+      @_hash['email'] = 'email'
+      @_hash['account_type'] = 'account_type'
+      @_hash['account_status'] = 'account_status'
+      @_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['extended_properties'] = 'extended_properties'
+      @_hash['extended_preferences'] = 'extended_preferences'
+      @_hash['trigger_welcome_email'] = 'trigger_welcome_email'
+      @_hash['trigger_activation_email'] = 'trigger_activation_email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        password
+        account_type
+        account_status
+        org_identifiers
+        group_identifiers
+        visibility
+        notify_on_share
+        show_onboarding_experience
+        onboarding_experience_completed
+        home_liveboard_identifier
+        favorite_metadata
+        preferred_locale
+        use_browser_language
+        extended_properties
+        extended_preferences
+        trigger_welcome_email
+        trigger_activation_email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        notify_on_share
+        show_onboarding_experience
+        onboarding_experience_completed
+        use_browser_language
+        trigger_welcome_email
+        trigger_activation_email
+      ]
+    end
+
+    def initialize(name:, display_name:, email:, password: SKIP,
+                   account_type: AccountType2::LOCAL_USER,
+                   account_status: AccountStatus2::ACTIVE,
+                   org_identifiers: SKIP, group_identifiers: SKIP,
+                   visibility: Visibility9::SHARABLE, notify_on_share: true,
+                   show_onboarding_experience: true,
+                   onboarding_experience_completed: false,
+                   home_liveboard_identifier: SKIP, favorite_metadata: SKIP,
+                   preferred_locale: SKIP, use_browser_language: SKIP,
+                   extended_properties: SKIP, extended_preferences: SKIP,
+                   trigger_welcome_email: SKIP, trigger_activation_email: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @display_name = display_name
+      @password = password unless password == SKIP
+      @email = email
+      @account_type = account_type unless account_type == SKIP
+      @account_status = account_status unless account_status == 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
+      @extended_properties = extended_properties unless extended_properties == SKIP
+      @extended_preferences = extended_preferences unless extended_preferences == SKIP
+      @trigger_welcome_email = trigger_welcome_email unless trigger_welcome_email == SKIP
+      @trigger_activation_email = trigger_activation_email unless trigger_activation_email == 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'] : nil
+      display_name = hash.key?('display_name') ? hash['display_name'] : nil
+      email = hash.key?('email') ? hash['email'] : nil
+      password = hash.key?('password') ? hash['password'] : SKIP
+      account_type = hash['account_type'] ||= AccountType2::LOCAL_USER
+      account_status = hash['account_status'] ||= AccountStatus2::ACTIVE
+      org_identifiers =
+        hash.key?('org_identifiers') ? hash['org_identifiers'] : SKIP
+      group_identifiers =
+        hash.key?('group_identifiers') ? hash['group_identifiers'] : SKIP
+      visibility = hash['visibility'] ||= Visibility9::SHARABLE
+      notify_on_share = hash['notify_on_share'] ||= true
+      show_onboarding_experience = hash['show_onboarding_experience'] ||= true
+      onboarding_experience_completed =
+        hash['onboarding_experience_completed'] ||= false
+      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
+      extended_properties =
+        hash.key?('extended_properties') ? hash['extended_properties'] : SKIP
+      extended_preferences =
+        hash.key?('extended_preferences') ? hash['extended_preferences'] : SKIP
+      trigger_welcome_email =
+        hash.key?('trigger_welcome_email') ? hash['trigger_welcome_email'] : SKIP
+      trigger_activation_email =
+        hash.key?('trigger_activation_email') ? hash['trigger_activation_email'] : 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.
+      CreateUserRequest.new(name: name,
+                            display_name: display_name,
+                            email: email,
+                            password: password,
+                            account_type: account_type,
+                            account_status: account_status,
+                            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,
+                            extended_properties: extended_properties,
+                            extended_preferences: extended_preferences,
+                            trigger_welcome_email: trigger_welcome_email,
+                            trigger_activation_email: trigger_activation_email,
+                            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}, display_name: #{@display_name}, password: #{@password},"\
+      " email: #{@email}, account_type: #{@account_type}, account_status: #{@account_status},"\
+      " 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}, extended_properties: #{@extended_properties},"\
+      " extended_preferences: #{@extended_preferences}, trigger_welcome_email:"\
+      " #{@trigger_welcome_email}, trigger_activation_email: #{@trigger_activation_email},"\
+      " 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}, display_name: #{@display_name.inspect}, password:"\
+      " #{@password.inspect}, email: #{@email.inspect}, account_type: #{@account_type.inspect},"\
+      " account_status: #{@account_status.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}, extended_properties: #{@extended_properties.inspect},"\
+      " extended_preferences: #{@extended_preferences.inspect}, trigger_welcome_email:"\
+      " #{@trigger_welcome_email.inspect}, trigger_activation_email:"\
+      " #{@trigger_activation_email.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end