class Hubspot::Cms::Hubdb::RowsApi
Attributes
Public Class Methods
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 21 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Clone a row Clones a single row in the `draft` version of the table. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [HubDbTableRowV3]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 30 def clone_draft_table_row(row_id, table_id_or_name, opts = {}) data, _status_code, _headers = clone_draft_table_row_with_http_info(row_id, table_id_or_name, opts) data end
Clone a row Clones a single row in the `draft` version of the table. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [Array<(HubDbTableRowV3
, Integer, Hash)>] HubDbTableRowV3
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 41 def clone_draft_table_row_with_http_info(row_id, table_id_or_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.clone_draft_table_row ...' end # verify the required parameter 'row_id' is set if @api_client.config.client_side_validation && row_id.nil? fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.clone_draft_table_row" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && row_id !~ pattern fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.clone_draft_table_row, must conform to the pattern #{pattern}." end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.clone_draft_table_row" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone'.sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s)).sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.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', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'HubDbTableRowV3' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#clone_draft_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Add a new row to a table Add a new row to a HubDB table. New rows will be added to the `draft` version of the table. Use `push-live` endpoint to push these changes to live version and publish them. @param table_id_or_name [String] The ID or name of the target table. @param hub_db_table_row_v3_input [HubDbTableRowV3Input] The row definition JSON, formatted as described above. @param [Hash] opts the optional parameters @return [HubDbTableRowV3]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 103 def create_table_row(table_id_or_name, hub_db_table_row_v3_input, opts = {}) data, _status_code, _headers = create_table_row_with_http_info(table_id_or_name, hub_db_table_row_v3_input, opts) data end
Add a new row to a table Add a new row to a HubDB table. New rows will be added to the `draft` version of the table. Use `push-live` endpoint to push these changes to live version and publish them. @param table_id_or_name [String] The ID or name of the target table. @param hub_db_table_row_v3_input [HubDbTableRowV3Input] The row definition JSON, formatted as described above. @param [Hash] opts the optional parameters @return [Array<(HubDbTableRowV3
, Integer, Hash)>] HubDbTableRowV3
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 114 def create_table_row_with_http_info(table_id_or_name, hub_db_table_row_v3_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.create_table_row ...' end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.create_table_row" end # verify the required parameter 'hub_db_table_row_v3_input' is set if @api_client.config.client_side_validation && hub_db_table_row_v3_input.nil? fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_input' when calling RowsApi.create_table_row" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.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', '*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(hub_db_table_row_v3_input) # return_type return_type = opts[:return_type] || 'HubDbTableRowV3' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#create_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a row from the draft table Get a single row by ID from a table's `draft` version. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [HubDbTableRowV3]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 173 def get_draft_table_row_by_id(row_id, table_id_or_name, opts = {}) data, _status_code, _headers = get_draft_table_row_by_id_with_http_info(row_id, table_id_or_name, opts) data end
Get a row from the draft table Get a single row by ID from a table's `draft` version. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [Array<(HubDbTableRowV3
, Integer, Hash)>] HubDbTableRowV3
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 184 def get_draft_table_row_by_id_with_http_info(row_id, table_id_or_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.get_draft_table_row_by_id ...' end # verify the required parameter 'row_id' is set if @api_client.config.client_side_validation && row_id.nil? fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.get_draft_table_row_by_id" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && row_id !~ pattern fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.get_draft_table_row_by_id, must conform to the pattern #{pattern}." end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.get_draft_table_row_by_id" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s)).sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.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', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'HubDbTableRowV3' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#get_draft_table_row_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a table row Get a single row by ID from a table's `live` version. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [HubDbTableRowV3]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 246 def get_table_row(row_id, table_id_or_name, opts = {}) data, _status_code, _headers = get_table_row_with_http_info(row_id, table_id_or_name, opts) data end
Get a table row Get a single row by ID from a table's `live` version. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [Array<(HubDbTableRowV3
, Integer, Hash)>] HubDbTableRowV3
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 257 def get_table_row_with_http_info(row_id, table_id_or_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.get_table_row ...' end # verify the required parameter 'row_id' is set if @api_client.config.client_side_validation && row_id.nil? fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.get_table_row" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && row_id !~ pattern fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.get_table_row, must conform to the pattern #{pattern}." end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.get_table_row" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}'.sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s)).sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.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', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'HubDbTableRowV3' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#get_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get rows for a table Returns a set of rows in the `live` version of the specified table. Row results can be filtered and sorted. Refer to the overview section for detailed filtering and sorting options. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access. @param table_id_or_name [String] The ID or name of the table to query. @param [Hash] opts the optional parameters @option opts [Array<String>] :properties Specify the column names to get results containing only the required columns instead of all column details. @option opts [String] :after The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. @option opts [Integer] :limit The maximum number of results to return. Default is `1000`. @option opts [Array<String>] :sort Specifies the column names to sort the results by. See the above description for more details. @return [CollectionResponseWithTotalHubDbTableRowV3ForwardPaging]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 322 def get_table_rows(table_id_or_name, opts = {}) data, _status_code, _headers = get_table_rows_with_http_info(table_id_or_name, opts) data end
Get rows for a table Returns a set of rows in the `live` version of the specified table. Row results can be filtered and sorted. Refer to the overview section for detailed filtering and sorting options. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access. @param table_id_or_name [String] The ID or name of the table to query. @param [Hash] opts the optional parameters @option opts [Array<String>] :properties Specify the column names to get results containing only the required columns instead of all column details. @option opts [String] :after The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. @option opts [Integer] :limit The maximum number of results to return. Default is `1000`. @option opts [Array<String>] :sort Specifies the column names to sort the results by. See the above description for more details. @return [Array<(CollectionResponseWithTotalHubDbTableRowV3ForwardPaging
, Integer, Hash)>] CollectionResponseWithTotalHubDbTableRowV3ForwardPaging
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 336 def get_table_rows_with_http_info(table_id_or_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.get_table_rows ...' end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.get_table_rows" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil? query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CollectionResponseWithTotalHubDbTableRowV3ForwardPaging' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#get_table_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Permanently deletes a row Permanently deletes a row from a table's `draft` version. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [nil]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 393 def purge_draft_table_row(row_id, table_id_or_name, opts = {}) purge_draft_table_row_with_http_info(row_id, table_id_or_name, opts) nil end
Permanently deletes a row Permanently deletes a row from a table's `draft` version. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 404 def purge_draft_table_row_with_http_info(row_id, table_id_or_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.purge_draft_table_row ...' end # verify the required parameter 'row_id' is set if @api_client.config.client_side_validation && row_id.nil? fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.purge_draft_table_row" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && row_id !~ pattern fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.purge_draft_table_row, must conform to the pattern #{pattern}." end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.purge_draft_table_row" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s)).sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.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(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#purge_draft_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get rows from draft table Returns rows in the `draft` version of the specified table. Row results can be filtered and sorted using the options mentioned in the overview section. @param table_id_or_name [String] The ID or name of the table to query. @param [Hash] opts the optional parameters @option opts [String] :after The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. @option opts [Array<String>] :properties Specify the column names to get results containing only the required columns instead of all column details. If you want to include multiple columns in the result, use this query param as many times. @option opts [Integer] :limit The maximum number of results to return. Default is `1000`. @option opts [Array<String>] :sort Specifies the column names to sort the results by. @return [CollectionResponseWithTotalHubDbTableRowV3ForwardPaging]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 469 def read_draft_table_rows(table_id_or_name, opts = {}) data, _status_code, _headers = read_draft_table_rows_with_http_info(table_id_or_name, opts) data end
Get rows from draft table Returns rows in the `draft` version of the specified table. Row results can be filtered and sorted using the options mentioned in the overview section. @param table_id_or_name [String] The ID or name of the table to query. @param [Hash] opts the optional parameters @option opts [String] :after The cursor token value to get the next set of results. You can get this from the `paging.next.after` JSON property of a paged response containing more results. @option opts [Array<String>] :properties Specify the column names to get results containing only the required columns instead of all column details. If you want to include multiple columns in the result, use this query param as many times. @option opts [Integer] :limit The maximum number of results to return. Default is `1000`. @option opts [Array<String>] :sort Specifies the column names to sort the results by. @return [Array<(CollectionResponseWithTotalHubDbTableRowV3ForwardPaging
, Integer, Hash)>] CollectionResponseWithTotalHubDbTableRowV3ForwardPaging
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 483 def read_draft_table_rows_with_http_info(table_id_or_name, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.read_draft_table_rows ...' end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.read_draft_table_rows" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil? query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'CollectionResponseWithTotalHubDbTableRowV3ForwardPaging' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#read_draft_table_rows\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Replaces an existing row Replace a single row in the table's `draft` version. All the column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted. See the `Create a row` endpoint for instructions on how to format the JSON row definitions. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param hub_db_table_row_v3_input [HubDbTableRowV3Input] The JSON object of the row @param [Hash] opts the optional parameters @return [HubDbTableRowV3]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 541 def replace_draft_table_row(row_id, table_id_or_name, hub_db_table_row_v3_input, opts = {}) data, _status_code, _headers = replace_draft_table_row_with_http_info(row_id, table_id_or_name, hub_db_table_row_v3_input, opts) data end
Replaces an existing row Replace a single row in the table's `draft` version. All the column values must be specified. If a column has a value in the target table and this request doesn't define that value, it will be deleted. See the `Create a row` endpoint for instructions on how to format the JSON row definitions. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param hub_db_table_row_v3_input [HubDbTableRowV3Input] The JSON object of the row @param [Hash] opts the optional parameters @return [Array<(HubDbTableRowV3
, Integer, Hash)>] HubDbTableRowV3
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 553 def replace_draft_table_row_with_http_info(row_id, table_id_or_name, hub_db_table_row_v3_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.replace_draft_table_row ...' end # verify the required parameter 'row_id' is set if @api_client.config.client_side_validation && row_id.nil? fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.replace_draft_table_row" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && row_id !~ pattern fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.replace_draft_table_row, must conform to the pattern #{pattern}." end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.replace_draft_table_row" end # verify the required parameter 'hub_db_table_row_v3_input' is set if @api_client.config.client_side_validation && hub_db_table_row_v3_input.nil? fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_input' when calling RowsApi.replace_draft_table_row" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s)).sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.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', '*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(hub_db_table_row_v3_input) # return_type return_type = opts[:return_type] || 'HubDbTableRowV3' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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: RowsApi#replace_draft_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Updates an existing row Sparse updates a single row in the table's `draft` version. All the column values need not be specified. Only the columns or fields that needs to be modified can be specified. See the `Create a row` endpoint for instructions on how to format the JSON row definitions. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param hub_db_table_row_v3_input [HubDbTableRowV3Input] The JSON object of the row with necessary fields that needs to be updated. @param [Hash] opts the optional parameters @return [HubDbTableRowV3]
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 622 def update_draft_table_row(row_id, table_id_or_name, hub_db_table_row_v3_input, opts = {}) data, _status_code, _headers = update_draft_table_row_with_http_info(row_id, table_id_or_name, hub_db_table_row_v3_input, opts) data end
Updates an existing row Sparse updates a single row in the table's `draft` version. All the column values need not be specified. Only the columns or fields that needs to be modified can be specified. See the `Create a row` endpoint for instructions on how to format the JSON row definitions. @param row_id [String] The ID of the row @param table_id_or_name [String] The ID or name of the table @param hub_db_table_row_v3_input [HubDbTableRowV3Input] The JSON object of the row with necessary fields that needs to be updated. @param [Hash] opts the optional parameters @return [Array<(HubDbTableRowV3
, Integer, Hash)>] HubDbTableRowV3
data, response status code and response headers
# File lib/hubspot/codegen/cms/hubdb/api/rows_api.rb, line 634 def update_draft_table_row_with_http_info(row_id, table_id_or_name, hub_db_table_row_v3_input, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: RowsApi.update_draft_table_row ...' end # verify the required parameter 'row_id' is set if @api_client.config.client_side_validation && row_id.nil? fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.update_draft_table_row" end pattern = Regexp.new(/\d+/) if @api_client.config.client_side_validation && row_id !~ pattern fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.update_draft_table_row, must conform to the pattern #{pattern}." end # verify the required parameter 'table_id_or_name' is set if @api_client.config.client_side_validation && table_id_or_name.nil? fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.update_draft_table_row" end # verify the required parameter 'hub_db_table_row_v3_input' is set if @api_client.config.client_side_validation && hub_db_table_row_v3_input.nil? fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_input' when calling RowsApi.update_draft_table_row" end # resource path local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s)).sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.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', '*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(hub_db_table_row_v3_input) # return_type return_type = opts[:return_type] || 'HubDbTableRowV3' # auth_names auth_names = opts[:auth_names] || ['hapikey', 'oauth2'] new_options = opts.merge( :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(:PATCH, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: RowsApi#update_draft_table_row\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end