ths-apimatic-sdk-sdk 1.0.0

data/lib/thought_spot_public_rest_api/models/create_custom_action_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
+  # CreateCustomActionRequest Model.
+  class CreateCustomActionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the custom action. The custom action name must be unique.
+    # @return [String]
+    attr_accessor :name
+
+    # Action details includes `Type` and Configuration data for Custom Actions,
+    # either Callback or URL is required.
+    # @return [ActionDetailsInputCreate]
+    attr_accessor :action_details
+
+    # Metadata objects to which the custom action needs to be associated.
+    # @return [Array[AssociateMetadataInputCreate]]
+    attr_accessor :associate_metadata
+
+    # Default Custom action configuration. This includes if the custom action is
+    # available on all visualizations. By default, a custom action is added to
+    # all visualizations and Answers.
+    # @return [DefaultActionConfigInputCreate]
+    attr_accessor :default_action_config
+
+    # Unique ID or name of the groups that can view and access the custom
+    # action.
+    # @return [Array[String]]
+    attr_accessor :group_identifiers
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['action_details'] = 'action_details'
+      @_hash['associate_metadata'] = 'associate_metadata'
+      @_hash['default_action_config'] = 'default_action_config'
+      @_hash['group_identifiers'] = 'group_identifiers'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        associate_metadata
+        default_action_config
+        group_identifiers
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, action_details:, associate_metadata: SKIP,
+                   default_action_config: SKIP, group_identifiers: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @action_details = action_details
+      @associate_metadata = associate_metadata unless associate_metadata == SKIP
+      @default_action_config = default_action_config unless default_action_config == SKIP
+      @group_identifiers = group_identifiers unless group_identifiers == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      action_details = ActionDetailsInputCreate.from_hash(hash['action_details']) if
+        hash['action_details']
+      # Parameter is an array, so we need to iterate through it
+      associate_metadata = nil
+      unless hash['associate_metadata'].nil?
+        associate_metadata = []
+        hash['associate_metadata'].each do |structure|
+          associate_metadata << (AssociateMetadataInputCreate.from_hash(structure) if structure)
+        end
+      end
+
+      associate_metadata = SKIP unless hash.key?('associate_metadata')
+      if hash['default_action_config']
+        default_action_config = DefaultActionConfigInputCreate.from_hash(hash['default_action_config'])
+      end
+      group_identifiers =
+        hash.key?('group_identifiers') ? hash['group_identifiers'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CreateCustomActionRequest.new(name: name,
+                                    action_details: action_details,
+                                    associate_metadata: associate_metadata,
+                                    default_action_config: default_action_config,
+                                    group_identifiers: group_identifiers,
+                                    additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, action_details: #{@action_details}, associate_metadata:"\
+      " #{@associate_metadata}, default_action_config: #{@default_action_config},"\
+      " group_identifiers: #{@group_identifiers}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, action_details: #{@action_details.inspect},"\
+      " associate_metadata: #{@associate_metadata.inspect}, default_action_config:"\
+      " #{@default_action_config.inspect}, group_identifiers: #{@group_identifiers.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/create_email_customization_request.rb

@@ -0,0 +1,88 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # CreateEmailCustomizationRequest Model.
+  class CreateEmailCustomizationRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Email customization configuration as key value pair
+    # @return [TemplatePropertiesInputCreate]
+    attr_accessor :template_properties
+
+    # Unique ID or name of org <br/>  <span class="since-beta-tag">Version:
+    # 10.12.0.cl or later</span>
+    # @return [String]
+    attr_accessor :org_identifier
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['template_properties'] = 'template_properties'
+      @_hash['org_identifier'] = 'org_identifier'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        org_identifier
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(template_properties:, org_identifier: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @template_properties = template_properties
+      @org_identifier = org_identifier unless org_identifier == 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.
+      template_properties = TemplatePropertiesInputCreate.from_hash(hash['template_properties']) if
+        hash['template_properties']
+      org_identifier =
+        hash.key?('org_identifier') ? hash['org_identifier'] : 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.
+      CreateEmailCustomizationRequest.new(template_properties: template_properties,
+                                          org_identifier: org_identifier,
+                                          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} template_properties: #{@template_properties}, org_identifier:"\
+      " #{@org_identifier}, 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} template_properties: #{@template_properties.inspect}, org_identifier:"\
+      " #{@org_identifier.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/create_email_customization_response.rb

@@ -0,0 +1,102 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # CreateEmailCustomizationResponse Model.
+  class CreateEmailCustomizationResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Tenant ID
+    # @return [String]
+    attr_accessor :tenant_id
+
+    # Tenant ID
+    # @return [OrgType]
+    attr_accessor :org
+
+    # Email customization name.
+    # @return [String]
+    attr_accessor :name
+
+    # Customization configuration for the email
+    # @return [Object]
+    attr_accessor :template_properties
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['tenant_id'] = 'tenant_id'
+      @_hash['org'] = 'org'
+      @_hash['name'] = 'name'
+      @_hash['template_properties'] = 'template_properties'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(tenant_id:, org:, name:, template_properties:,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @tenant_id = tenant_id
+      @org = org
+      @name = name
+      @template_properties = template_properties
+      @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.
+      tenant_id = hash.key?('tenant_id') ? hash['tenant_id'] : nil
+      org = OrgType.from_hash(hash['org']) if hash['org']
+      name = hash.key?('name') ? hash['name'] : nil
+      template_properties =
+        hash.key?('template_properties') ? hash['template_properties'] : 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.
+      CreateEmailCustomizationResponse.new(tenant_id: tenant_id,
+                                           org: org,
+                                           name: name,
+                                           template_properties: template_properties,
+                                           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} tenant_id: #{@tenant_id}, org: #{@org}, name: #{@name},"\
+      " template_properties: #{@template_properties}, 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} tenant_id: #{@tenant_id.inspect}, org: #{@org.inspect}, name:"\
+      " #{@name.inspect}, template_properties: #{@template_properties.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/create_org_request.rb

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

data/lib/thought_spot_public_rest_api/models/create_role_request.rb

@@ -0,0 +1,110 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # CreateRoleRequest Model.
+  class CreateRoleRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique name of the Role.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the Role.
+    # @return [String]
+    attr_accessor :description
+
+    # Privileges granted to the Role. See
+    # [Documentation](https://developers.thoughtspot.com/docs/rbac#_role_categor
+    # ies_and_privileges)for supported roles privileges.
+    # @return [Array[Privilege2]]
+    attr_accessor :privileges
+
+    # <div><span class="since-beta-tag">Version: 10.5.0.cl or later</span></div>
+    # Indicates whether the role is read only. A readonly role can neither be
+    # updated nor deleted.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :read_only
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['description'] = 'description'
+      @_hash['privileges'] = 'privileges'
+      @_hash['read_only'] = 'read_only'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        description
+        privileges
+        read_only
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      %w[
+        read_only
+      ]
+    end
+
+    def initialize(name:, description: SKIP, privileges: SKIP, read_only: false,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @description = description unless description == SKIP
+      @privileges = privileges unless privileges == SKIP
+      @read_only = read_only unless read_only == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      name = hash.key?('name') ? hash['name'] : nil
+      description = hash.key?('description') ? hash['description'] : SKIP
+      privileges = hash.key?('privileges') ? hash['privileges'] : SKIP
+      read_only = hash['read_only'] ||= 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.
+      CreateRoleRequest.new(name: name,
+                            description: description,
+                            privileges: privileges,
+                            read_only: read_only,
+                            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}, privileges: #{@privileges},"\
+      " read_only: #{@read_only}, 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}, privileges:"\
+      " #{@privileges.inspect}, read_only: #{@read_only.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end

data/lib/thought_spot_public_rest_api/models/create_schedule_request.rb

@@ -0,0 +1,178 @@
+# thought_spot_public_rest_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ThoughtSpotPublicRestApi
+  # CreateScheduleRequest Model.
+  class CreateScheduleRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Name of the scheduled job.
+    # @return [String]
+    attr_accessor :name
+
+    # Description of the job.
+    # @return [String]
+    attr_accessor :description
+
+    # Type of the metadata object.
+    # @return [String]
+    attr_reader :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 details of Liveboard.
+    # @return [LiveboardOptionsInput]
+    attr_accessor :liveboard_options
+
+    # PDF layout and orientation settings. Applicable only if the `file_format`
+    # is specified as `PDF`.
+    # @return [SchedulesPdfOptionsInput]
+    attr_accessor :pdf_options
+
+    # Time zone
+    # @return [TimeZone]
+    attr_accessor :time_zone
+
+    # Frequency settings for the scheduled job.
+    # @return [FrequencyInput]
+    attr_accessor :frequency
+
+    # Recipients of the scheduled job notifications. Add the GUID 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
+
+    # 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['personalised_view_id'] = 'personalised_view_id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        file_format
+        liveboard_options
+        pdf_options
+        frequency
+        personalised_view_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name:, description:, metadata_identifier:,
+                   time_zone: TimeZone::ENUM_AMERICALOS_ANGELES,
+                   recipient_details:, file_format: FileFormat2::PDF,
+                   liveboard_options: SKIP, pdf_options: SKIP, frequency: SKIP,
+                   personalised_view_id: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @name = name
+      @description = description
+      @metadata_type = 'LIVEBOARD'
+      @metadata_identifier = metadata_identifier
+      @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
+      @frequency = frequency unless frequency == SKIP
+      @recipient_details = recipient_details
+      @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'] : nil
+      description = hash.key?('description') ? hash['description'] : nil
+      metadata_identifier =
+        hash.key?('metadata_identifier') ? hash['metadata_identifier'] : nil
+      time_zone = hash['time_zone'] ||= TimeZone::ENUM_AMERICALOS_ANGELES
+      recipient_details = RecipientDetailsInput.from_hash(hash['recipient_details']) if
+        hash['recipient_details']
+      file_format = hash['file_format'] ||= FileFormat2::PDF
+      liveboard_options = LiveboardOptionsInput.from_hash(hash['liveboard_options']) if
+        hash['liveboard_options']
+      pdf_options = SchedulesPdfOptionsInput.from_hash(hash['pdf_options']) if hash['pdf_options']
+      frequency = FrequencyInput.from_hash(hash['frequency']) if hash['frequency']
+      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.
+      CreateScheduleRequest.new(name: name,
+                                description: description,
+                                metadata_identifier: metadata_identifier,
+                                time_zone: time_zone,
+                                recipient_details: recipient_details,
+                                file_format: file_format,
+                                liveboard_options: liveboard_options,
+                                pdf_options: pdf_options,
+                                frequency: frequency,
+                                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}, 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}, personalised_view_id: #{@personalised_view_id.inspect},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+  end
+end