ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/search_users_request.rb

@@ -0,0 +1,327 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SearchUsersRequest Model.
+  class SearchUsersRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID / name of the user to search
+    # @return [String]
+    attr_accessor :user_identifier
+
+    # A unique display name string for the user account, usually their first and
+    # last name
+    # @return [String]
+    attr_accessor :display_name
+
+    # A pattern to match case-insensitive name of the User object.
+    # @return [String]
+    attr_accessor :name_pattern
+
+    # Visibility of the user
+    # @return [Visibility10]
+    attr_accessor :visibility
+
+    # Email of the user account
+    # @return [String]
+    attr_accessor :email
+
+    # GUID or name of the group to which the user belongs
+    # @return [Array[String]]
+    attr_accessor :group_identifiers
+
+    # Privileges assigned to the user
+    # @return [Array[Privilege4]]
+    attr_accessor :privileges
+
+    # Type of the account
+    # @return [AccountType3]
+    attr_accessor :account_type
+
+    # Current status of the user account.
+    # @return [AccountStatus3]
+    attr_accessor :account_status
+
+    # 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
+
+    # Indicates if the user has completed the onboarding walkthrough
+    # @return [TrueClass | FalseClass]
+    attr_accessor :onboarding_experience_completed
+
+    # IDs or names of the Orgs to which the user belongs
+    # @return [Array[String]]
+    attr_accessor :org_identifiers
+
+    # Unique ID or name of the user's home Liveboard.
+    # @return [String]
+    attr_accessor :home_liveboard_identifier
+
+    # Metadata objects which are assigned as favorites of the user.
+    # @return [Array[FavoriteMetadataInput]]
+    attr_accessor :favorite_metadata
+
+    # The starting record number from where the records should be included.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records that should be included.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # Sort options.
+    # @return [SortOptions]
+    attr_accessor :sort_options
+
+    # Filters by the role assigned to the user.
+    # @return [Array[String]]
+    attr_accessor :role_identifiers
+
+    # Indicates if the user's favorite objects should be displayed.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_favorite_metadata
+
+    # Indicates if the user's formula variable values should be included in the
+    # response.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_variable_values
+
+    # 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['name_pattern'] = 'name_pattern'
+      @_hash['visibility'] = 'visibility'
+      @_hash['email'] = 'email'
+      @_hash['group_identifiers'] = 'group_identifiers'
+      @_hash['privileges'] = 'privileges'
+      @_hash['account_type'] = 'account_type'
+      @_hash['account_status'] = 'account_status'
+      @_hash['notify_on_share'] = 'notify_on_share'
+      @_hash['show_onboarding_experience'] = 'show_onboarding_experience'
+      @_hash['onboarding_experience_completed'] =
+        'onboarding_experience_completed'
+      @_hash['org_identifiers'] = 'org_identifiers'
+      @_hash['home_liveboard_identifier'] = 'home_liveboard_identifier'
+      @_hash['favorite_metadata'] = 'favorite_metadata'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['sort_options'] = 'sort_options'
+      @_hash['role_identifiers'] = 'role_identifiers'
+      @_hash['include_favorite_metadata'] = 'include_favorite_metadata'
+      @_hash['include_variable_values'] = 'include_variable_values'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        user_identifier
+        display_name
+        name_pattern
+        visibility
+        email
+        group_identifiers
+        privileges
+        account_type
+        account_status
+        notify_on_share
+        show_onboarding_experience
+        onboarding_experience_completed
+        org_identifiers
+        home_liveboard_identifier
+        favorite_metadata
+        record_offset
+        record_size
+        sort_options
+        role_identifiers
+        include_favorite_metadata
+        include_variable_values
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        notify_on_share
+        show_onboarding_experience
+        onboarding_experience_completed
+        include_favorite_metadata
+        include_variable_values
+      ]
+    end
+
+    def initialize(user_identifier: SKIP, display_name: SKIP,
+                   name_pattern: SKIP, visibility: SKIP, email: SKIP,
+                   group_identifiers: SKIP, privileges: SKIP,
+                   account_type: SKIP, account_status: SKIP,
+                   notify_on_share: SKIP, show_onboarding_experience: SKIP,
+                   onboarding_experience_completed: SKIP, org_identifiers: SKIP,
+                   home_liveboard_identifier: SKIP, favorite_metadata: SKIP,
+                   record_offset: 0, record_size: 10, sort_options: SKIP,
+                   role_identifiers: SKIP, include_favorite_metadata: false,
+                   include_variable_values: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @user_identifier = user_identifier unless user_identifier == SKIP
+      @display_name = display_name unless display_name == SKIP
+      @name_pattern = name_pattern unless name_pattern == SKIP
+      @visibility = visibility unless visibility == SKIP
+      @email = email unless email == SKIP
+      @group_identifiers = group_identifiers unless group_identifiers == SKIP
+      @privileges = privileges unless privileges == SKIP
+      @account_type = account_type unless account_type == SKIP
+      @account_status = account_status unless account_status == 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
+      @org_identifiers = org_identifiers unless org_identifiers == SKIP
+      unless home_liveboard_identifier == SKIP
+        @home_liveboard_identifier =
+          home_liveboard_identifier
+      end
+      @favorite_metadata = favorite_metadata unless favorite_metadata == SKIP
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @sort_options = sort_options unless sort_options == SKIP
+      @role_identifiers = role_identifiers unless role_identifiers == SKIP
+      unless include_favorite_metadata == SKIP
+        @include_favorite_metadata =
+          include_favorite_metadata
+      end
+      @include_variable_values = include_variable_values unless include_variable_values == 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'] : SKIP
+      display_name = hash.key?('display_name') ? hash['display_name'] : SKIP
+      name_pattern = hash.key?('name_pattern') ? hash['name_pattern'] : SKIP
+      visibility = hash.key?('visibility') ? hash['visibility'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      group_identifiers =
+        hash.key?('group_identifiers') ? hash['group_identifiers'] : SKIP
+      privileges = hash.key?('privileges') ? hash['privileges'] : SKIP
+      account_type = hash.key?('account_type') ? hash['account_type'] : SKIP
+      account_status =
+        hash.key?('account_status') ? hash['account_status'] : SKIP
+      notify_on_share =
+        hash.key?('notify_on_share') ? hash['notify_on_share'] : SKIP
+      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
+      org_identifiers =
+        hash.key?('org_identifiers') ? hash['org_identifiers'] : 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')
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= 10
+      sort_options = SortOptions.from_hash(hash['sort_options']) if hash['sort_options']
+      role_identifiers =
+        hash.key?('role_identifiers') ? hash['role_identifiers'] : SKIP
+      include_favorite_metadata = hash['include_favorite_metadata'] ||= false
+      include_variable_values = hash['include_variable_values'] ||= false
+
+      # 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.
+      SearchUsersRequest.new(user_identifier: user_identifier,
+                             display_name: display_name,
+                             name_pattern: name_pattern,
+                             visibility: visibility,
+                             email: email,
+                             group_identifiers: group_identifiers,
+                             privileges: privileges,
+                             account_type: account_type,
+                             account_status: account_status,
+                             notify_on_share: notify_on_share,
+                             show_onboarding_experience: show_onboarding_experience,
+                             onboarding_experience_completed: onboarding_experience_completed,
+                             org_identifiers: org_identifiers,
+                             home_liveboard_identifier: home_liveboard_identifier,
+                             favorite_metadata: favorite_metadata,
+                             record_offset: record_offset,
+                             record_size: record_size,
+                             sort_options: sort_options,
+                             role_identifiers: role_identifiers,
+                             include_favorite_metadata: include_favorite_metadata,
+                             include_variable_values: include_variable_values,
+                             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},"\
+      " name_pattern: #{@name_pattern}, visibility: #{@visibility}, email: #{@email},"\
+      " group_identifiers: #{@group_identifiers}, privileges: #{@privileges}, account_type:"\
+      " #{@account_type}, account_status: #{@account_status}, notify_on_share:"\
+      " #{@notify_on_share}, show_onboarding_experience: #{@show_onboarding_experience},"\
+      " onboarding_experience_completed: #{@onboarding_experience_completed}, org_identifiers:"\
+      " #{@org_identifiers}, home_liveboard_identifier: #{@home_liveboard_identifier},"\
+      " favorite_metadata: #{@favorite_metadata}, record_offset: #{@record_offset}, record_size:"\
+      " #{@record_size}, sort_options: #{@sort_options}, role_identifiers: #{@role_identifiers},"\
+      " include_favorite_metadata: #{@include_favorite_metadata}, include_variable_values:"\
+      " #{@include_variable_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} user_identifier: #{@user_identifier.inspect}, display_name:"\
+      " #{@display_name.inspect}, name_pattern: #{@name_pattern.inspect}, visibility:"\
+      " #{@visibility.inspect}, email: #{@email.inspect}, group_identifiers:"\
+      " #{@group_identifiers.inspect}, privileges: #{@privileges.inspect}, account_type:"\
+      " #{@account_type.inspect}, account_status: #{@account_status.inspect}, notify_on_share:"\
+      " #{@notify_on_share.inspect}, show_onboarding_experience:"\
+      " #{@show_onboarding_experience.inspect}, onboarding_experience_completed:"\
+      " #{@onboarding_experience_completed.inspect}, org_identifiers: #{@org_identifiers.inspect},"\
+      " home_liveboard_identifier: #{@home_liveboard_identifier.inspect}, favorite_metadata:"\
+      " #{@favorite_metadata.inspect}, record_offset: #{@record_offset.inspect}, record_size:"\
+      " #{@record_size.inspect}, sort_options: #{@sort_options.inspect}, role_identifiers:"\
+      " #{@role_identifiers.inspect}, include_favorite_metadata:"\
+      " #{@include_favorite_metadata.inspect}, include_variable_values:"\
+      " #{@include_variable_values.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/search_variables_request.rb

@@ -0,0 +1,135 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SearchVariablesRequest Model.
+  class SearchVariablesRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Variable details
+    # @return [Array[VariableDetailInput]]
+    attr_accessor :variable_details
+
+    # Array of scope filters
+    # @return [Array[ValueScopeInput]]
+    attr_accessor :value_scope
+
+    # The starting record number from where the records should be included
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of records that should be included
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # Format in which we want the output
+    # @return [ResponseContent]
+    attr_accessor :response_content
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['variable_details'] = 'variable_details'
+      @_hash['value_scope'] = 'value_scope'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['response_content'] = 'response_content'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        variable_details
+        value_scope
+        record_offset
+        record_size
+        response_content
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(variable_details: SKIP, value_scope: SKIP, record_offset: 0,
+                   record_size: 10, response_content: ResponseContent::METADATA,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @variable_details = variable_details unless variable_details == SKIP
+      @value_scope = value_scope unless value_scope == SKIP
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @response_content = response_content unless response_content == 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
+      variable_details = nil
+      unless hash['variable_details'].nil?
+        variable_details = []
+        hash['variable_details'].each do |structure|
+          variable_details << (VariableDetailInput.from_hash(structure) if structure)
+        end
+      end
+
+      variable_details = SKIP unless hash.key?('variable_details')
+      # Parameter is an array, so we need to iterate through it
+      value_scope = nil
+      unless hash['value_scope'].nil?
+        value_scope = []
+        hash['value_scope'].each do |structure|
+          value_scope << (ValueScopeInput.from_hash(structure) if structure)
+        end
+      end
+
+      value_scope = SKIP unless hash.key?('value_scope')
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= 10
+      response_content = hash['response_content'] ||= ResponseContent::METADATA
+
+      # 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.
+      SearchVariablesRequest.new(variable_details: variable_details,
+                                 value_scope: value_scope,
+                                 record_offset: record_offset,
+                                 record_size: record_size,
+                                 response_content: response_content,
+                                 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} variable_details: #{@variable_details}, value_scope: #{@value_scope},"\
+      " record_offset: #{@record_offset}, record_size: #{@record_size}, response_content:"\
+      " #{@response_content}, 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} variable_details: #{@variable_details.inspect}, value_scope:"\
+      " #{@value_scope.inspect}, record_offset: #{@record_offset.inspect}, record_size:"\
+      " #{@record_size.inspect}, response_content: #{@response_content.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/search_webhook_configurations_request.rb

@@ -0,0 +1,132 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # SearchWebhookConfigurationsRequest Model.
+  class SearchWebhookConfigurationsRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique ID or name of the org.
+    # @return [String]
+    attr_accessor :org_identifier
+
+    # Unique ID or name of the webhook.
+    # @return [String]
+    attr_accessor :webhook_identifier
+
+    # Type of webhook event to filter by.
+    # @return [EventType1]
+    attr_accessor :event_type
+
+    # The offset point, starting from where the webhooks should be included in
+    # the response.
+    # @return [Integer]
+    attr_accessor :record_offset
+
+    # The number of webhooks that should be included in the response starting
+    # from offset position.
+    # @return [Integer]
+    attr_accessor :record_size
+
+    # Sort option includes sort field and sort order.
+    # @return [WebhookSortOptionsInput]
+    attr_accessor :sort_options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['org_identifier'] = 'org_identifier'
+      @_hash['webhook_identifier'] = 'webhook_identifier'
+      @_hash['event_type'] = 'event_type'
+      @_hash['record_offset'] = 'record_offset'
+      @_hash['record_size'] = 'record_size'
+      @_hash['sort_options'] = 'sort_options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        org_identifier
+        webhook_identifier
+        event_type
+        record_offset
+        record_size
+        sort_options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(org_identifier: SKIP, webhook_identifier: SKIP,
+                   event_type: SKIP, record_offset: 0, record_size: 50,
+                   sort_options: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @org_identifier = org_identifier unless org_identifier == SKIP
+      @webhook_identifier = webhook_identifier unless webhook_identifier == SKIP
+      @event_type = event_type unless event_type == SKIP
+      @record_offset = record_offset unless record_offset == SKIP
+      @record_size = record_size unless record_size == SKIP
+      @sort_options = sort_options unless sort_options == 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.
+      org_identifier =
+        hash.key?('org_identifier') ? hash['org_identifier'] : SKIP
+      webhook_identifier =
+        hash.key?('webhook_identifier') ? hash['webhook_identifier'] : SKIP
+      event_type = hash.key?('event_type') ? hash['event_type'] : SKIP
+      record_offset = hash['record_offset'] ||= 0
+      record_size = hash['record_size'] ||= 50
+      sort_options = WebhookSortOptionsInput.from_hash(hash['sort_options']) if
+        hash['sort_options']
+
+      # 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.
+      SearchWebhookConfigurationsRequest.new(org_identifier: org_identifier,
+                                             webhook_identifier: webhook_identifier,
+                                             event_type: event_type,
+                                             record_offset: record_offset,
+                                             record_size: record_size,
+                                             sort_options: sort_options,
+                                             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} org_identifier: #{@org_identifier}, webhook_identifier:"\
+      " #{@webhook_identifier}, event_type: #{@event_type}, record_offset: #{@record_offset},"\
+      " record_size: #{@record_size}, sort_options: #{@sort_options}, 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} org_identifier: #{@org_identifier.inspect}, webhook_identifier:"\
+      " #{@webhook_identifier.inspect}, event_type: #{@event_type.inspect}, record_offset:"\
+      " #{@record_offset.inspect}, record_size: #{@record_size.inspect}, sort_options:"\
+      " #{@sort_options.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end