incident_io_api 1.0.0

data/lib/incident_io/api/catalog_v3_api.rb

@@ -0,0 +1,902 @@
+=begin
+#incident.io
+
+#Ruby client for the incident.io API.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'cgi'
+
+module IncidentIo
+  class CatalogV3Api
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # BulkUpdateEntries Catalog V3
+    # Update multiple catalog entries in a single operation. You can update up to 250 entries at once. This operation is atomic - either all entries are updated successfully, or none are updated.
+    # @param catalog_bulk_update_entries_payload_v3 [CatalogBulkUpdateEntriesPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def catalog_v3_bulk_update_entries(catalog_bulk_update_entries_payload_v3, opts = {})
+      catalog_v3_bulk_update_entries_with_http_info(catalog_bulk_update_entries_payload_v3, opts)
+      nil
+    end
+
+    # BulkUpdateEntries Catalog V3
+    # Update multiple catalog entries in a single operation. You can update up to 250 entries at once. This operation is atomic - either all entries are updated successfully, or none are updated.
+    # @param catalog_bulk_update_entries_payload_v3 [CatalogBulkUpdateEntriesPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def catalog_v3_bulk_update_entries_with_http_info(catalog_bulk_update_entries_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_bulk_update_entries ...'
+      end
+      # verify the required parameter 'catalog_bulk_update_entries_payload_v3' is set
+      if @api_client.config.client_side_validation && catalog_bulk_update_entries_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'catalog_bulk_update_entries_payload_v3' when calling CatalogV3Api.catalog_v3_bulk_update_entries"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_entries/actions/bulk_update'
+
+      # 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(catalog_bulk_update_entries_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_bulk_update_entries",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogV3Api#catalog_v3_bulk_update_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # CreateEntry Catalog V3
+    # Create an entry within the catalog. We support a maximum of 50,000 entries per type.  If you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.
+    # @param catalog_create_entry_payload_v3 [CatalogCreateEntryPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogCreateEntryResultV3]
+    def catalog_v3_create_entry(catalog_create_entry_payload_v3, opts = {})
+      data, _status_code, _headers = catalog_v3_create_entry_with_http_info(catalog_create_entry_payload_v3, opts)
+      data
+    end
+
+    # CreateEntry Catalog V3
+    # Create an entry within the catalog. We support a maximum of 50,000 entries per type.  If you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated.
+    # @param catalog_create_entry_payload_v3 [CatalogCreateEntryPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogCreateEntryResultV3, Integer, Hash)>] CatalogCreateEntryResultV3 data, response status code and response headers
+    def catalog_v3_create_entry_with_http_info(catalog_create_entry_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_create_entry ...'
+      end
+      # verify the required parameter 'catalog_create_entry_payload_v3' is set
+      if @api_client.config.client_side_validation && catalog_create_entry_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'catalog_create_entry_payload_v3' when calling CatalogV3Api.catalog_v3_create_entry"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_entries'
+
+      # 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(catalog_create_entry_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogCreateEntryResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_create_entry",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogV3Api#catalog_v3_create_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # CreateType Catalog V3
+    # Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
+    # @param catalog_create_type_payload_v3 [CatalogCreateTypePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogCreateTypeResultV3]
+    def catalog_v3_create_type(catalog_create_type_payload_v3, opts = {})
+      data, _status_code, _headers = catalog_v3_create_type_with_http_info(catalog_create_type_payload_v3, opts)
+      data
+    end
+
+    # CreateType Catalog V3
+    # Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
+    # @param catalog_create_type_payload_v3 [CatalogCreateTypePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogCreateTypeResultV3, Integer, Hash)>] CatalogCreateTypeResultV3 data, response status code and response headers
+    def catalog_v3_create_type_with_http_info(catalog_create_type_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_create_type ...'
+      end
+      # verify the required parameter 'catalog_create_type_payload_v3' is set
+      if @api_client.config.client_side_validation && catalog_create_type_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'catalog_create_type_payload_v3' when calling CatalogV3Api.catalog_v3_create_type"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_types'
+
+      # 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(catalog_create_type_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogCreateTypeResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_create_type",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogV3Api#catalog_v3_create_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # DestroyEntry Catalog V3
+    # Archives a catalog entry.
+    # @param id [String] ID of this catalog entry
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def catalog_v3_destroy_entry(id, opts = {})
+      catalog_v3_destroy_entry_with_http_info(id, opts)
+      nil
+    end
+
+    # DestroyEntry Catalog V3
+    # Archives a catalog entry.
+    # @param id [String] ID of this catalog entry
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def catalog_v3_destroy_entry_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_destroy_entry ...'
+      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 CatalogV3Api.catalog_v3_destroy_entry"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_entries/{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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_destroy_entry",
+        :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: CatalogV3Api#catalog_v3_destroy_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # DestroyType Catalog V3
+    # Archives a catalog type and associated entries.
+    # @param id [String] ID of this catalog type
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def catalog_v3_destroy_type(id, opts = {})
+      catalog_v3_destroy_type_with_http_info(id, opts)
+      nil
+    end
+
+    # DestroyType Catalog V3
+    # Archives a catalog type and associated entries.
+    # @param id [String] ID of this catalog type
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def catalog_v3_destroy_type_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_destroy_type ...'
+      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 CatalogV3Api.catalog_v3_destroy_type"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_types/{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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_destroy_type",
+        :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: CatalogV3Api#catalog_v3_destroy_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # ListEntries Catalog V3
+    # List entries for a catalog type.
+    # @param catalog_type_id [String] ID of this catalog type
+    # @param page_size [Integer] The integer number of records to return
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :after An record&#39;s ID. This endpoint will return a list of records after this ID in relation to the API response order.
+    # @option opts [String] :identifier If specified, only entries with this identifier will be returned. This will search by ID, external ID, and aliases.  If &#39;use name as identifier&#39; is enabled for the catalog type, this will also match on name.
+    # @return [CatalogListEntriesResultV3]
+    def catalog_v3_list_entries(catalog_type_id, page_size, opts = {})
+      data, _status_code, _headers = catalog_v3_list_entries_with_http_info(catalog_type_id, page_size, opts)
+      data
+    end
+
+    # ListEntries Catalog V3
+    # List entries for a catalog type.
+    # @param catalog_type_id [String] ID of this catalog type
+    # @param page_size [Integer] The integer number of records to return
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :after An record&#39;s ID. This endpoint will return a list of records after this ID in relation to the API response order.
+    # @option opts [String] :identifier If specified, only entries with this identifier will be returned. This will search by ID, external ID, and aliases.  If &#39;use name as identifier&#39; is enabled for the catalog type, this will also match on name.
+    # @return [Array<(CatalogListEntriesResultV3, Integer, Hash)>] CatalogListEntriesResultV3 data, response status code and response headers
+    def catalog_v3_list_entries_with_http_info(catalog_type_id, page_size, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_list_entries ...'
+      end
+      # verify the required parameter 'catalog_type_id' is set
+      if @api_client.config.client_side_validation && catalog_type_id.nil?
+        fail ArgumentError, "Missing the required parameter 'catalog_type_id' when calling CatalogV3Api.catalog_v3_list_entries"
+      end
+      # verify the required parameter 'page_size' is set
+      if @api_client.config.client_side_validation && page_size.nil?
+        fail ArgumentError, "Missing the required parameter 'page_size' when calling CatalogV3Api.catalog_v3_list_entries"
+      end
+      if @api_client.config.client_side_validation && page_size > 250
+        fail ArgumentError, 'invalid value for "page_size" when calling CatalogV3Api.catalog_v3_list_entries, must be smaller than or equal to 250.'
+      end
+
+      if @api_client.config.client_side_validation && page_size < 1
+        fail ArgumentError, 'invalid value for "page_size" when calling CatalogV3Api.catalog_v3_list_entries, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v3/catalog_entries'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'catalog_type_id'] = catalog_type_id
+      query_params[:'page_size'] = page_size
+      query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
+      query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].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] || 'CatalogListEntriesResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_list_entries",
+        :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: CatalogV3Api#catalog_v3_list_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # ListResources Catalog V3
+    # List available engine resources for the catalog.  A resource represents a type of data that can be held within the catalog, so this endpoint can be used to see what attribute types can be used when updating the schema of a catalog type. 
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogListResourcesResultV3]
+    def catalog_v3_list_resources(opts = {})
+      data, _status_code, _headers = catalog_v3_list_resources_with_http_info(opts)
+      data
+    end
+
+    # ListResources Catalog V3
+    # List available engine resources for the catalog.  A resource represents a type of data that can be held within the catalog, so this endpoint can be used to see what attribute types can be used when updating the schema of a catalog type. 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogListResourcesResultV3, Integer, Hash)>] CatalogListResourcesResultV3 data, response status code and response headers
+    def catalog_v3_list_resources_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_list_resources ...'
+      end
+      # resource path
+      local_var_path = '/v3/catalog_resources'
+
+      # 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] || 'CatalogListResourcesResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_list_resources",
+        :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: CatalogV3Api#catalog_v3_list_resources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # ListTypes Catalog V3
+    # List all catalog types for an organisation, including those synced from external resources.
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogListTypesResultV3]
+    def catalog_v3_list_types(opts = {})
+      data, _status_code, _headers = catalog_v3_list_types_with_http_info(opts)
+      data
+    end
+
+    # ListTypes Catalog V3
+    # List all catalog types for an organisation, including those synced from external resources.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogListTypesResultV3, Integer, Hash)>] CatalogListTypesResultV3 data, response status code and response headers
+    def catalog_v3_list_types_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_list_types ...'
+      end
+      # resource path
+      local_var_path = '/v3/catalog_types'
+
+      # 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] || 'CatalogListTypesResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_list_types",
+        :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: CatalogV3Api#catalog_v3_list_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # ShowEntry Catalog V3
+    # Show a single catalog entry.
+    # @param id [String] ID of this catalog entry
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :expand Whether to include details of all attribute links (forwards and backwards) within the response. Default behaviour (no query param) is to include only forward links. When expand is false, we only show attributes of the catalog entry itself.When expand is true, we show forward and backward links
+    # @return [CatalogShowEntryResultV3]
+    def catalog_v3_show_entry(id, opts = {})
+      data, _status_code, _headers = catalog_v3_show_entry_with_http_info(id, opts)
+      data
+    end
+
+    # ShowEntry Catalog V3
+    # Show a single catalog entry.
+    # @param id [String] ID of this catalog entry
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :expand Whether to include details of all attribute links (forwards and backwards) within the response. Default behaviour (no query param) is to include only forward links. When expand is false, we only show attributes of the catalog entry itself.When expand is true, we show forward and backward links
+    # @return [Array<(CatalogShowEntryResultV3, Integer, Hash)>] CatalogShowEntryResultV3 data, response status code and response headers
+    def catalog_v3_show_entry_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_show_entry ...'
+      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 CatalogV3Api.catalog_v3_show_entry"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_entries/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].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] || 'CatalogShowEntryResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_show_entry",
+        :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: CatalogV3Api#catalog_v3_show_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # ShowType Catalog V3
+    # Show a single catalog type.
+    # @param id [String] ID of this catalog type
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogShowTypeResultV3]
+    def catalog_v3_show_type(id, opts = {})
+      data, _status_code, _headers = catalog_v3_show_type_with_http_info(id, opts)
+      data
+    end
+
+    # ShowType Catalog V3
+    # Show a single catalog type.
+    # @param id [String] ID of this catalog type
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogShowTypeResultV3, Integer, Hash)>] CatalogShowTypeResultV3 data, response status code and response headers
+    def catalog_v3_show_type_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_show_type ...'
+      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 CatalogV3Api.catalog_v3_show_type"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_types/{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] || 'CatalogShowTypeResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_show_type",
+        :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: CatalogV3Api#catalog_v3_show_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # UpdateEntry Catalog V3
+    # Updates an existing catalog entry.
+    # @param id [String] ID of this catalog entry
+    # @param catalog_update_entry_payload_v3 [CatalogUpdateEntryPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogUpdateEntryResultV3]
+    def catalog_v3_update_entry(id, catalog_update_entry_payload_v3, opts = {})
+      data, _status_code, _headers = catalog_v3_update_entry_with_http_info(id, catalog_update_entry_payload_v3, opts)
+      data
+    end
+
+    # UpdateEntry Catalog V3
+    # Updates an existing catalog entry.
+    # @param id [String] ID of this catalog entry
+    # @param catalog_update_entry_payload_v3 [CatalogUpdateEntryPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogUpdateEntryResultV3, Integer, Hash)>] CatalogUpdateEntryResultV3 data, response status code and response headers
+    def catalog_v3_update_entry_with_http_info(id, catalog_update_entry_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_update_entry ...'
+      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 CatalogV3Api.catalog_v3_update_entry"
+      end
+      # verify the required parameter 'catalog_update_entry_payload_v3' is set
+      if @api_client.config.client_side_validation && catalog_update_entry_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'catalog_update_entry_payload_v3' when calling CatalogV3Api.catalog_v3_update_entry"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_entries/{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']
+      # 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(catalog_update_entry_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogUpdateEntryResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_update_entry",
+        :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: CatalogV3Api#catalog_v3_update_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # UpdateType Catalog V3
+    # Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
+    # @param id [String] ID of this catalog type
+    # @param catalog_update_type_payload_v3 [CatalogUpdateTypePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogUpdateTypeResultV3]
+    def catalog_v3_update_type(id, catalog_update_type_payload_v3, opts = {})
+      data, _status_code, _headers = catalog_v3_update_type_with_http_info(id, catalog_update_type_payload_v3, opts)
+      data
+    end
+
+    # UpdateType Catalog V3
+    # Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint.
+    # @param id [String] ID of this catalog type
+    # @param catalog_update_type_payload_v3 [CatalogUpdateTypePayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogUpdateTypeResultV3, Integer, Hash)>] CatalogUpdateTypeResultV3 data, response status code and response headers
+    def catalog_v3_update_type_with_http_info(id, catalog_update_type_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_update_type ...'
+      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 CatalogV3Api.catalog_v3_update_type"
+      end
+      # verify the required parameter 'catalog_update_type_payload_v3' is set
+      if @api_client.config.client_side_validation && catalog_update_type_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'catalog_update_type_payload_v3' when calling CatalogV3Api.catalog_v3_update_type"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_types/{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']
+      # 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(catalog_update_type_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogUpdateTypeResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_update_type",
+        :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: CatalogV3Api#catalog_v3_update_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # UpdateTypeSchema Catalog V3
+    # Update an existing catalog types schema, adding or removing attributes.  Updating the schema is handled separately from creating and updating types, so that you don't have to worry about dependencies between types. For example, if type A has an attribute that relies on type B, you would have to create type B first.  By allowing the creation of types without a schema, they can be created in any order, but it means that you need to make a separate call to this endpoint to update the schema.
+    # @param id [String] ID of this catalog type
+    # @param catalog_update_type_schema_payload_v3 [CatalogUpdateTypeSchemaPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [CatalogUpdateTypeSchemaResultV3]
+    def catalog_v3_update_type_schema(id, catalog_update_type_schema_payload_v3, opts = {})
+      data, _status_code, _headers = catalog_v3_update_type_schema_with_http_info(id, catalog_update_type_schema_payload_v3, opts)
+      data
+    end
+
+    # UpdateTypeSchema Catalog V3
+    # Update an existing catalog types schema, adding or removing attributes.  Updating the schema is handled separately from creating and updating types, so that you don&#39;t have to worry about dependencies between types. For example, if type A has an attribute that relies on type B, you would have to create type B first.  By allowing the creation of types without a schema, they can be created in any order, but it means that you need to make a separate call to this endpoint to update the schema.
+    # @param id [String] ID of this catalog type
+    # @param catalog_update_type_schema_payload_v3 [CatalogUpdateTypeSchemaPayloadV3] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CatalogUpdateTypeSchemaResultV3, Integer, Hash)>] CatalogUpdateTypeSchemaResultV3 data, response status code and response headers
+    def catalog_v3_update_type_schema_with_http_info(id, catalog_update_type_schema_payload_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CatalogV3Api.catalog_v3_update_type_schema ...'
+      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 CatalogV3Api.catalog_v3_update_type_schema"
+      end
+      # verify the required parameter 'catalog_update_type_schema_payload_v3' is set
+      if @api_client.config.client_side_validation && catalog_update_type_schema_payload_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'catalog_update_type_schema_payload_v3' when calling CatalogV3Api.catalog_v3_update_type_schema"
+      end
+      # resource path
+      local_var_path = '/v3/catalog_types/{id}/actions/update_schema'.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(catalog_update_type_schema_payload_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CatalogUpdateTypeSchemaResultV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"CatalogV3Api.catalog_v3_update_type_schema",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CatalogV3Api#catalog_v3_update_type_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end