ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/update_schedule_request.rb

@@ -0,0 +1,194 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UpdateScheduleRequest Model.
+  class UpdateScheduleRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the scheduled job.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the scheduled job.
+    # @return [String]
+    attr_accessor :description
+
+    # Type of metadata object.
+    # @return [MetadataType5]
+    attr_accessor :metadata_type
+
+    # Unique ID or name of the metadata object.
+    # @return [String]
+    attr_accessor :metadata_identifier
+
+    # Export file format.
+    # @return [FileFormat2]
+    attr_accessor :file_format
+
+    # Options to specify the details of a Liveboard.
+    # @return [LiveboardOptionsInput]
+    attr_accessor :liveboard_options
+
+    # Options for PDF export.
+    # @return [SchedulesPdfOptionsInput]
+    attr_accessor :pdf_options
+
+    # Time zone
+    # @return [TimeZone]
+    attr_accessor :time_zone
+
+    # Frequency of the scheduled job run.
+    # @return [FrequencyInput]
+    attr_accessor :frequency
+
+    # Recipients of the scheduled job notifications. You can add the ID or name
+    # of the ThoughtSpot users or groups as recipients in the `principals`
+    # array. If a recipient is not a ThoughtSpot user, specify email address.
+    # @return [RecipientDetailsInput]
+    attr_accessor :recipient_details
+
+    # Status of the schedule
+    # @return [Status4]
+    attr_accessor :status
+
+    # Personalised view id of the liveboard to be scheduled.
+    # @return [String]
+    attr_accessor :personalised_view_id
+
+    # 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_type'] = 'metadata_type'
+      @_hash['metadata_identifier'] = 'metadata_identifier'
+      @_hash['file_format'] = 'file_format'
+      @_hash['liveboard_options'] = 'liveboard_options'
+      @_hash['pdf_options'] = 'pdf_options'
+      @_hash['time_zone'] = 'time_zone'
+      @_hash['frequency'] = 'frequency'
+      @_hash['recipient_details'] = 'recipient_details'
+      @_hash['status'] = 'status'
+      @_hash['personalised_view_id'] = 'personalised_view_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        description
+        metadata_type
+        metadata_identifier
+        file_format
+        liveboard_options
+        pdf_options
+        time_zone
+        frequency
+        recipient_details
+        status
+        personalised_view_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, description: SKIP, metadata_type: SKIP,
+                   metadata_identifier: SKIP, file_format: SKIP,
+                   liveboard_options: SKIP, pdf_options: SKIP, time_zone: SKIP,
+                   frequency: SKIP, recipient_details: SKIP, status: SKIP,
+                   personalised_view_id: SKIP, 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_type = metadata_type unless metadata_type == SKIP
+      @metadata_identifier = metadata_identifier unless metadata_identifier == SKIP
+      @file_format = file_format unless file_format == SKIP
+      @liveboard_options = liveboard_options unless liveboard_options == SKIP
+      @pdf_options = pdf_options unless pdf_options == SKIP
+      @time_zone = time_zone unless time_zone == SKIP
+      @frequency = frequency unless frequency == SKIP
+      @recipient_details = recipient_details unless recipient_details == SKIP
+      @status = status unless status == SKIP
+      @personalised_view_id = personalised_view_id unless personalised_view_id == 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
+      metadata_type = hash.key?('metadata_type') ? hash['metadata_type'] : SKIP
+      metadata_identifier =
+        hash.key?('metadata_identifier') ? hash['metadata_identifier'] : SKIP
+      file_format = hash.key?('file_format') ? hash['file_format'] : SKIP
+      liveboard_options = LiveboardOptionsInput.from_hash(hash['liveboard_options']) if
+        hash['liveboard_options']
+      pdf_options = SchedulesPdfOptionsInput.from_hash(hash['pdf_options']) if hash['pdf_options']
+      time_zone = hash.key?('time_zone') ? hash['time_zone'] : SKIP
+      frequency = FrequencyInput.from_hash(hash['frequency']) if hash['frequency']
+      recipient_details = RecipientDetailsInput.from_hash(hash['recipient_details']) if
+        hash['recipient_details']
+      status = hash.key?('status') ? hash['status'] : SKIP
+      personalised_view_id =
+        hash.key?('personalised_view_id') ? hash['personalised_view_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.
+      UpdateScheduleRequest.new(name: name,
+                                description: description,
+                                metadata_type: metadata_type,
+                                metadata_identifier: metadata_identifier,
+                                file_format: file_format,
+                                liveboard_options: liveboard_options,
+                                pdf_options: pdf_options,
+                                time_zone: time_zone,
+                                frequency: frequency,
+                                recipient_details: recipient_details,
+                                status: status,
+                                personalised_view_id: personalised_view_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} name: #{@name}, description: #{@description}, metadata_type:"\
+      " #{@metadata_type}, metadata_identifier: #{@metadata_identifier}, file_format:"\
+      " #{@file_format}, liveboard_options: #{@liveboard_options}, pdf_options: #{@pdf_options},"\
+      " time_zone: #{@time_zone}, frequency: #{@frequency}, recipient_details:"\
+      " #{@recipient_details}, status: #{@status}, personalised_view_id: #{@personalised_view_id},"\
+      " 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_type: #{@metadata_type.inspect}, metadata_identifier:"\
+      " #{@metadata_identifier.inspect}, file_format: #{@file_format.inspect}, liveboard_options:"\
+      " #{@liveboard_options.inspect}, pdf_options: #{@pdf_options.inspect}, time_zone:"\
+      " #{@time_zone.inspect}, frequency: #{@frequency.inspect}, recipient_details:"\
+      " #{@recipient_details.inspect}, status: #{@status.inspect}, personalised_view_id:"\
+      " #{@personalised_view_id.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/update_system_config_request.rb

@@ -0,0 +1,75 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UpdateSystemConfigRequest Model.
+  class UpdateSystemConfigRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Configuration JSON with the key-value pair of configuration attributes to
+    # be updated.
+    # @return [Object]
+    attr_accessor :configuration
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['configuration'] = 'configuration'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(configuration:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @configuration = configuration
+      @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.
+      configuration = hash.key?('configuration') ? hash['configuration'] : nil
+
+      # 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.
+      UpdateSystemConfigRequest.new(configuration: configuration,
+                                    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} configuration: #{@configuration}, 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} configuration: #{@configuration.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/update_tag_request.rb

@@ -0,0 +1,85 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UpdateTagRequest Model.
+  class UpdateTagRequest < 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[
+        name
+        color
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, color: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      @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'] : SKIP
+      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.
+      UpdateTagRequest.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/update_user_group_request.rb

@@ -0,0 +1,191 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # UpdateUserGroupRequest Model.
+  class UpdateUserGroupRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the group to modify.
+    # @return [String]
+    attr_accessor :name
+
+    # ID of the Liveboards to be assigned as default Liveboards to the users in
+    # the group.
+    # @return [Array[String]]
+    attr_accessor :default_liveboard_identifiers
+
+    # Description for the group.
+    # @return [String]
+    attr_accessor :description
+
+    # Display name of the group.
+    # @return [String]
+    attr_accessor :display_name
+
+    # 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
+
+    # Type of the group
+    # @return [Type31]
+    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 [Visibility7]
+    attr_accessor :visibility
+
+    # Role identifiers of the Roles that should be assigned to the group.
+    # @return [Array[String]]
+    attr_accessor :role_identifiers
+
+    # Type of update operation. Default operation type is REPLACE
+    # @return [Operation5]
+    attr_accessor :operation
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['default_liveboard_identifiers'] =
+        'default_liveboard_identifiers'
+      @_hash['description'] = 'description'
+      @_hash['display_name'] = 'display_name'
+      @_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['operation'] = 'operation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        default_liveboard_identifiers
+        description
+        display_name
+        privileges
+        sub_group_identifiers
+        type
+        user_identifiers
+        visibility
+        role_identifiers
+        operation
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name: SKIP, default_liveboard_identifiers: SKIP,
+                   description: SKIP, display_name: SKIP, privileges: SKIP,
+                   sub_group_identifiers: SKIP, type: SKIP,
+                   user_identifiers: SKIP, visibility: SKIP,
+                   role_identifiers: SKIP, operation: Operation5::REPLACE,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name unless name == SKIP
+      unless default_liveboard_identifiers == SKIP
+        @default_liveboard_identifiers =
+          default_liveboard_identifiers
+      end
+      @description = description unless description == SKIP
+      @display_name = display_name unless display_name == 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
+      @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
+      default_liveboard_identifiers =
+        hash.key?('default_liveboard_identifiers') ? hash['default_liveboard_identifiers'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      display_name = hash.key?('display_name') ? hash['display_name'] : SKIP
+      privileges = hash.key?('privileges') ? hash['privileges'] : SKIP
+      sub_group_identifiers =
+        hash.key?('sub_group_identifiers') ? hash['sub_group_identifiers'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      user_identifiers =
+        hash.key?('user_identifiers') ? hash['user_identifiers'] : SKIP
+      visibility = hash.key?('visibility') ? hash['visibility'] : SKIP
+      role_identifiers =
+        hash.key?('role_identifiers') ? hash['role_identifiers'] : SKIP
+      operation = hash['operation'] ||= Operation5::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.
+      UpdateUserGroupRequest.new(name: name,
+                                 default_liveboard_identifiers: default_liveboard_identifiers,
+                                 description: description,
+                                 display_name: display_name,
+                                 privileges: privileges,
+                                 sub_group_identifiers: sub_group_identifiers,
+                                 type: type,
+                                 user_identifiers: user_identifiers,
+                                 visibility: visibility,
+                                 role_identifiers: role_identifiers,
+                                 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}, default_liveboard_identifiers:"\
+      " #{@default_liveboard_identifiers}, description: #{@description}, display_name:"\
+      " #{@display_name}, privileges: #{@privileges}, sub_group_identifiers:"\
+      " #{@sub_group_identifiers}, type: #{@type}, user_identifiers: #{@user_identifiers},"\
+      " visibility: #{@visibility}, role_identifiers: #{@role_identifiers}, 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}, default_liveboard_identifiers:"\
+      " #{@default_liveboard_identifiers.inspect}, description: #{@description.inspect},"\
+      " display_name: #{@display_name.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}, operation: #{@operation.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end