ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/export_liveboard_report_request.rb

@@ -0,0 +1,273 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ExportLiveboardReportRequest Model.
+  class ExportLiveboardReportRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # GUID or name of the Liveboard object.
+    # @return [String]
+    attr_accessor :metadata_identifier
+
+    # GUID or name of the tab of the Liveboard object. <br/>  <span
+    # class="since-beta-tag">Version: 10.9.0.cl or later</span>
+    # @return [Array[String]]
+    attr_accessor :tab_identifiers
+
+    # GUID or name of the personalised view of the Liveboard object. <br/>
+    # <span class="since-beta-tag">Version: 10.9.0.cl or later</span>
+    # @return [String]
+    attr_accessor :personalised_view_identifier
+
+    # GUID or name of visualizations on the Liveboard. If this parameter is
+    # not defined, the API returns a report with all visualizations saved on a
+    # Liveboard.
+    # @return [Array[String]]
+    attr_accessor :visualization_identifiers
+
+    # Transient content of the Liveboard.
+    # @return [String]
+    attr_accessor :transient_content
+
+    # Export file format.
+    # @return [FileFormat]
+    attr_accessor :file_format
+
+    # JSON object with representing filter condition to apply filters at
+    # runtime. For example, {"col1": "region", "op1": "EQ", "val1": "northeast"
+    # }. You can add multiple keys by incrementing the number at the end, for
+    # example, col2, op2, val2. For more information, see [API
+    # Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-repo
+    # rt-apis#_runtime_filters).
+    # @return [Object]
+    attr_accessor :runtime_filter
+
+    # Applied to the liveboard and overrides any filters already applied on the
+    # same columns in liveboard.
+    # Following example illustrate different kinds of filters:
+    # {
+    #   "override_filters": [
+    #     {
+    #       "column_name": "Color",
+    #       "generic_filter": {
+    #         "op": "IN",
+    #         "values": [
+    #           "almond",
+    #           "turquoise"
+    #         ]
+    #       },
+    #       "negate": false
+    #     },
+    #     {
+    #       "column_name": "Commit Date",
+    #       "date_filter": {
+    #         "datePeriod": "HOUR",
+    #         "number": 3,
+    #         "type": "LAST_N_PERIOD",
+    #         "op": "EQ"
+    #       }
+    #     },
+    #     {
+    #       "column_name": "Sales",
+    #       "generic_filter": {
+    #         "op": "BW_INC",
+    #         "values": [
+    #           "100000",
+    #           "70000"
+    #         ]
+    #       },
+    #       "negate": true
+    #     }
+    #   ]
+    # }
+    # @return [Object]
+    attr_accessor :override_filters
+
+    # JSON string representing runtime sort. For example, {"sortCol1": "region",
+    # "asc1" : true}. For more information, see [API
+    # Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-repo
+    # rt-apis#_runtime_sort).
+    # @return [Object]
+    attr_accessor :runtime_sort
+
+    # Options for PDF export.
+    # @return [PdfOptionsInput]
+    attr_accessor :pdf_options
+
+    # Options for PNG export.
+    # @return [PngOptionsInput]
+    attr_accessor :png_options
+
+    # JSON object for setting values of parameters at runtime. For example,
+    # <code> {"param1": "Double List Param", "paramVal1": 0.5}</code>. You can
+    # add multiple keys by incrementing the number at the end, for example,
+    # param2, paramVal2. For more information, see [API
+    # Documentation](https://developers.thoughtspot.com/docs/fetch-data-and-repo
+    # rt-apis#_runtime_parameters).
+    # @return [Object]
+    attr_accessor :runtime_param_override
+
+    # Options for specific region specific overrides to support
+    # date/number/string/currency formatting.
+    # @return [RegionalSettingsInput]
+    attr_accessor :regional_settings
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_identifier'] = 'metadata_identifier'
+      @_hash['tab_identifiers'] = 'tab_identifiers'
+      @_hash['personalised_view_identifier'] = 'personalised_view_identifier'
+      @_hash['visualization_identifiers'] = 'visualization_identifiers'
+      @_hash['transient_content'] = 'transient_content'
+      @_hash['file_format'] = 'file_format'
+      @_hash['runtime_filter'] = 'runtime_filter'
+      @_hash['override_filters'] = 'override_filters'
+      @_hash['runtime_sort'] = 'runtime_sort'
+      @_hash['pdf_options'] = 'pdf_options'
+      @_hash['png_options'] = 'png_options'
+      @_hash['runtime_param_override'] = 'runtime_param_override'
+      @_hash['regional_settings'] = 'regional_settings'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        tab_identifiers
+        personalised_view_identifier
+        visualization_identifiers
+        transient_content
+        file_format
+        runtime_filter
+        override_filters
+        runtime_sort
+        pdf_options
+        png_options
+        runtime_param_override
+        regional_settings
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(metadata_identifier:, tab_identifiers: SKIP,
+                   personalised_view_identifier: SKIP,
+                   visualization_identifiers: SKIP, transient_content: SKIP,
+                   file_format: FileFormat::PDF, runtime_filter: SKIP,
+                   override_filters: SKIP, runtime_sort: SKIP,
+                   pdf_options: SKIP, png_options: SKIP,
+                   runtime_param_override: SKIP, regional_settings: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_identifier = metadata_identifier
+      @tab_identifiers = tab_identifiers unless tab_identifiers == SKIP
+      unless personalised_view_identifier == SKIP
+        @personalised_view_identifier =
+          personalised_view_identifier
+      end
+      unless visualization_identifiers == SKIP
+        @visualization_identifiers =
+          visualization_identifiers
+      end
+      @transient_content = transient_content unless transient_content == SKIP
+      @file_format = file_format unless file_format == SKIP
+      @runtime_filter = runtime_filter unless runtime_filter == SKIP
+      @override_filters = override_filters unless override_filters == SKIP
+      @runtime_sort = runtime_sort unless runtime_sort == SKIP
+      @pdf_options = pdf_options unless pdf_options == SKIP
+      @png_options = png_options unless png_options == SKIP
+      @runtime_param_override = runtime_param_override unless runtime_param_override == SKIP
+      @regional_settings = regional_settings unless regional_settings == 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.
+      metadata_identifier =
+        hash.key?('metadata_identifier') ? hash['metadata_identifier'] : nil
+      tab_identifiers =
+        hash.key?('tab_identifiers') ? hash['tab_identifiers'] : SKIP
+      personalised_view_identifier =
+        hash.key?('personalised_view_identifier') ? hash['personalised_view_identifier'] : SKIP
+      visualization_identifiers =
+        hash.key?('visualization_identifiers') ? hash['visualization_identifiers'] : SKIP
+      transient_content =
+        hash.key?('transient_content') ? hash['transient_content'] : SKIP
+      file_format = hash['file_format'] ||= FileFormat::PDF
+      runtime_filter =
+        hash.key?('runtime_filter') ? hash['runtime_filter'] : SKIP
+      override_filters =
+        hash.key?('override_filters') ? hash['override_filters'] : SKIP
+      runtime_sort = hash.key?('runtime_sort') ? hash['runtime_sort'] : SKIP
+      pdf_options = PdfOptionsInput.from_hash(hash['pdf_options']) if hash['pdf_options']
+      png_options = PngOptionsInput.from_hash(hash['png_options']) if hash['png_options']
+      runtime_param_override =
+        hash.key?('runtime_param_override') ? hash['runtime_param_override'] : SKIP
+      regional_settings = RegionalSettingsInput.from_hash(hash['regional_settings']) if
+        hash['regional_settings']
+
+      # 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.
+      ExportLiveboardReportRequest.new(metadata_identifier: metadata_identifier,
+                                       tab_identifiers: tab_identifiers,
+                                       personalised_view_identifier: personalised_view_identifier,
+                                       visualization_identifiers: visualization_identifiers,
+                                       transient_content: transient_content,
+                                       file_format: file_format,
+                                       runtime_filter: runtime_filter,
+                                       override_filters: override_filters,
+                                       runtime_sort: runtime_sort,
+                                       pdf_options: pdf_options,
+                                       png_options: png_options,
+                                       runtime_param_override: runtime_param_override,
+                                       regional_settings: regional_settings,
+                                       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} metadata_identifier: #{@metadata_identifier}, tab_identifiers:"\
+      " #{@tab_identifiers}, personalised_view_identifier: #{@personalised_view_identifier},"\
+      " visualization_identifiers: #{@visualization_identifiers}, transient_content:"\
+      " #{@transient_content}, file_format: #{@file_format}, runtime_filter: #{@runtime_filter},"\
+      " override_filters: #{@override_filters}, runtime_sort: #{@runtime_sort}, pdf_options:"\
+      " #{@pdf_options}, png_options: #{@png_options}, runtime_param_override:"\
+      " #{@runtime_param_override}, regional_settings: #{@regional_settings},"\
+      " 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} metadata_identifier: #{@metadata_identifier.inspect}, tab_identifiers:"\
+      " #{@tab_identifiers.inspect}, personalised_view_identifier:"\
+      " #{@personalised_view_identifier.inspect}, visualization_identifiers:"\
+      " #{@visualization_identifiers.inspect}, transient_content: #{@transient_content.inspect},"\
+      " file_format: #{@file_format.inspect}, runtime_filter: #{@runtime_filter.inspect},"\
+      " override_filters: #{@override_filters.inspect}, runtime_sort: #{@runtime_sort.inspect},"\
+      " pdf_options: #{@pdf_options.inspect}, png_options: #{@png_options.inspect},"\
+      " runtime_param_override: #{@runtime_param_override.inspect}, regional_settings:"\
+      " #{@regional_settings.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/export_metadata_tml_batched_request.rb

@@ -0,0 +1,133 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ExportMetadataTmlBatchedRequest Model.
+  class ExportMetadataTmlBatchedRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Type of metadata object to export, can be one of USER | ROLE | USER_GROUP
+    # @return [MetadataType2]
+    attr_accessor :metadata_type
+
+    # Indicates the position within the complete set from where the API should
+    # begin returning objects.
+    # @return [Integer]
+    attr_accessor :batch_offset
+
+    # Determines the number of objects or items to be retrieved in a single
+    # request.
+    # @return [Integer]
+    attr_accessor :batch_size
+
+    # TML EDOC content format.
+    # @return [EdocFormat1]
+    attr_accessor :edoc_format
+
+    # Indicates whether to export dependent metadata objects of specified
+    # metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_dependent
+
+    # Indicates whether to export is happening from all orgs context.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :all_orgs_override
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata_type'] = 'metadata_type'
+      @_hash['batch_offset'] = 'batch_offset'
+      @_hash['batch_size'] = 'batch_size'
+      @_hash['edoc_format'] = 'edoc_format'
+      @_hash['export_dependent'] = 'export_dependent'
+      @_hash['all_orgs_override'] = 'all_orgs_override'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        batch_offset
+        batch_size
+        edoc_format
+        export_dependent
+        all_orgs_override
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        export_dependent
+        all_orgs_override
+      ]
+    end
+
+    def initialize(metadata_type:, batch_offset: 0, batch_size: 20,
+                   edoc_format: EdocFormat1::JSON, export_dependent: false,
+                   all_orgs_override: false, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata_type = metadata_type
+      @batch_offset = batch_offset unless batch_offset == SKIP
+      @batch_size = batch_size unless batch_size == SKIP
+      @edoc_format = edoc_format unless edoc_format == SKIP
+      @export_dependent = export_dependent unless export_dependent == SKIP
+      @all_orgs_override = all_orgs_override unless all_orgs_override == 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.
+      metadata_type = hash.key?('metadata_type') ? hash['metadata_type'] : nil
+      batch_offset = hash['batch_offset'] ||= 0
+      batch_size = hash['batch_size'] ||= 20
+      edoc_format = hash['edoc_format'] ||= EdocFormat1::JSON
+      export_dependent = hash['export_dependent'] ||= false
+      all_orgs_override = hash['all_orgs_override'] ||= 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.
+      ExportMetadataTmlBatchedRequest.new(metadata_type: metadata_type,
+                                          batch_offset: batch_offset,
+                                          batch_size: batch_size,
+                                          edoc_format: edoc_format,
+                                          export_dependent: export_dependent,
+                                          all_orgs_override: all_orgs_override,
+                                          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} metadata_type: #{@metadata_type}, batch_offset: #{@batch_offset},"\
+      " batch_size: #{@batch_size}, edoc_format: #{@edoc_format}, export_dependent:"\
+      " #{@export_dependent}, all_orgs_override: #{@all_orgs_override}, 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} metadata_type: #{@metadata_type.inspect}, batch_offset:"\
+      " #{@batch_offset.inspect}, batch_size: #{@batch_size.inspect}, edoc_format:"\
+      " #{@edoc_format.inspect}, export_dependent: #{@export_dependent.inspect},"\
+      " all_orgs_override: #{@all_orgs_override.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/export_metadata_tml_request.rb

@@ -0,0 +1,196 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # ExportMetadataTmlRequest Model.
+  class ExportMetadataTmlRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Metadata objects.
+    # @return [Array[ExportMetadataTypeInput]]
+    attr_accessor :metadata
+
+    # Indicates whether to export associated metadata objects of specified
+    # metadata objects.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_associated
+
+    # Adds FQNs of the referenced objects. For example, if you are exporting a
+    # Liveboard and its associated objects,
+    # the API returns the Liveboard TML data with the FQNs of the referenced
+    # worksheet.
+    # If the exported TML data includes FQNs, you don't need to manually add
+    # FQNs of the referenced objects during TML import.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_fqn
+
+    # TML EDOC content format.
+    # **Note: exporting in YAML format currently requires manual formatting of
+    # the output. For more details on the workaround, please click
+    # [here](https://developers.thoughtspot.com/docs/known-issues#_version_9_12_
+    # 0_cl)**
+    # @return [EdocFormat]
+    attr_accessor :edoc_format
+
+    # Indicates whether to export worksheet TML in DEFAULT or V1 or V2 version.
+    # @return [ExportSchemaVersion]
+    attr_accessor :export_schema_version
+
+    # Indicates whether to export table while exporting connection.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_dependent
+
+    # Indicates whether to export connection as dependent while exporting
+    # table/worksheet/answer/liveboard.
+    # This will only be active when export_associated is true.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :export_connection_as_dependent
+
+    # Indicates whether to export is happening from all orgs context.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :all_orgs_override
+
+    # Flags to specify additional options for export. <br/>  <span
+    # class="since-beta-tag">Version: 10.6.0.cl or later</span>
+    # @return [ExportOptions]
+    attr_accessor :export_options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['metadata'] = 'metadata'
+      @_hash['export_associated'] = 'export_associated'
+      @_hash['export_fqn'] = 'export_fqn'
+      @_hash['edoc_format'] = 'edoc_format'
+      @_hash['export_schema_version'] = 'export_schema_version'
+      @_hash['export_dependent'] = 'export_dependent'
+      @_hash['export_connection_as_dependent'] =
+        'export_connection_as_dependent'
+      @_hash['all_orgs_override'] = 'all_orgs_override'
+      @_hash['export_options'] = 'export_options'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        export_associated
+        export_fqn
+        edoc_format
+        export_schema_version
+        export_dependent
+        export_connection_as_dependent
+        all_orgs_override
+        export_options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        export_associated
+        export_fqn
+        export_dependent
+        export_connection_as_dependent
+        all_orgs_override
+      ]
+    end
+
+    def initialize(metadata:, export_associated: false, export_fqn: false,
+                   edoc_format: EdocFormat::JSON,
+                   export_schema_version: ExportSchemaVersion::DEFAULT,
+                   export_dependent: false,
+                   export_connection_as_dependent: false,
+                   all_orgs_override: false, export_options: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @metadata = metadata
+      @export_associated = export_associated unless export_associated == SKIP
+      @export_fqn = export_fqn unless export_fqn == SKIP
+      @edoc_format = edoc_format unless edoc_format == SKIP
+      @export_schema_version = export_schema_version unless export_schema_version == SKIP
+      @export_dependent = export_dependent unless export_dependent == SKIP
+      unless export_connection_as_dependent == SKIP
+        @export_connection_as_dependent =
+          export_connection_as_dependent
+      end
+      @all_orgs_override = all_orgs_override unless all_orgs_override == SKIP
+      @export_options = export_options unless export_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.
+      # Parameter is an array, so we need to iterate through it
+      metadata = nil
+      unless hash['metadata'].nil?
+        metadata = []
+        hash['metadata'].each do |structure|
+          metadata << (ExportMetadataTypeInput.from_hash(structure) if structure)
+        end
+      end
+
+      metadata = nil unless hash.key?('metadata')
+      export_associated = hash['export_associated'] ||= false
+      export_fqn = hash['export_fqn'] ||= false
+      edoc_format = hash['edoc_format'] ||= EdocFormat::JSON
+      export_schema_version =
+        hash['export_schema_version'] ||= ExportSchemaVersion::DEFAULT
+      export_dependent = hash['export_dependent'] ||= false
+      export_connection_as_dependent =
+        hash['export_connection_as_dependent'] ||= false
+      all_orgs_override = hash['all_orgs_override'] ||= false
+      export_options = ExportOptions.from_hash(hash['export_options']) if hash['export_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.
+      ExportMetadataTmlRequest.new(metadata: metadata,
+                                   export_associated: export_associated,
+                                   export_fqn: export_fqn,
+                                   edoc_format: edoc_format,
+                                   export_schema_version: export_schema_version,
+                                   export_dependent: export_dependent,
+                                   export_connection_as_dependent: export_connection_as_dependent,
+                                   all_orgs_override: all_orgs_override,
+                                   export_options: export_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} metadata: #{@metadata}, export_associated: #{@export_associated},"\
+      " export_fqn: #{@export_fqn}, edoc_format: #{@edoc_format}, export_schema_version:"\
+      " #{@export_schema_version}, export_dependent: #{@export_dependent},"\
+      " export_connection_as_dependent: #{@export_connection_as_dependent}, all_orgs_override:"\
+      " #{@all_orgs_override}, export_options: #{@export_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} metadata: #{@metadata.inspect}, export_associated:"\
+      " #{@export_associated.inspect}, export_fqn: #{@export_fqn.inspect}, edoc_format:"\
+      " #{@edoc_format.inspect}, export_schema_version: #{@export_schema_version.inspect},"\
+      " export_dependent: #{@export_dependent.inspect}, export_connection_as_dependent:"\
+      " #{@export_connection_as_dependent.inspect}, all_orgs_override:"\
+      " #{@all_orgs_override.inspect}, export_options: #{@export_options.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end