hanzoai 8.5.156

data/lib/hanzoai/api/trust_api.rb

@@ -0,0 +1,1056 @@
+=begin
+#Hanzo Cloud API
+
+#The Hanzo Cloud API as a customer calls it: every operation under /v1/ except the operator's admin product, relay routes, legacy spellings and capabilities still reached by flag. Tagged by product: the first path segment after /v1/.
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.14.0
+
+=end
+
+require 'cgi'
+
+module Hanzoai
+  class TrustApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Removes one record from a section of your organization's trust centre.
+    # Removes one record from a section of your organization's trust centre. A record that is not there is a 404, never a silent success. A control that belongs to the deployment's own inventory is removed by a commit, not by a request.
+    # @param kind [String] Kind is the section — profile, control, document, subprocessor, policy, faq, update or risk. Anything else is not found. The URL is the authority: a value here is bound from the path, which zip binds last.
+    # @param id [String] ID is the record's id within that section. The single-valued sections (profile, risk) hold one record whatever id is named.
+    # @param [Hash] opts the optional parameters
+    # @return [Dropped]
+    def delete_trust_by_kind_by_id(kind, id, opts = {})
+      data, _status_code, _headers = delete_trust_by_kind_by_id_with_http_info(kind, id, opts)
+      data
+    end
+
+    # Removes one record from a section of your organization's trust centre.
+    # Removes one record from a section of your organization's trust centre. A record that is not there is a 404, never a silent success. A control that belongs to the deployment's own inventory is removed by a commit, not by a request.
+    # @param kind [String] Kind is the section — profile, control, document, subprocessor, policy, faq, update or risk. Anything else is not found. The URL is the authority: a value here is bound from the path, which zip binds last.
+    # @param id [String] ID is the record's id within that section. The single-valued sections (profile, risk) hold one record whatever id is named.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Dropped, Integer, Hash)>] Dropped data, response status code and response headers
+    def delete_trust_by_kind_by_id_with_http_info(kind, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.delete_trust_by_kind_by_id ...'
+      end
+      # verify the required parameter 'kind' is set
+      if @api_client.config.client_side_validation && kind.nil?
+        fail ArgumentError, "Missing the required parameter 'kind' when calling TrustApi.delete_trust_by_kind_by_id"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling TrustApi.delete_trust_by_kind_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/trust/{kind}/{id}'.sub('{' + 'kind' + '}', CGI.escape(kind.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Dropped'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.delete_trust_by_kind_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#delete_trust_by_kind_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads YOUR organization's whole trust centre, including the addresses of your own gated documents.
+    # Reads YOUR organization's whole trust centre, including the addresses of your own gated documents. Same shape as the published endpoint; the difference is that this one is resolved from your validated bearer and shows you your own artifacts.
+    # @param [Hash] opts the optional parameters
+    # @return [Centre]
+    def get_trust(opts = {})
+      data, _status_code, _headers = get_trust_with_http_info(opts)
+      data
+    end
+
+    # Reads YOUR organization&#39;s whole trust centre, including the addresses of your own gated documents.
+    # Reads YOUR organization&#39;s whole trust centre, including the addresses of your own gated documents. Same shape as the published endpoint; the difference is that this one is resolved from your validated bearer and shows you your own artifacts.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Centre, Integer, Hash)>] Centre data, response status code and response headers
+    def get_trust_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Centre'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists every control your organization publishes, with the counts.
+    # Lists every control your organization publishes, with the counts.  A control names what it asserts, the mechanism behind it, the repository and file where that mechanism is enforced, how it is verified, and the framework clauses it maps to. Status is automated, partial or absent — and an absent one still names the clause it would satisfy, which is a roadmap, while never moving a coverage number.
+    # @param [Hash] opts the optional parameters
+    # @return [ControlList]
+    def get_trust_controls(opts = {})
+      data, _status_code, _headers = get_trust_controls_with_http_info(opts)
+      data
+    end
+
+    # Lists every control your organization publishes, with the counts.
+    # Lists every control your organization publishes, with the counts.  A control names what it asserts, the mechanism behind it, the repository and file where that mechanism is enforced, how it is verified, and the framework clauses it maps to. Status is automated, partial or absent — and an absent one still names the clause it would satisfy, which is a roadmap, while never moving a coverage number.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ControlList, Integer, Hash)>] ControlList data, response status code and response headers
+    def get_trust_controls_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_controls ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/controls'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ControlList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_controls",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_controls\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads one control by id.
+    # Reads one control by id.
+    # @param id [String] ID is the control&#39;s id, dotted lowercase — \&quot;iam.pkce.s256\&quot;.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_trust_controls_by_id(id, opts = {})
+      data, _status_code, _headers = get_trust_controls_by_id_with_http_info(id, opts)
+      data
+    end
+
+    # Reads one control by id.
+    # Reads one control by id.
+    # @param id [String] ID is the control&#39;s id, dotted lowercase — \&quot;iam.pkce.s256\&quot;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_trust_controls_by_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_controls_by_id ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling TrustApi.get_trust_controls_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/trust/controls/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_controls_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_controls_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because \"12 of 20\" is not a fact until you know what the 20 are.
+    # Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because \"12 of 20\" is not a fact until you know what the 20 are.  Nothing here is a verdict. There is no boolean, and a control that only a person has read counts one rung weaker than it claims to be, because only a check that can FAIL is evidence.
+    # @param [Hash] opts the optional parameters
+    # @return [TrustCoverage]
+    def get_trust_coverage(opts = {})
+      data, _status_code, _headers = get_trust_coverage_with_http_info(opts)
+      data
+    end
+
+    # Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because \&quot;12 of 20\&quot; is not a fact until you know what the 20 are.
+    # Reads coverage: per framework, how many clauses have an automated control behind them, how many are partial, and how many have none — each carrying the unit it is counted in, because \&quot;12 of 20\&quot; is not a fact until you know what the 20 are.  Nothing here is a verdict. There is no boolean, and a control that only a person has read counts one rung weaker than it claims to be, because only a check that can FAIL is evidence.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TrustCoverage, Integer, Hash)>] TrustCoverage data, response status code and response headers
+    def get_trust_coverage_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_coverage ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/coverage'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TrustCoverage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_coverage",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_coverage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.
+    # Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.
+    # @param framework [String] Framework is the framework id — \&quot;soc2\&quot;, \&quot;iso27001\&quot;, \&quot;nist80053\&quot;.
+    # @param [Hash] opts the optional parameters
+    # @return [ClauseCoverage]
+    def get_trust_coverage_by_framework(framework, opts = {})
+      data, _status_code, _headers = get_trust_coverage_by_framework_with_http_info(framework, opts)
+      data
+    end
+
+    # Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.
+    # Reads one framework clause by clause: every clause the standard publishes, what covers it, and which controls stand behind it — so a coverage number can be checked line by line rather than taken on trust.
+    # @param framework [String] Framework is the framework id — \&quot;soc2\&quot;, \&quot;iso27001\&quot;, \&quot;nist80053\&quot;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ClauseCoverage, Integer, Hash)>] ClauseCoverage data, response status code and response headers
+    def get_trust_coverage_by_framework_with_http_info(framework, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_coverage_by_framework ...'
+      end
+      # verify the required parameter 'framework' is set
+      if @api_client.config.client_side_validation && framework.nil?
+        fail ArgumentError, "Missing the required parameter 'framework' when calling TrustApi.get_trust_coverage_by_framework"
+      end
+      # resource path
+      local_var_path = '/v1/trust/coverage/{framework}'.sub('{' + 'framework' + '}', CGI.escape(framework.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ClauseCoverage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_coverage_by_framework",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_coverage_by_framework\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists your organization's documents.
+    # Lists your organization's documents. Because this is your own centre, a gated artifact carries its address here; through the published endpoint it does not.
+    # @param [Hash] opts the optional parameters
+    # @return [TrustDocuments]
+    def get_trust_documents(opts = {})
+      data, _status_code, _headers = get_trust_documents_with_http_info(opts)
+      data
+    end
+
+    # Lists your organization&#39;s documents.
+    # Lists your organization&#39;s documents. Because this is your own centre, a gated artifact carries its address here; through the published endpoint it does not.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(TrustDocuments, Integer, Hash)>] TrustDocuments data, response status code and response headers
+    def get_trust_documents_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_documents ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/documents'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'TrustDocuments'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_documents",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_documents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads the audit rows that stand behind one control, over a window.
+    # Reads the audit rows that stand behind one control, over a window.  The inventory decides what evidences what: a control names the audit actions that are its trail, and this resolves the control id to those actions and reads them. So evidence cannot drift from the inventory, and it is scoped to your own organization — the query carries no organization field for a caller to fill in.  A control that nothing in the trail evidences says so plainly rather than answering an empty page, because an empty page reads like a clean quarter. A deployment with no audit store answers 501 and says the trail was not read, for the same reason.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :control Control is the control id whose trail to read. Required.
+    # @option opts [String] :from From is the inclusive lower bound, an RFC 3339 date or instant (\&quot;2026-01-01\&quot; or \&quot;2026-01-01T00:00:00Z\&quot;). Empty leaves it unbounded. A malformed bound is refused rather than silently widening the window.
+    # @option opts [String] :to To is the upper bound, same form and same tolerance.
+    # @option opts [String] :limit Limit caps the rows returned, 1..1000, default 100. It is a string because an unparseable value is refused rather than read as zero.
+    # @return [Object]
+    def get_trust_evidence(opts = {})
+      data, _status_code, _headers = get_trust_evidence_with_http_info(opts)
+      data
+    end
+
+    # Reads the audit rows that stand behind one control, over a window.
+    # Reads the audit rows that stand behind one control, over a window.  The inventory decides what evidences what: a control names the audit actions that are its trail, and this resolves the control id to those actions and reads them. So evidence cannot drift from the inventory, and it is scoped to your own organization — the query carries no organization field for a caller to fill in.  A control that nothing in the trail evidences says so plainly rather than answering an empty page, because an empty page reads like a clean quarter. A deployment with no audit store answers 501 and says the trail was not read, for the same reason.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :control Control is the control id whose trail to read. Required.
+    # @option opts [String] :from From is the inclusive lower bound, an RFC 3339 date or instant (\&quot;2026-01-01\&quot; or \&quot;2026-01-01T00:00:00Z\&quot;). Empty leaves it unbounded. A malformed bound is refused rather than silently widening the window.
+    # @option opts [String] :to To is the upper bound, same form and same tolerance.
+    # @option opts [String] :limit Limit caps the rows returned, 1..1000, default 100. It is a string because an unparseable value is refused rather than read as zero.
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_trust_evidence_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_evidence ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/evidence'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'control'] = opts[:'control'] if !opts[:'control'].nil?
+      query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
+      query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_evidence",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_evidence\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists your knowledge base — the questions a reviewer asks, answered once.
+    # Lists your knowledge base — the questions a reviewer asks, answered once.
+    # @param [Hash] opts the optional parameters
+    # @return [FaqList]
+    def get_trust_faq(opts = {})
+      data, _status_code, _headers = get_trust_faq_with_http_info(opts)
+      data
+    end
+
+    # Lists your knowledge base — the questions a reviewer asks, answered once.
+    # Lists your knowledge base — the questions a reviewer asks, answered once.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FaqList, Integer, Hash)>] FaqList data, response status code and response headers
+    def get_trust_faq_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_faq ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/faq'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FaqList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_faq",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_faq\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists the frameworks coverage is computed against, and how many clauses each publishes.
+    # Lists the frameworks coverage is computed against, and how many clauses each publishes. That count is the denominator of every coverage number, which is what keeps an uncovered clause visible instead of dropping out of the fraction.
+    # @param [Hash] opts the optional parameters
+    # @return [FrameworkList]
+    def get_trust_frameworks(opts = {})
+      data, _status_code, _headers = get_trust_frameworks_with_http_info(opts)
+      data
+    end
+
+    # Lists the frameworks coverage is computed against, and how many clauses each publishes.
+    # Lists the frameworks coverage is computed against, and how many clauses each publishes. That count is the denominator of every coverage number, which is what keeps an uncovered clause visible instead of dropping out of the fraction.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FrameworkList, Integer, Hash)>] FrameworkList data, response status code and response headers
+    def get_trust_frameworks_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_frameworks ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/frameworks'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FrameworkList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_frameworks",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_frameworks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists your organization's published policies.
+    # Lists your organization's published policies.
+    # @param [Hash] opts the optional parameters
+    # @return [PolicyList]
+    def get_trust_policies(opts = {})
+      data, _status_code, _headers = get_trust_policies_with_http_info(opts)
+      data
+    end
+
+    # Lists your organization&#39;s published policies.
+    # Lists your organization&#39;s published policies.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PolicyList, Integer, Hash)>] PolicyList data, response status code and response headers
+    def get_trust_policies_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_policies ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/policies'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PolicyList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_policies",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads your organization's trust-centre profile — the name, tagline and summary a visitor sees, whether the centre is published, and where to send somebody who wants a gated document.
+    # Reads your organization's trust-centre profile — the name, tagline and summary a visitor sees, whether the centre is published, and where to send somebody who wants a gated document.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_trust_profile(opts = {})
+      data, _status_code, _headers = get_trust_profile_with_http_info(opts)
+      data
+    end
+
+    # Reads your organization&#39;s trust-centre profile — the name, tagline and summary a visitor sees, whether the centre is published, and where to send somebody who wants a gated document.
+    # Reads your organization&#39;s trust-centre profile — the name, tagline and summary a visitor sees, whether the centre is published, and where to send somebody who wants a gated document.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_trust_profile_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_profile ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/profile'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_profile",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_profile\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads a published trust centre — the whole thing in one answer: the organization's profile, its control inventory, coverage computed against each framework's whole published clause list, its documents, subprocessors, policies, knowledge base, updates and risk profile.
+    # Reads a published trust centre — the whole thing in one answer: the organization's profile, its control inventory, coverage computed against each framework's whole published clause list, its documents, subprocessors, policies, knowledge base, updates and risk profile.  This is the PUBLIC endpoint and needs no credential, because a published trust centre is a public document. It answers only for an organization that has published one — an organization that has not is not found rather than empty, since an empty centre and a centre nobody meant to show read the same and are not the same thing.  A gated document appears here with its title, its type and its date and NO address: the listing says the artifact exists and that reading it takes a grant. Nothing an independent auditor signed is ever released through this endpoint.
+    # @param org [String] Org is the organization&#39;s slug — the name in its address.
+    # @param [Hash] opts the optional parameters
+    # @return [Centre]
+    def get_trust_published_by_org(org, opts = {})
+      data, _status_code, _headers = get_trust_published_by_org_with_http_info(org, opts)
+      data
+    end
+
+    # Reads a published trust centre — the whole thing in one answer: the organization&#39;s profile, its control inventory, coverage computed against each framework&#39;s whole published clause list, its documents, subprocessors, policies, knowledge base, updates and risk profile.
+    # Reads a published trust centre — the whole thing in one answer: the organization&#39;s profile, its control inventory, coverage computed against each framework&#39;s whole published clause list, its documents, subprocessors, policies, knowledge base, updates and risk profile.  This is the PUBLIC endpoint and needs no credential, because a published trust centre is a public document. It answers only for an organization that has published one — an organization that has not is not found rather than empty, since an empty centre and a centre nobody meant to show read the same and are not the same thing.  A gated document appears here with its title, its type and its date and NO address: the listing says the artifact exists and that reading it takes a grant. Nothing an independent auditor signed is ever released through this endpoint.
+    # @param org [String] Org is the organization&#39;s slug — the name in its address.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Centre, Integer, Hash)>] Centre data, response status code and response headers
+    def get_trust_published_by_org_with_http_info(org, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_published_by_org ...'
+      end
+      # verify the required parameter 'org' is set
+      if @api_client.config.client_side_validation && org.nil?
+        fail ArgumentError, "Missing the required parameter 'org' when calling TrustApi.get_trust_published_by_org"
+      end
+      # resource path
+      local_var_path = '/v1/trust/published/{org}'.sub('{' + 'org' + '}', CGI.escape(org.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Centre'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_published_by_org",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_published_by_org\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Reads your risk profile — the label and value pairs describing what your organization handles and how.
+    # Reads your risk profile — the label and value pairs describing what your organization handles and how.
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def get_trust_risk(opts = {})
+      data, _status_code, _headers = get_trust_risk_with_http_info(opts)
+      data
+    end
+
+    # Reads your risk profile — the label and value pairs describing what your organization handles and how.
+    # Reads your risk profile — the label and value pairs describing what your organization handles and how.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def get_trust_risk_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_risk ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/risk'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_risk",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_risk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists the third parties your organization sends data to, each naming what it is for.
+    # Lists the third parties your organization sends data to, each naming what it is for.
+    # @param [Hash] opts the optional parameters
+    # @return [SubprocessorList]
+    def get_trust_subprocessors(opts = {})
+      data, _status_code, _headers = get_trust_subprocessors_with_http_info(opts)
+      data
+    end
+
+    # Lists the third parties your organization sends data to, each naming what it is for.
+    # Lists the third parties your organization sends data to, each naming what it is for.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SubprocessorList, Integer, Hash)>] SubprocessorList data, response status code and response headers
+    def get_trust_subprocessors_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_subprocessors ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/subprocessors'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SubprocessorList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_subprocessors",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_subprocessors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Lists your trust-centre updates, newest as you ordered them.
+    # Lists your trust-centre updates, newest as you ordered them.
+    # @param [Hash] opts the optional parameters
+    # @return [UpdateList]
+    def get_trust_updates(opts = {})
+      data, _status_code, _headers = get_trust_updates_with_http_info(opts)
+      data
+    end
+
+    # Lists your trust-centre updates, newest as you ordered them.
+    # Lists your trust-centre updates, newest as you ordered them.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(UpdateList, Integer, Hash)>] UpdateList data, response status code and response headers
+    def get_trust_updates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.get_trust_updates ...'
+      end
+      # resource path
+      local_var_path = '/v1/trust/updates'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UpdateList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.get_trust_updates",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#get_trust_updates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Writes one record into a section of YOUR organization's trust centre — profile, control, document, subprocessor, policy, faq, update or risk.
+    # Writes one record into a section of YOUR organization's trust centre — profile, control, document, subprocessor, policy, faq, update or risk.  A control written here is held to exactly the rule a control committed to the deployment's own inventory is held to, by the same validator: its prose may not claim a certificate and may not name a framework (a framework belongs in the mappings, where it arrives attached to a number), anything short of automated must say what is missing, and a mapping to a clause no framework declares is refused rather than scored as nothing.  A document defaults to GATED. An artifact an independent auditor signed — a SOC 2 report, an ISO certificate, a penetration test, an auditor letter — cannot be made public at all; it is released through a grant. A self-assessment can, because the organization is the one attesting it.  The deployment's OWN control inventory is governed in git and is not writable here: naming one of its ids is a conflict, not an overwrite.
+    # @param kind [String] Kind is the section being written. The URL is the authority.
+    # @param id [String] ID is the record&#39;s id. Omit it on a create and one is minted; the single-valued sections (profile, risk) hold one record whatever is named.
+    # @param section_write [SectionWrite] 
+    # @param [Hash] opts the optional parameters
+    # @return [Written]
+    def put_trust_by_kind_by_id(kind, id, section_write, opts = {})
+      data, _status_code, _headers = put_trust_by_kind_by_id_with_http_info(kind, id, section_write, opts)
+      data
+    end
+
+    # Writes one record into a section of YOUR organization&#39;s trust centre — profile, control, document, subprocessor, policy, faq, update or risk.
+    # Writes one record into a section of YOUR organization&#39;s trust centre — profile, control, document, subprocessor, policy, faq, update or risk.  A control written here is held to exactly the rule a control committed to the deployment&#39;s own inventory is held to, by the same validator: its prose may not claim a certificate and may not name a framework (a framework belongs in the mappings, where it arrives attached to a number), anything short of automated must say what is missing, and a mapping to a clause no framework declares is refused rather than scored as nothing.  A document defaults to GATED. An artifact an independent auditor signed — a SOC 2 report, an ISO certificate, a penetration test, an auditor letter — cannot be made public at all; it is released through a grant. A self-assessment can, because the organization is the one attesting it.  The deployment&#39;s OWN control inventory is governed in git and is not writable here: naming one of its ids is a conflict, not an overwrite.
+    # @param kind [String] Kind is the section being written. The URL is the authority.
+    # @param id [String] ID is the record&#39;s id. Omit it on a create and one is minted; the single-valued sections (profile, risk) hold one record whatever is named.
+    # @param section_write [SectionWrite] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Written, Integer, Hash)>] Written data, response status code and response headers
+    def put_trust_by_kind_by_id_with_http_info(kind, id, section_write, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TrustApi.put_trust_by_kind_by_id ...'
+      end
+      # verify the required parameter 'kind' is set
+      if @api_client.config.client_side_validation && kind.nil?
+        fail ArgumentError, "Missing the required parameter 'kind' when calling TrustApi.put_trust_by_kind_by_id"
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling TrustApi.put_trust_by_kind_by_id"
+      end
+      # verify the required parameter 'section_write' is set
+      if @api_client.config.client_side_validation && section_write.nil?
+        fail ArgumentError, "Missing the required parameter 'section_write' when calling TrustApi.put_trust_by_kind_by_id"
+      end
+      # resource path
+      local_var_path = '/v1/trust/{kind}/{id}'.sub('{' + 'kind' + '}', CGI.escape(kind.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(section_write)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Written'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"TrustApi.put_trust_by_kind_by_id",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TrustApi#put_trust_by_kind_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end