ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/pdf_options.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
+  # Options for PDF export.
+  class PdfOptions < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether to include complete Liveboard.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :complete_liveboard
+
+    # Indicates whether to include cover page with the Liveboard title.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_cover_page
+
+    # Indicates whether to include customized wide logo in the footer if
+    # available.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_custom_logo
+
+    # Indicates whether to include a page with all applied filters.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_filter_page
+
+    # Indicates whether to include page number in the footer of each page
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_page_number
+
+    # Text to include in the footer of each page.
+    # @return [String]
+    attr_accessor :page_footer_text
+
+    # Page orientation of the PDF.
+    # @return [String]
+    attr_accessor :page_orientation
+
+    # Page size.
+    # @return [PageSize]
+    attr_accessor :page_size
+
+    # Indicates whether to include only first page of the tables.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :truncate_table
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['complete_liveboard'] = 'complete_liveboard'
+      @_hash['include_cover_page'] = 'include_cover_page'
+      @_hash['include_custom_logo'] = 'include_custom_logo'
+      @_hash['include_filter_page'] = 'include_filter_page'
+      @_hash['include_page_number'] = 'include_page_number'
+      @_hash['page_footer_text'] = 'page_footer_text'
+      @_hash['page_orientation'] = 'page_orientation'
+      @_hash['page_size'] = 'page_size'
+      @_hash['truncate_table'] = 'truncate_table'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        complete_liveboard
+        include_cover_page
+        include_custom_logo
+        include_filter_page
+        include_page_number
+        page_footer_text
+        page_orientation
+        page_size
+        truncate_table
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        complete_liveboard
+        include_cover_page
+        include_custom_logo
+        include_filter_page
+        include_page_number
+        page_footer_text
+        page_orientation
+        page_size
+        truncate_table
+      ]
+    end
+
+    def initialize(complete_liveboard: SKIP, include_cover_page: SKIP,
+                   include_custom_logo: SKIP, include_filter_page: SKIP,
+                   include_page_number: SKIP, page_footer_text: SKIP,
+                   page_orientation: SKIP, page_size: SKIP,
+                   truncate_table: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @complete_liveboard = complete_liveboard unless complete_liveboard == SKIP
+      @include_cover_page = include_cover_page unless include_cover_page == SKIP
+      @include_custom_logo = include_custom_logo unless include_custom_logo == SKIP
+      @include_filter_page = include_filter_page unless include_filter_page == SKIP
+      @include_page_number = include_page_number unless include_page_number == SKIP
+      @page_footer_text = page_footer_text unless page_footer_text == SKIP
+      @page_orientation = page_orientation unless page_orientation == SKIP
+      @page_size = page_size unless page_size == SKIP
+      @truncate_table = truncate_table unless truncate_table == 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.
+      complete_liveboard =
+        hash.key?('complete_liveboard') ? hash['complete_liveboard'] : SKIP
+      include_cover_page =
+        hash.key?('include_cover_page') ? hash['include_cover_page'] : SKIP
+      include_custom_logo =
+        hash.key?('include_custom_logo') ? hash['include_custom_logo'] : SKIP
+      include_filter_page =
+        hash.key?('include_filter_page') ? hash['include_filter_page'] : SKIP
+      include_page_number =
+        hash.key?('include_page_number') ? hash['include_page_number'] : SKIP
+      page_footer_text =
+        hash.key?('page_footer_text') ? hash['page_footer_text'] : SKIP
+      page_orientation =
+        hash.key?('page_orientation') ? hash['page_orientation'] : SKIP
+      page_size = hash.key?('page_size') ? hash['page_size'] : SKIP
+      truncate_table =
+        hash.key?('truncate_table') ? hash['truncate_table'] : 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.
+      PdfOptions.new(complete_liveboard: complete_liveboard,
+                     include_cover_page: include_cover_page,
+                     include_custom_logo: include_custom_logo,
+                     include_filter_page: include_filter_page,
+                     include_page_number: include_page_number,
+                     page_footer_text: page_footer_text,
+                     page_orientation: page_orientation,
+                     page_size: page_size,
+                     truncate_table: truncate_table,
+                     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} complete_liveboard: #{@complete_liveboard}, include_cover_page:"\
+      " #{@include_cover_page}, include_custom_logo: #{@include_custom_logo}, include_filter_page:"\
+      " #{@include_filter_page}, include_page_number: #{@include_page_number}, page_footer_text:"\
+      " #{@page_footer_text}, page_orientation: #{@page_orientation}, page_size: #{@page_size},"\
+      " truncate_table: #{@truncate_table}, 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} complete_liveboard: #{@complete_liveboard.inspect}, include_cover_page:"\
+      " #{@include_cover_page.inspect}, include_custom_logo: #{@include_custom_logo.inspect},"\
+      " include_filter_page: #{@include_filter_page.inspect}, include_page_number:"\
+      " #{@include_page_number.inspect}, page_footer_text: #{@page_footer_text.inspect},"\
+      " page_orientation: #{@page_orientation.inspect}, page_size: #{@page_size.inspect},"\
+      " truncate_table: #{@truncate_table.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/pdf_options_input.rb

@@ -0,0 +1,151 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # PdfOptionsInput Model.
+  class PdfOptionsInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Indicates whether to include the cover page with the Liveboard title.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_cover_page
+
+    # Indicates whether to include customized wide logo in the footer if
+    # available.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_custom_logo
+
+    # Indicates whether to include a page with all applied filters.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_filter_page
+
+    # Indicates whether to include page number in the footer of each page.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_page_number
+
+    # Page orientation of the PDF.
+    # @return [PageOrientation]
+    attr_accessor :page_orientation
+
+    # Indicates whether to include only the first page of the tables.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :truncate_table
+
+    # Text to include in the footer of each page.
+    # @return [String]
+    attr_accessor :page_footer_text
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['include_cover_page'] = 'include_cover_page'
+      @_hash['include_custom_logo'] = 'include_custom_logo'
+      @_hash['include_filter_page'] = 'include_filter_page'
+      @_hash['include_page_number'] = 'include_page_number'
+      @_hash['page_orientation'] = 'page_orientation'
+      @_hash['truncate_table'] = 'truncate_table'
+      @_hash['page_footer_text'] = 'page_footer_text'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        include_cover_page
+        include_custom_logo
+        include_filter_page
+        include_page_number
+        page_orientation
+        truncate_table
+        page_footer_text
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        include_cover_page
+        include_custom_logo
+        include_filter_page
+        include_page_number
+        page_orientation
+        truncate_table
+        page_footer_text
+      ]
+    end
+
+    def initialize(include_cover_page: true, include_custom_logo: true,
+                   include_filter_page: true, include_page_number: true,
+                   page_orientation: PageOrientation::PORTRAIT,
+                   truncate_table: false, page_footer_text: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @include_cover_page = include_cover_page unless include_cover_page == SKIP
+      @include_custom_logo = include_custom_logo unless include_custom_logo == SKIP
+      @include_filter_page = include_filter_page unless include_filter_page == SKIP
+      @include_page_number = include_page_number unless include_page_number == SKIP
+      @page_orientation = page_orientation unless page_orientation == SKIP
+      @truncate_table = truncate_table unless truncate_table == SKIP
+      @page_footer_text = page_footer_text unless page_footer_text == 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.
+      include_cover_page = hash['include_cover_page'] ||= true
+      include_custom_logo = hash['include_custom_logo'] ||= true
+      include_filter_page = hash['include_filter_page'] ||= true
+      include_page_number = hash['include_page_number'] ||= true
+      page_orientation = hash['page_orientation'] ||= PageOrientation::PORTRAIT
+      truncate_table = hash['truncate_table'] ||= false
+      page_footer_text =
+        hash.key?('page_footer_text') ? hash['page_footer_text'] : 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.
+      PdfOptionsInput.new(include_cover_page: include_cover_page,
+                          include_custom_logo: include_custom_logo,
+                          include_filter_page: include_filter_page,
+                          include_page_number: include_page_number,
+                          page_orientation: page_orientation,
+                          truncate_table: truncate_table,
+                          page_footer_text: page_footer_text,
+                          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} include_cover_page: #{@include_cover_page}, include_custom_logo:"\
+      " #{@include_custom_logo}, include_filter_page: #{@include_filter_page},"\
+      " include_page_number: #{@include_page_number}, page_orientation: #{@page_orientation},"\
+      " truncate_table: #{@truncate_table}, page_footer_text: #{@page_footer_text},"\
+      " 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} include_cover_page: #{@include_cover_page.inspect}, include_custom_logo:"\
+      " #{@include_custom_logo.inspect}, include_filter_page: #{@include_filter_page.inspect},"\
+      " include_page_number: #{@include_page_number.inspect}, page_orientation:"\
+      " #{@page_orientation.inspect}, truncate_table: #{@truncate_table.inspect},"\
+      " page_footer_text: #{@page_footer_text.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/permission.rb

@@ -0,0 +1,40 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Permission details of the Role
+  class Permission
+    PERMISSION = [
+      # TODO: Write general description for READ_ONLY
+      READ_ONLY = 'READ_ONLY'.freeze,
+
+      # TODO: Write general description for MODIFY
+      MODIFY = 'MODIFY'.freeze,
+
+      # TODO: Write general description for NO_ACCESS
+      NO_ACCESS = 'NO_ACCESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = READ_ONLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'read_only' then READ_ONLY
+      when 'modify' then MODIFY
+      when 'no_access' then NO_ACCESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/permission2.rb

@@ -0,0 +1,40 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Permission2.
+  class Permission2
+    PERMISSION2 = [
+      # TODO: Write general description for READ_ONLY
+      READ_ONLY = 'READ_ONLY'.freeze,
+
+      # TODO: Write general description for MODIFY
+      MODIFY = 'MODIFY'.freeze,
+
+      # TODO: Write general description for NO_ACCESS
+      NO_ACCESS = 'NO_ACCESS'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      true
+    end
+
+    def self.from_value(value, default_value = READ_ONLY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'read_only' then READ_ONLY
+      when 'modify' then MODIFY
+      when 'no_access' then NO_ACCESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/permission_input.rb

@@ -0,0 +1,82 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # Details of users or groups.
+  class PermissionInput < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [PrincipalsInput]
+    attr_accessor :principal
+
+    # Object share mode.
+    # @return [ShareMode]
+    attr_accessor :share_mode
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['principal'] = 'principal'
+      @_hash['share_mode'] = 'share_mode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(principal:, share_mode:, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @principal = principal
+      @share_mode = share_mode
+      @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.
+      principal = PrincipalsInput.from_hash(hash['principal']) if hash['principal']
+      share_mode = hash.key?('share_mode') ? hash['share_mode'] : 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.
+      PermissionInput.new(principal: principal,
+                          share_mode: share_mode,
+                          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} principal: #{@principal}, share_mode: #{@share_mode},"\
+      " 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} principal: #{@principal.inspect}, share_mode: #{@share_mode.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/permission_of_metadata_response.rb

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

data/lib/thought_spot_public_rest_api/models/permission_of_principals_response.rb

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