hubspot-api-client 10.1.1 → 11.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/Gemfile.lock +2 -2
- data/lib/hubspot/codegen/cms/audit-logs/api/{default_api.rb → audit_logs_api.rb} +3 -3
- data/lib/hubspot/codegen/cms/blogs/authors/api/{default_api.rb → author_api.rb} +28 -28
- data/lib/hubspot/codegen/cms/blogs/blog-posts/api/{default_api.rb → blog_post_api.rb} +62 -62
- data/lib/hubspot/codegen/cms/blogs/tags/api/{default_api.rb → tag_api.rb} +28 -28
- data/lib/hubspot/codegen/cms/domains/api/domains_api.rb +2 -2
- data/lib/hubspot/codegen/cms/domains/configuration.rb +0 -7
- data/lib/hubspot/codegen/cms/hubdb/api/rows_api.rb +102 -102
- data/lib/hubspot/codegen/cms/hubdb/api/rows_batch_api.rb +21 -21
- data/lib/hubspot/codegen/cms/hubdb/api/tables_api.rb +100 -108
- data/lib/hubspot/codegen/cms/hubdb/api_client.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/api_error.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/configuration.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/{batch_input_hub_db_table_row_v3.rb → batch_input_hub_db_table_row_v3_request.rb} +5 -5
- data/lib/hubspot/codegen/cms/hubdb/models/batch_input_json_node.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/batch_input_string.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/batch_response_hub_db_table_row_v3_with_errors.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/collection_response_with_total_hub_db_table_row_v3_forward_paging.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/collection_response_with_total_hub_db_table_v3_forward_paging.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/column.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/{column_input.rb → column_request.rb} +71 -47
- data/lib/hubspot/codegen/cms/hubdb/models/error.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/error_detail.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/foreign_id.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/forward_paging.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/hub_db_table_clone_request.rb +4 -9
- data/lib/hubspot/codegen/cms/hubdb/models/hub_db_table_row_v3.rb +12 -27
- data/lib/hubspot/codegen/cms/hubdb/models/{hub_db_table_row_v3_input.rb → hub_db_table_row_v3_request.rb} +25 -20
- data/lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/{hub_db_table_v3_input.rb → hub_db_table_v3_request.rb} +53 -53
- data/lib/hubspot/codegen/cms/hubdb/models/import_result.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/next_page.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/option.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/simple_user.rb +1 -1
- data/lib/hubspot/codegen/cms/hubdb/models/standard_error.rb +1 -1
- data/lib/hubspot/codegen/cms/performance/api/{default_api.rb → public_performance_api.rb} +5 -5
- data/lib/hubspot/codegen/cms/site-search/api/{default_api.rb → public_api.rb} +7 -7
- data/lib/hubspot/codegen/cms/site-search/models/search_hit_field.rb +15 -15
- data/lib/hubspot/codegen/crm/companies/api/batch_api.rb +0 -8
- data/lib/hubspot/codegen/crm/companies/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/companies/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/contacts/api/batch_api.rb +0 -8
- data/lib/hubspot/codegen/crm/contacts/api/gdpr_api.rb +150 -0
- data/lib/hubspot/codegen/crm/contacts/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/contacts/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/deals/api/batch_api.rb +0 -8
- data/lib/hubspot/codegen/crm/deals/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/deals/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/imports/api/core_api.rb +2 -2
- data/lib/hubspot/codegen/crm/imports/api/{default_api.rb → public_imports_api.rb} +8 -8
- data/lib/hubspot/codegen/crm/imports/models/public_import_error.rb +4 -4
- data/lib/hubspot/codegen/crm/line_items/api/batch_api.rb +0 -8
- data/lib/hubspot/codegen/crm/line_items/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/line_items/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/objects/api/batch_api.rb +0 -8
- data/lib/hubspot/codegen/crm/objects/api/gdpr_api.rb +162 -0
- data/lib/hubspot/codegen/crm/objects/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/objects/feedback_submissions/api/batch_api.rb +0 -2
- data/lib/hubspot/codegen/crm/objects/feedback_submissions/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/objects/feedback_submissions/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/objects/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/owners/api/{default_api.rb → owners_api.rb} +6 -6
- data/lib/hubspot/codegen/crm/products/api/batch_api.rb +0 -8
- data/lib/hubspot/codegen/crm/products/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/products/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/quotes/api/batch_api.rb +0 -2
- data/lib/hubspot/codegen/crm/quotes/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/quotes/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/schemas/api/core_api.rb +3 -3
- data/lib/hubspot/codegen/crm/schemas/api/{default_api.rb → public_object_schemas_api.rb} +4 -4
- data/lib/hubspot/codegen/crm/tickets/api/batch_api.rb +0 -8
- data/lib/hubspot/codegen/crm/tickets/api/search_api.rb +0 -4
- data/lib/hubspot/codegen/crm/tickets/models/filter.rb +3 -2
- data/lib/hubspot/codegen/crm/timeline/api/templates_api.rb +3 -3
- data/lib/hubspot/codegen/crm/timeline/models/{collection_response_timeline_event_template.rb → collection_response_timeline_event_template_no_paging.rb} +7 -17
- data/lib/hubspot/codegen/files/files/api/files_api.rb +12 -6
- data/lib/hubspot/codegen/files/files/api/folders_api.rb +12 -0
- data/lib/hubspot/codegen/files/files/models/error_category.rb +18 -18
- data/lib/hubspot/codegen/marketing/transactional/api/{default_api.rb → public_smtp_tokens_api.rb} +14 -74
- data/lib/hubspot/codegen/marketing/transactional/api/single_send_api.rb +86 -0
- data/lib/hubspot/codegen/oauth/api/access_tokens_api.rb +82 -0
- data/lib/hubspot/codegen/oauth/api/refresh_tokens_api.rb +140 -0
- data/lib/hubspot/codegen/oauth/api/tokens_api.rb +100 -0
- data/lib/hubspot/codegen/oauth/models/access_token_info_response.rb +33 -1
- data/lib/hubspot/codegen/oauth/models/token_response_if.rb +27 -4
- data/lib/hubspot/version.rb +1 -1
- data/pkg/hubspot-api-client-10.1.1.gem +0 -0
- data/spec/codegen/cms/audit-logs/api/{default_api_spec.rb → audit_logs_api_spec.rb} +6 -6
- data/spec/codegen/cms/blogs/authors/api/{default_api_spec.rb → author_api_spec.rb} +6 -6
- data/spec/codegen/cms/blogs/blog-posts/api/{default_api_spec.rb → blog_post_api_spec.rb} +6 -6
- data/spec/codegen/cms/blogs/tags/api/{default_api_spec.rb → tag_api_spec.rb} +6 -6
- data/spec/codegen/cms/hubdb/api/rows_api_spec.rb +18 -18
- data/spec/codegen/cms/hubdb/api/rows_batch_api_spec.rb +4 -4
- data/spec/codegen/cms/hubdb/api/tables_api_spec.rb +35 -36
- data/spec/codegen/cms/hubdb/models/{batch_input_hub_db_table_row_v3_spec.rb → batch_input_hub_db_table_row_v3_request_spec.rb} +7 -7
- data/spec/codegen/cms/hubdb/models/batch_input_json_node_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/batch_input_string_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/batch_response_hub_db_table_row_v3_with_errors_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/collection_response_with_total_hub_db_table_row_v3_forward_paging_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/collection_response_with_total_hub_db_table_v3_forward_paging_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/{column_input_spec.rb → column_request_spec.rb} +14 -22
- data/spec/codegen/cms/hubdb/models/column_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/error_detail_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/error_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/foreign_id_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/forward_paging_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/hub_db_table_clone_request_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/{hub_db_table_row_v3_input_spec.rb → hub_db_table_row_v3_request_spec.rb} +10 -10
- data/spec/codegen/cms/hubdb/models/hub_db_table_row_v3_spec.rb +7 -1
- data/spec/codegen/cms/hubdb/models/{hub_db_table_v3_input_spec.rb → hub_db_table_v3_request_spec.rb} +13 -13
- data/spec/codegen/cms/hubdb/models/hub_db_table_v3_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/import_result_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/next_page_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/option_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/simple_user_spec.rb +1 -1
- data/spec/codegen/cms/hubdb/models/standard_error_spec.rb +1 -1
- data/spec/codegen/cms/performance/api/{default_api_spec.rb → public_performance_api_spec.rb} +6 -6
- data/spec/codegen/cms/site-search/api/{default_api_spec.rb → public_api_spec.rb} +6 -6
- data/spec/codegen/cms/site-search/models/search_hit_field_spec.rb +2 -2
- data/spec/codegen/crm/companies/api/batch_api_spec.rb +0 -4
- data/spec/codegen/crm/companies/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/companies/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/contacts/api/batch_api_spec.rb +0 -4
- data/spec/codegen/crm/contacts/api/gdpr_api_spec.rb +59 -0
- data/spec/codegen/crm/contacts/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/contacts/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/deals/api/batch_api_spec.rb +0 -4
- data/spec/codegen/crm/deals/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/deals/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/imports/api/{default_api_spec.rb → public_imports_api_spec.rb} +8 -8
- data/spec/codegen/crm/imports/models/public_import_error_spec.rb +2 -2
- data/spec/codegen/crm/line_items/api/batch_api_spec.rb +0 -4
- data/spec/codegen/crm/line_items/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/line_items/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/objects/api/batch_api_spec.rb +0 -4
- data/spec/codegen/crm/objects/api/gdpr_api_spec.rb +61 -0
- data/spec/codegen/crm/objects/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/objects/feedback_submissions/api/batch_api_spec.rb +0 -1
- data/spec/codegen/crm/objects/feedback_submissions/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/objects/feedback_submissions/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/objects/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/owners/api/{default_api_spec.rb → owners_api_spec.rb} +6 -6
- data/spec/codegen/crm/products/api/batch_api_spec.rb +0 -4
- data/spec/codegen/crm/products/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/products/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/quotes/api/batch_api_spec.rb +0 -1
- data/spec/codegen/crm/quotes/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/quotes/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/schemas/api/{default_api_spec.rb → public_object_schemas_api_spec.rb} +6 -6
- data/spec/codegen/crm/tickets/api/batch_api_spec.rb +0 -4
- data/spec/codegen/crm/tickets/api/search_api_spec.rb +0 -2
- data/spec/codegen/crm/tickets/models/filter_spec.rb +1 -1
- data/spec/codegen/crm/timeline/api/templates_api_spec.rb +1 -1
- data/spec/codegen/crm/timeline/models/{collection_response_timeline_event_template_spec.rb → collection_response_timeline_event_template_no_paging_spec.rb} +6 -12
- data/spec/codegen/files/files/api/files_api_spec.rb +4 -2
- data/spec/codegen/files/files/api/folders_api_spec.rb +4 -0
- data/spec/codegen/files/files/models/error_category_spec.rb +6 -6
- data/spec/codegen/marketing/transactional/api/{default_api_spec.rb → public_smtp_tokens_api_spec.rb} +6 -18
- data/spec/codegen/marketing/transactional/api/single_send_api_spec.rb +47 -0
- data/spec/codegen/oauth/api/access_tokens_api_spec.rb +45 -0
- data/spec/codegen/oauth/api/{default_api_spec.rb → refresh_tokens_api_spec.rb} +6 -31
- data/spec/codegen/oauth/api/tokens_api_spec.rb +50 -0
- data/spec/codegen/oauth/models/access_token_info_response_spec.rb +12 -0
- data/spec/codegen/oauth/models/token_response_if_spec.rb +12 -0
- data/spec/features/cms/audit-logs/{default_api_spec.rb → audit_logs_api_spec.rb} +4 -4
- data/spec/features/cms/blogs/authors/{default_api_spec.rb → author_api_spec.rb} +28 -28
- data/spec/features/cms/blogs/blog-posts/{default_api_spec.rb → blog_post_api_spec.rb} +2 -2
- data/spec/features/cms/blogs/tags/{default_api_spec.rb → tag_api_spec.rb} +2 -2
- data/spec/features/cms/hubdb/tables_api_spec.rb +1 -1
- data/spec/features/cms/perfomance/public_perfomance_api_spec.rb +8 -0
- data/spec/features/cms/site-search/{default_api_spec.rb → public_api_spec.rb} +2 -2
- data/spec/features/crm/contacts/gdpr_api_spec.rb +8 -0
- data/spec/features/crm/objects/gdpr_api_spec.rb +8 -0
- data/spec/features/crm/owners/{default_api_spec.rb → owners_api_spec.rb} +2 -2
- data/spec/features/crm/schemas/public_object_schemas_api_spec.rb +7 -0
- data/spec/features/marketing/transactional/{default_api_spec.rb → public_smtp_tokens_api_spec.rb} +2 -3
- data/spec/features/marketing/transactional/single_send_api_spec.rb +7 -0
- data/spec/features/oauth/access_tokens_api_spec.rb +7 -0
- data/spec/features/oauth/refresh_tokens_api_spec.rb +8 -0
- data/spec/features/oauth/tokens_api_spec.rb +7 -0
- metadata +96 -82
- data/lib/hubspot/codegen/cms/hubdb/models/hub_db_table_v3_live_input.rb +0 -241
- data/lib/hubspot/codegen/crm/timeline/models/next_page.rb +0 -224
- data/lib/hubspot/codegen/crm/timeline/models/paging.rb +0 -219
- data/lib/hubspot/codegen/crm/timeline/models/previous_page.rb +0 -224
- data/lib/hubspot/codegen/oauth/api/default_api.rb +0 -270
- data/spec/codegen/cms/hubdb/models/hub_db_table_v3_live_input_spec.rb +0 -59
- data/spec/codegen/crm/timeline/models/next_page_spec.rb +0 -47
- data/spec/codegen/crm/timeline/models/paging_spec.rb +0 -47
- data/spec/codegen/crm/timeline/models/previous_page_spec.rb +0 -47
- data/spec/features/cms/perfomance/default_api_spec.rb +0 -8
- data/spec/features/crm/schemas/default_api_spec.rb +0 -7
- data/spec/features/oauth/default_api_spec.rb +0 -10
@@ -16,7 +16,7 @@ module Hubspot
|
|
16
16
|
module Cms
|
17
17
|
module Blogs
|
18
18
|
module Tags
|
19
|
-
class
|
19
|
+
class TagApi
|
20
20
|
attr_accessor :api_client
|
21
21
|
|
22
22
|
def initialize(api_client = ApiClient.default)
|
@@ -41,11 +41,11 @@ module Hubspot
|
|
41
41
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
42
42
|
def archive_with_http_info(object_id, opts = {})
|
43
43
|
if @api_client.config.debugging
|
44
|
-
@api_client.config.logger.debug 'Calling API:
|
44
|
+
@api_client.config.logger.debug 'Calling API: TagApi.archive ...'
|
45
45
|
end
|
46
46
|
# verify the required parameter 'object_id' is set
|
47
47
|
if @api_client.config.client_side_validation && object_id.nil?
|
48
|
-
fail ArgumentError, "Missing the required parameter 'object_id' when calling
|
48
|
+
fail ArgumentError, "Missing the required parameter 'object_id' when calling TagApi.archive"
|
49
49
|
end
|
50
50
|
# resource path
|
51
51
|
local_var_path = '/cms/v3/blogs/tags/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))
|
@@ -82,7 +82,7 @@ module Hubspot
|
|
82
82
|
|
83
83
|
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
84
84
|
if @api_client.config.debugging
|
85
|
-
@api_client.config.logger.debug "API called:
|
85
|
+
@api_client.config.logger.debug "API called: TagApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
86
86
|
end
|
87
87
|
return data, status_code, headers
|
88
88
|
end
|
@@ -104,11 +104,11 @@ module Hubspot
|
|
104
104
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
105
105
|
def archive_batch_with_http_info(batch_input_string, opts = {})
|
106
106
|
if @api_client.config.debugging
|
107
|
-
@api_client.config.logger.debug 'Calling API:
|
107
|
+
@api_client.config.logger.debug 'Calling API: TagApi.archive_batch ...'
|
108
108
|
end
|
109
109
|
# verify the required parameter 'batch_input_string' is set
|
110
110
|
if @api_client.config.client_side_validation && batch_input_string.nil?
|
111
|
-
fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling
|
111
|
+
fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling TagApi.archive_batch"
|
112
112
|
end
|
113
113
|
# resource path
|
114
114
|
local_var_path = '/cms/v3/blogs/tags/batch/archive'
|
@@ -146,7 +146,7 @@ module Hubspot
|
|
146
146
|
|
147
147
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
148
148
|
if @api_client.config.debugging
|
149
|
-
@api_client.config.logger.debug "API called:
|
149
|
+
@api_client.config.logger.debug "API called: TagApi#archive_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
150
150
|
end
|
151
151
|
return data, status_code, headers
|
152
152
|
end
|
@@ -168,11 +168,11 @@ module Hubspot
|
|
168
168
|
# @return [Array<(Tag, Integer, Hash)>] Tag data, response status code and response headers
|
169
169
|
def create_with_http_info(tag, opts = {})
|
170
170
|
if @api_client.config.debugging
|
171
|
-
@api_client.config.logger.debug 'Calling API:
|
171
|
+
@api_client.config.logger.debug 'Calling API: TagApi.create ...'
|
172
172
|
end
|
173
173
|
# verify the required parameter 'tag' is set
|
174
174
|
if @api_client.config.client_side_validation && tag.nil?
|
175
|
-
fail ArgumentError, "Missing the required parameter 'tag' when calling
|
175
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling TagApi.create"
|
176
176
|
end
|
177
177
|
# resource path
|
178
178
|
local_var_path = '/cms/v3/blogs/tags'
|
@@ -210,7 +210,7 @@ module Hubspot
|
|
210
210
|
|
211
211
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
212
212
|
if @api_client.config.debugging
|
213
|
-
@api_client.config.logger.debug "API called:
|
213
|
+
@api_client.config.logger.debug "API called: TagApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
214
214
|
end
|
215
215
|
return data, status_code, headers
|
216
216
|
end
|
@@ -232,11 +232,11 @@ module Hubspot
|
|
232
232
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
233
233
|
def create_batch_with_http_info(batch_input_tag, opts = {})
|
234
234
|
if @api_client.config.debugging
|
235
|
-
@api_client.config.logger.debug 'Calling API:
|
235
|
+
@api_client.config.logger.debug 'Calling API: TagApi.create_batch ...'
|
236
236
|
end
|
237
237
|
# verify the required parameter 'batch_input_tag' is set
|
238
238
|
if @api_client.config.client_side_validation && batch_input_tag.nil?
|
239
|
-
fail ArgumentError, "Missing the required parameter 'batch_input_tag' when calling
|
239
|
+
fail ArgumentError, "Missing the required parameter 'batch_input_tag' when calling TagApi.create_batch"
|
240
240
|
end
|
241
241
|
# resource path
|
242
242
|
local_var_path = '/cms/v3/blogs/tags/batch/create'
|
@@ -274,7 +274,7 @@ module Hubspot
|
|
274
274
|
|
275
275
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
276
276
|
if @api_client.config.debugging
|
277
|
-
@api_client.config.logger.debug "API called:
|
277
|
+
@api_client.config.logger.debug "API called: TagApi#create_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
278
278
|
end
|
279
279
|
return data, status_code, headers
|
280
280
|
end
|
@@ -298,11 +298,11 @@ module Hubspot
|
|
298
298
|
# @return [Array<(Tag, Integer, Hash)>] Tag data, response status code and response headers
|
299
299
|
def get_by_id_with_http_info(object_id, opts = {})
|
300
300
|
if @api_client.config.debugging
|
301
|
-
@api_client.config.logger.debug 'Calling API:
|
301
|
+
@api_client.config.logger.debug 'Calling API: TagApi.get_by_id ...'
|
302
302
|
end
|
303
303
|
# verify the required parameter 'object_id' is set
|
304
304
|
if @api_client.config.client_side_validation && object_id.nil?
|
305
|
-
fail ArgumentError, "Missing the required parameter 'object_id' when calling
|
305
|
+
fail ArgumentError, "Missing the required parameter 'object_id' when calling TagApi.get_by_id"
|
306
306
|
end
|
307
307
|
# resource path
|
308
308
|
local_var_path = '/cms/v3/blogs/tags/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))
|
@@ -339,7 +339,7 @@ module Hubspot
|
|
339
339
|
|
340
340
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
341
341
|
if @api_client.config.debugging
|
342
|
-
@api_client.config.logger.debug "API called:
|
342
|
+
@api_client.config.logger.debug "API called: TagApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
343
343
|
end
|
344
344
|
return data, status_code, headers
|
345
345
|
end
|
@@ -379,7 +379,7 @@ module Hubspot
|
|
379
379
|
# @return [Array<(CollectionResponseWithTotalTagForwardPaging, Integer, Hash)>] CollectionResponseWithTotalTagForwardPaging data, response status code and response headers
|
380
380
|
def get_page_with_http_info(opts = {})
|
381
381
|
if @api_client.config.debugging
|
382
|
-
@api_client.config.logger.debug 'Calling API:
|
382
|
+
@api_client.config.logger.debug 'Calling API: TagApi.get_page ...'
|
383
383
|
end
|
384
384
|
# resource path
|
385
385
|
local_var_path = '/cms/v3/blogs/tags'
|
@@ -425,7 +425,7 @@ module Hubspot
|
|
425
425
|
|
426
426
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
427
427
|
if @api_client.config.debugging
|
428
|
-
@api_client.config.logger.debug "API called:
|
428
|
+
@api_client.config.logger.debug "API called: TagApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
429
429
|
end
|
430
430
|
return data, status_code, headers
|
431
431
|
end
|
@@ -449,11 +449,11 @@ module Hubspot
|
|
449
449
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
450
450
|
def read_batch_with_http_info(batch_input_string, opts = {})
|
451
451
|
if @api_client.config.debugging
|
452
|
-
@api_client.config.logger.debug 'Calling API:
|
452
|
+
@api_client.config.logger.debug 'Calling API: TagApi.read_batch ...'
|
453
453
|
end
|
454
454
|
# verify the required parameter 'batch_input_string' is set
|
455
455
|
if @api_client.config.client_side_validation && batch_input_string.nil?
|
456
|
-
fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling
|
456
|
+
fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling TagApi.read_batch"
|
457
457
|
end
|
458
458
|
# resource path
|
459
459
|
local_var_path = '/cms/v3/blogs/tags/batch/read'
|
@@ -492,7 +492,7 @@ module Hubspot
|
|
492
492
|
|
493
493
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
494
494
|
if @api_client.config.debugging
|
495
|
-
@api_client.config.logger.debug "API called:
|
495
|
+
@api_client.config.logger.debug "API called: TagApi#read_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
496
496
|
end
|
497
497
|
return data, status_code, headers
|
498
498
|
end
|
@@ -518,15 +518,15 @@ module Hubspot
|
|
518
518
|
# @return [Array<(Tag, Integer, Hash)>] Tag data, response status code and response headers
|
519
519
|
def update_with_http_info(object_id, tag, opts = {})
|
520
520
|
if @api_client.config.debugging
|
521
|
-
@api_client.config.logger.debug 'Calling API:
|
521
|
+
@api_client.config.logger.debug 'Calling API: TagApi.update ...'
|
522
522
|
end
|
523
523
|
# verify the required parameter 'object_id' is set
|
524
524
|
if @api_client.config.client_side_validation && object_id.nil?
|
525
|
-
fail ArgumentError, "Missing the required parameter 'object_id' when calling
|
525
|
+
fail ArgumentError, "Missing the required parameter 'object_id' when calling TagApi.update"
|
526
526
|
end
|
527
527
|
# verify the required parameter 'tag' is set
|
528
528
|
if @api_client.config.client_side_validation && tag.nil?
|
529
|
-
fail ArgumentError, "Missing the required parameter 'tag' when calling
|
529
|
+
fail ArgumentError, "Missing the required parameter 'tag' when calling TagApi.update"
|
530
530
|
end
|
531
531
|
# resource path
|
532
532
|
local_var_path = '/cms/v3/blogs/tags/{objectId}'.sub('{' + 'objectId' + '}', CGI.escape(object_id.to_s))
|
@@ -565,7 +565,7 @@ module Hubspot
|
|
565
565
|
|
566
566
|
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
567
567
|
if @api_client.config.debugging
|
568
|
-
@api_client.config.logger.debug "API called:
|
568
|
+
@api_client.config.logger.debug "API called: TagApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
569
569
|
end
|
570
570
|
return data, status_code, headers
|
571
571
|
end
|
@@ -589,11 +589,11 @@ module Hubspot
|
|
589
589
|
# @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
|
590
590
|
def update_batch_with_http_info(batch_input_json_node, opts = {})
|
591
591
|
if @api_client.config.debugging
|
592
|
-
@api_client.config.logger.debug 'Calling API:
|
592
|
+
@api_client.config.logger.debug 'Calling API: TagApi.update_batch ...'
|
593
593
|
end
|
594
594
|
# verify the required parameter 'batch_input_json_node' is set
|
595
595
|
if @api_client.config.client_side_validation && batch_input_json_node.nil?
|
596
|
-
fail ArgumentError, "Missing the required parameter 'batch_input_json_node' when calling
|
596
|
+
fail ArgumentError, "Missing the required parameter 'batch_input_json_node' when calling TagApi.update_batch"
|
597
597
|
end
|
598
598
|
# resource path
|
599
599
|
local_var_path = '/cms/v3/blogs/tags/batch/update'
|
@@ -632,7 +632,7 @@ module Hubspot
|
|
632
632
|
|
633
633
|
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
634
634
|
if @api_client.config.debugging
|
635
|
-
@api_client.config.logger.debug "API called:
|
635
|
+
@api_client.config.logger.debug "API called: TagApi#update_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
636
636
|
end
|
637
637
|
return data, status_code, headers
|
638
638
|
end
|
@@ -68,7 +68,7 @@ module Hubspot
|
|
68
68
|
return_type = opts[:return_type] || 'Domain'
|
69
69
|
|
70
70
|
# auth_names
|
71
|
-
auth_names = opts[:auth_names] || ['hapikey'
|
71
|
+
auth_names = opts[:auth_names] || ['hapikey']
|
72
72
|
|
73
73
|
new_options = opts.merge(
|
74
74
|
:header_params => header_params,
|
@@ -160,7 +160,7 @@ module Hubspot
|
|
160
160
|
return_type = opts[:return_type] || 'CollectionResponseWithTotalDomain'
|
161
161
|
|
162
162
|
# auth_names
|
163
|
-
auth_names = opts[:auth_names] || ['hapikey'
|
163
|
+
auth_names = opts[:auth_names] || ['hapikey']
|
164
164
|
|
165
165
|
new_options = opts.merge(
|
166
166
|
:header_params => header_params,
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#HubDB endpoints
|
3
3
|
|
4
|
-
#HubDB is a relational data store that presents data as rows, columns, and cells in a table, much like a spreadsheet. HubDB tables can be added or modified [in the HubSpot CMS](https://knowledge.hubspot.com/cos-general/how-to-edit-hubdb-tables), but you can also use the API endpoints documented here. For more information on HubDB tables and using their data on a HubSpot site, see the [CMS developers site](https://designers.hubspot.com/docs/tools/hubdb). You can also see the [documentation for dynamic pages](https://designers.hubspot.com/docs/tutorials/how-to-build-dynamic-pages-with-hubdb) for more details about the `useForPages` field. HubDB tables support `draft` and `
|
4
|
+
#HubDB is a relational data store that presents data as rows, columns, and cells in a table, much like a spreadsheet. HubDB tables can be added or modified [in the HubSpot CMS](https://knowledge.hubspot.com/cos-general/how-to-edit-hubdb-tables), but you can also use the API endpoints documented here. For more information on HubDB tables and using their data on a HubSpot site, see the [CMS developers site](https://designers.hubspot.com/docs/tools/hubdb). You can also see the [documentation for dynamic pages](https://designers.hubspot.com/docs/tutorials/how-to-build-dynamic-pages-with-hubdb) for more details about the `useForPages` field. HubDB tables support `draft` and `published` versions. This allows you to update data in the table, either for testing or to allow for a manual approval process, without affecting any live pages using the existing data. Draft data can be reviewed, and published by a user working in HubSpot or published via the API. Draft data can also be discarded, allowing users to go back to the published version of the data without disrupting it. If a table is set to be `allowed for public access`, you can access the published version of the table and rows without any authentication by specifying the portal id via the query parameter `portalId`.
|
5
5
|
|
6
6
|
The version of the OpenAPI document: v3
|
7
7
|
|
@@ -23,25 +23,29 @@ module Hubspot
|
|
23
23
|
end
|
24
24
|
# Clone a row
|
25
25
|
# Clones a single row in the `draft` version of the table.
|
26
|
-
# @param row_id [String] The ID of the row
|
27
26
|
# @param table_id_or_name [String] The ID or name of the table
|
27
|
+
# @param row_id [String] The ID of the row
|
28
28
|
# @param [Hash] opts the optional parameters
|
29
29
|
# @return [HubDbTableRowV3]
|
30
|
-
def clone_draft_table_row(
|
31
|
-
data, _status_code, _headers = clone_draft_table_row_with_http_info(
|
30
|
+
def clone_draft_table_row(table_id_or_name, row_id, opts = {})
|
31
|
+
data, _status_code, _headers = clone_draft_table_row_with_http_info(table_id_or_name, row_id, opts)
|
32
32
|
data
|
33
33
|
end
|
34
34
|
|
35
35
|
# Clone a row
|
36
36
|
# Clones a single row in the `draft` version of the table.
|
37
|
-
# @param row_id [String] The ID of the row
|
38
37
|
# @param table_id_or_name [String] The ID or name of the table
|
38
|
+
# @param row_id [String] The ID of the row
|
39
39
|
# @param [Hash] opts the optional parameters
|
40
40
|
# @return [Array<(HubDbTableRowV3, Integer, Hash)>] HubDbTableRowV3 data, response status code and response headers
|
41
|
-
def clone_draft_table_row_with_http_info(
|
41
|
+
def clone_draft_table_row_with_http_info(table_id_or_name, row_id, opts = {})
|
42
42
|
if @api_client.config.debugging
|
43
43
|
@api_client.config.logger.debug 'Calling API: RowsApi.clone_draft_table_row ...'
|
44
44
|
end
|
45
|
+
# verify the required parameter 'table_id_or_name' is set
|
46
|
+
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
47
|
+
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.clone_draft_table_row"
|
48
|
+
end
|
45
49
|
# verify the required parameter 'row_id' is set
|
46
50
|
if @api_client.config.client_side_validation && row_id.nil?
|
47
51
|
fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.clone_draft_table_row"
|
@@ -51,12 +55,8 @@ module Hubspot
|
|
51
55
|
fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.clone_draft_table_row, must conform to the pattern #{pattern}."
|
52
56
|
end
|
53
57
|
|
54
|
-
# verify the required parameter 'table_id_or_name' is set
|
55
|
-
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
56
|
-
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.clone_draft_table_row"
|
57
|
-
end
|
58
58
|
# resource path
|
59
|
-
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone'.sub('{' + '
|
59
|
+
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)).sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s))
|
60
60
|
|
61
61
|
# query parameters
|
62
62
|
query_params = opts[:query_params] || {}
|
@@ -95,23 +95,23 @@ module Hubspot
|
|
95
95
|
end
|
96
96
|
|
97
97
|
# Add a new row to a table
|
98
|
-
# Add a new row to a HubDB table. New rows will be added to the `draft` version of the table. Use `
|
98
|
+
# Add a new row to a HubDB table. New rows will be added to the `draft` version of the table. Use `publish` endpoint to push these changes to published version.
|
99
99
|
# @param table_id_or_name [String] The ID or name of the target table.
|
100
|
-
# @param
|
100
|
+
# @param hub_db_table_row_v3_request [HubDbTableRowV3Request] The row definition JSON, formatted as described above.
|
101
101
|
# @param [Hash] opts the optional parameters
|
102
102
|
# @return [HubDbTableRowV3]
|
103
|
-
def create_table_row(table_id_or_name,
|
104
|
-
data, _status_code, _headers = create_table_row_with_http_info(table_id_or_name,
|
103
|
+
def create_table_row(table_id_or_name, hub_db_table_row_v3_request, opts = {})
|
104
|
+
data, _status_code, _headers = create_table_row_with_http_info(table_id_or_name, hub_db_table_row_v3_request, opts)
|
105
105
|
data
|
106
106
|
end
|
107
107
|
|
108
108
|
# Add a new row to a table
|
109
|
-
# Add a new row to a HubDB table. New rows will be added to the `draft` version of the table. Use `
|
109
|
+
# Add a new row to a HubDB table. New rows will be added to the `draft` version of the table. Use `publish` endpoint to push these changes to published version.
|
110
110
|
# @param table_id_or_name [String] The ID or name of the target table.
|
111
|
-
# @param
|
111
|
+
# @param hub_db_table_row_v3_request [HubDbTableRowV3Request] The row definition JSON, formatted as described above.
|
112
112
|
# @param [Hash] opts the optional parameters
|
113
113
|
# @return [Array<(HubDbTableRowV3, Integer, Hash)>] HubDbTableRowV3 data, response status code and response headers
|
114
|
-
def create_table_row_with_http_info(table_id_or_name,
|
114
|
+
def create_table_row_with_http_info(table_id_or_name, hub_db_table_row_v3_request, opts = {})
|
115
115
|
if @api_client.config.debugging
|
116
116
|
@api_client.config.logger.debug 'Calling API: RowsApi.create_table_row ...'
|
117
117
|
end
|
@@ -119,9 +119,9 @@ module Hubspot
|
|
119
119
|
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
120
120
|
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.create_table_row"
|
121
121
|
end
|
122
|
-
# verify the required parameter '
|
123
|
-
if @api_client.config.client_side_validation &&
|
124
|
-
fail ArgumentError, "Missing the required parameter '
|
122
|
+
# verify the required parameter 'hub_db_table_row_v3_request' is set
|
123
|
+
if @api_client.config.client_side_validation && hub_db_table_row_v3_request.nil?
|
124
|
+
fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_request' when calling RowsApi.create_table_row"
|
125
125
|
end
|
126
126
|
# resource path
|
127
127
|
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s))
|
@@ -140,7 +140,7 @@ module Hubspot
|
|
140
140
|
form_params = opts[:form_params] || {}
|
141
141
|
|
142
142
|
# http body (model)
|
143
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
143
|
+
post_body = opts[:body] || @api_client.object_to_http_body(hub_db_table_row_v3_request)
|
144
144
|
|
145
145
|
# return_type
|
146
146
|
return_type = opts[:return_type] || 'HubDbTableRowV3'
|
@@ -166,25 +166,29 @@ module Hubspot
|
|
166
166
|
|
167
167
|
# Get a row from the draft table
|
168
168
|
# Get a single row by ID from a table's `draft` version.
|
169
|
-
# @param row_id [String] The ID of the row
|
170
169
|
# @param table_id_or_name [String] The ID or name of the table
|
170
|
+
# @param row_id [String] The ID of the row
|
171
171
|
# @param [Hash] opts the optional parameters
|
172
172
|
# @return [HubDbTableRowV3]
|
173
|
-
def get_draft_table_row_by_id(
|
174
|
-
data, _status_code, _headers = get_draft_table_row_by_id_with_http_info(
|
173
|
+
def get_draft_table_row_by_id(table_id_or_name, row_id, opts = {})
|
174
|
+
data, _status_code, _headers = get_draft_table_row_by_id_with_http_info(table_id_or_name, row_id, opts)
|
175
175
|
data
|
176
176
|
end
|
177
177
|
|
178
178
|
# Get a row from the draft table
|
179
179
|
# Get a single row by ID from a table's `draft` version.
|
180
|
-
# @param row_id [String] The ID of the row
|
181
180
|
# @param table_id_or_name [String] The ID or name of the table
|
181
|
+
# @param row_id [String] The ID of the row
|
182
182
|
# @param [Hash] opts the optional parameters
|
183
183
|
# @return [Array<(HubDbTableRowV3, Integer, Hash)>] HubDbTableRowV3 data, response status code and response headers
|
184
|
-
def get_draft_table_row_by_id_with_http_info(
|
184
|
+
def get_draft_table_row_by_id_with_http_info(table_id_or_name, row_id, opts = {})
|
185
185
|
if @api_client.config.debugging
|
186
186
|
@api_client.config.logger.debug 'Calling API: RowsApi.get_draft_table_row_by_id ...'
|
187
187
|
end
|
188
|
+
# verify the required parameter 'table_id_or_name' is set
|
189
|
+
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
190
|
+
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.get_draft_table_row_by_id"
|
191
|
+
end
|
188
192
|
# verify the required parameter 'row_id' is set
|
189
193
|
if @api_client.config.client_side_validation && row_id.nil?
|
190
194
|
fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.get_draft_table_row_by_id"
|
@@ -194,12 +198,8 @@ module Hubspot
|
|
194
198
|
fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.get_draft_table_row_by_id, must conform to the pattern #{pattern}."
|
195
199
|
end
|
196
200
|
|
197
|
-
# verify the required parameter 'table_id_or_name' is set
|
198
|
-
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
199
|
-
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.get_draft_table_row_by_id"
|
200
|
-
end
|
201
201
|
# resource path
|
202
|
-
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + '
|
202
|
+
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)).sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s))
|
203
203
|
|
204
204
|
# query parameters
|
205
205
|
query_params = opts[:query_params] || {}
|
@@ -238,26 +238,30 @@ module Hubspot
|
|
238
238
|
end
|
239
239
|
|
240
240
|
# Get a table row
|
241
|
-
# Get a single row by ID from a table's `
|
242
|
-
# @param row_id [String] The ID of the row
|
241
|
+
# Get a single row by ID from a table's `published` version. **Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.
|
243
242
|
# @param table_id_or_name [String] The ID or name of the table
|
243
|
+
# @param row_id [String] The ID of the row
|
244
244
|
# @param [Hash] opts the optional parameters
|
245
245
|
# @return [HubDbTableRowV3]
|
246
|
-
def get_table_row(
|
247
|
-
data, _status_code, _headers = get_table_row_with_http_info(
|
246
|
+
def get_table_row(table_id_or_name, row_id, opts = {})
|
247
|
+
data, _status_code, _headers = get_table_row_with_http_info(table_id_or_name, row_id, opts)
|
248
248
|
data
|
249
249
|
end
|
250
250
|
|
251
251
|
# Get a table row
|
252
|
-
# Get a single row by ID from a table's `
|
253
|
-
# @param row_id [String] The ID of the row
|
252
|
+
# Get a single row by ID from a table's `published` version. **Note:** This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.
|
254
253
|
# @param table_id_or_name [String] The ID or name of the table
|
254
|
+
# @param row_id [String] The ID of the row
|
255
255
|
# @param [Hash] opts the optional parameters
|
256
256
|
# @return [Array<(HubDbTableRowV3, Integer, Hash)>] HubDbTableRowV3 data, response status code and response headers
|
257
|
-
def get_table_row_with_http_info(
|
257
|
+
def get_table_row_with_http_info(table_id_or_name, row_id, opts = {})
|
258
258
|
if @api_client.config.debugging
|
259
259
|
@api_client.config.logger.debug 'Calling API: RowsApi.get_table_row ...'
|
260
260
|
end
|
261
|
+
# verify the required parameter 'table_id_or_name' is set
|
262
|
+
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
263
|
+
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.get_table_row"
|
264
|
+
end
|
261
265
|
# verify the required parameter 'row_id' is set
|
262
266
|
if @api_client.config.client_side_validation && row_id.nil?
|
263
267
|
fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.get_table_row"
|
@@ -267,12 +271,8 @@ module Hubspot
|
|
267
271
|
fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.get_table_row, must conform to the pattern #{pattern}."
|
268
272
|
end
|
269
273
|
|
270
|
-
# verify the required parameter 'table_id_or_name' is set
|
271
|
-
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
272
|
-
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.get_table_row"
|
273
|
-
end
|
274
274
|
# resource path
|
275
|
-
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}'.sub('{' + '
|
275
|
+
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)).sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s))
|
276
276
|
|
277
277
|
# query parameters
|
278
278
|
query_params = opts[:query_params] || {}
|
@@ -311,13 +311,13 @@ module Hubspot
|
|
311
311
|
end
|
312
312
|
|
313
313
|
# Get rows for a table
|
314
|
-
# Returns a set of rows in the `
|
314
|
+
# Returns a set of rows in the `published` version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) 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.
|
315
315
|
# @param table_id_or_name [String] The ID or name of the table to query.
|
316
316
|
# @param [Hash] opts the optional parameters
|
317
|
-
# @option opts [Array<String>] :
|
317
|
+
# @option opts [Array<String>] :sort Specifies the column names to sort the results by. See the above description for more details.
|
318
318
|
# @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.
|
319
319
|
# @option opts [Integer] :limit The maximum number of results to return. Default is `1000`.
|
320
|
-
# @option opts [Array<String>] :
|
320
|
+
# @option opts [Array<String>] :properties Specify the column names to get results containing only the required columns instead of all column details.
|
321
321
|
# @return [CollectionResponseWithTotalHubDbTableRowV3ForwardPaging]
|
322
322
|
def get_table_rows(table_id_or_name, opts = {})
|
323
323
|
data, _status_code, _headers = get_table_rows_with_http_info(table_id_or_name, opts)
|
@@ -325,13 +325,13 @@ module Hubspot
|
|
325
325
|
end
|
326
326
|
|
327
327
|
# Get rows for a table
|
328
|
-
# Returns a set of rows in the `
|
328
|
+
# Returns a set of rows in the `published` version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) 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.
|
329
329
|
# @param table_id_or_name [String] The ID or name of the table to query.
|
330
330
|
# @param [Hash] opts the optional parameters
|
331
|
-
# @option opts [Array<String>] :
|
331
|
+
# @option opts [Array<String>] :sort Specifies the column names to sort the results by. See the above description for more details.
|
332
332
|
# @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.
|
333
333
|
# @option opts [Integer] :limit The maximum number of results to return. Default is `1000`.
|
334
|
-
# @option opts [Array<String>] :
|
334
|
+
# @option opts [Array<String>] :properties Specify the column names to get results containing only the required columns instead of all column details.
|
335
335
|
# @return [Array<(CollectionResponseWithTotalHubDbTableRowV3ForwardPaging, Integer, Hash)>] CollectionResponseWithTotalHubDbTableRowV3ForwardPaging data, response status code and response headers
|
336
336
|
def get_table_rows_with_http_info(table_id_or_name, opts = {})
|
337
337
|
if @api_client.config.debugging
|
@@ -346,10 +346,10 @@ module Hubspot
|
|
346
346
|
|
347
347
|
# query parameters
|
348
348
|
query_params = opts[:query_params] || {}
|
349
|
-
query_params[:'
|
349
|
+
query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
|
350
350
|
query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
|
351
351
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
352
|
-
query_params[:'
|
352
|
+
query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
|
353
353
|
|
354
354
|
# header parameters
|
355
355
|
header_params = opts[:header_params] || {}
|
@@ -386,25 +386,29 @@ module Hubspot
|
|
386
386
|
|
387
387
|
# Permanently deletes a row
|
388
388
|
# Permanently deletes a row from a table's `draft` version.
|
389
|
-
# @param row_id [String] The ID of the row
|
390
389
|
# @param table_id_or_name [String] The ID or name of the table
|
390
|
+
# @param row_id [String] The ID of the row
|
391
391
|
# @param [Hash] opts the optional parameters
|
392
392
|
# @return [nil]
|
393
|
-
def purge_draft_table_row(
|
394
|
-
purge_draft_table_row_with_http_info(
|
393
|
+
def purge_draft_table_row(table_id_or_name, row_id, opts = {})
|
394
|
+
purge_draft_table_row_with_http_info(table_id_or_name, row_id, opts)
|
395
395
|
nil
|
396
396
|
end
|
397
397
|
|
398
398
|
# Permanently deletes a row
|
399
399
|
# Permanently deletes a row from a table's `draft` version.
|
400
|
-
# @param row_id [String] The ID of the row
|
401
400
|
# @param table_id_or_name [String] The ID or name of the table
|
401
|
+
# @param row_id [String] The ID of the row
|
402
402
|
# @param [Hash] opts the optional parameters
|
403
403
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
404
|
-
def purge_draft_table_row_with_http_info(
|
404
|
+
def purge_draft_table_row_with_http_info(table_id_or_name, row_id, opts = {})
|
405
405
|
if @api_client.config.debugging
|
406
406
|
@api_client.config.logger.debug 'Calling API: RowsApi.purge_draft_table_row ...'
|
407
407
|
end
|
408
|
+
# verify the required parameter 'table_id_or_name' is set
|
409
|
+
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
410
|
+
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.purge_draft_table_row"
|
411
|
+
end
|
408
412
|
# verify the required parameter 'row_id' is set
|
409
413
|
if @api_client.config.client_side_validation && row_id.nil?
|
410
414
|
fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.purge_draft_table_row"
|
@@ -414,12 +418,8 @@ module Hubspot
|
|
414
418
|
fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.purge_draft_table_row, must conform to the pattern #{pattern}."
|
415
419
|
end
|
416
420
|
|
417
|
-
# verify the required parameter 'table_id_or_name' is set
|
418
|
-
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
419
|
-
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.purge_draft_table_row"
|
420
|
-
end
|
421
421
|
# resource path
|
422
|
-
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + '
|
422
|
+
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)).sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s))
|
423
423
|
|
424
424
|
# query parameters
|
425
425
|
query_params = opts[:query_params] || {}
|
@@ -458,13 +458,13 @@ module Hubspot
|
|
458
458
|
end
|
459
459
|
|
460
460
|
# Get rows from draft table
|
461
|
-
# Returns rows in the `draft` version of the specified table. Row results can be filtered and sorted
|
461
|
+
# Returns rows in the `draft` version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.
|
462
462
|
# @param table_id_or_name [String] The ID or name of the table to query.
|
463
463
|
# @param [Hash] opts the optional parameters
|
464
|
+
# @option opts [Array<String>] :sort Specifies the column names to sort the results by.
|
464
465
|
# @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.
|
465
|
-
# @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.
|
466
466
|
# @option opts [Integer] :limit The maximum number of results to return. Default is `1000`.
|
467
|
-
# @option opts [Array<String>] :
|
467
|
+
# @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.
|
468
468
|
# @return [CollectionResponseWithTotalHubDbTableRowV3ForwardPaging]
|
469
469
|
def read_draft_table_rows(table_id_or_name, opts = {})
|
470
470
|
data, _status_code, _headers = read_draft_table_rows_with_http_info(table_id_or_name, opts)
|
@@ -472,13 +472,13 @@ module Hubspot
|
|
472
472
|
end
|
473
473
|
|
474
474
|
# Get rows from draft table
|
475
|
-
# Returns rows in the `draft` version of the specified table. Row results can be filtered and sorted
|
475
|
+
# Returns rows in the `draft` version of the specified table. Row results can be filtered and sorted. Filtering and sorting options will be sent as query parameters to the API request. For example, by adding the query parameters `column1__gt=5&sort=-column1`, API returns the rows with values for column `column1` greater than 5 and in the descending order of `column1` values. Refer to the [overview section](https://developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.
|
476
476
|
# @param table_id_or_name [String] The ID or name of the table to query.
|
477
477
|
# @param [Hash] opts the optional parameters
|
478
|
+
# @option opts [Array<String>] :sort Specifies the column names to sort the results by.
|
478
479
|
# @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.
|
479
|
-
# @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.
|
480
480
|
# @option opts [Integer] :limit The maximum number of results to return. Default is `1000`.
|
481
|
-
# @option opts [Array<String>] :
|
481
|
+
# @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.
|
482
482
|
# @return [Array<(CollectionResponseWithTotalHubDbTableRowV3ForwardPaging, Integer, Hash)>] CollectionResponseWithTotalHubDbTableRowV3ForwardPaging data, response status code and response headers
|
483
483
|
def read_draft_table_rows_with_http_info(table_id_or_name, opts = {})
|
484
484
|
if @api_client.config.debugging
|
@@ -493,10 +493,10 @@ module Hubspot
|
|
493
493
|
|
494
494
|
# query parameters
|
495
495
|
query_params = opts[:query_params] || {}
|
496
|
+
query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
|
496
497
|
query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
|
497
|
-
query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
|
498
498
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
499
|
-
query_params[:'
|
499
|
+
query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
|
500
500
|
|
501
501
|
# header parameters
|
502
502
|
header_params = opts[:header_params] || {}
|
@@ -533,27 +533,31 @@ module Hubspot
|
|
533
533
|
|
534
534
|
# Replaces an existing row
|
535
535
|
# 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.
|
536
|
-
# @param row_id [String] The ID of the row
|
537
536
|
# @param table_id_or_name [String] The ID or name of the table
|
538
|
-
# @param
|
537
|
+
# @param row_id [String] The ID of the row
|
538
|
+
# @param hub_db_table_row_v3_request [HubDbTableRowV3Request] The JSON object of the row
|
539
539
|
# @param [Hash] opts the optional parameters
|
540
540
|
# @return [HubDbTableRowV3]
|
541
|
-
def replace_draft_table_row(
|
542
|
-
data, _status_code, _headers = replace_draft_table_row_with_http_info(
|
541
|
+
def replace_draft_table_row(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
|
542
|
+
data, _status_code, _headers = replace_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts)
|
543
543
|
data
|
544
544
|
end
|
545
545
|
|
546
546
|
# Replaces an existing row
|
547
547
|
# 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.
|
548
|
-
# @param row_id [String] The ID of the row
|
549
548
|
# @param table_id_or_name [String] The ID or name of the table
|
550
|
-
# @param
|
549
|
+
# @param row_id [String] The ID of the row
|
550
|
+
# @param hub_db_table_row_v3_request [HubDbTableRowV3Request] The JSON object of the row
|
551
551
|
# @param [Hash] opts the optional parameters
|
552
552
|
# @return [Array<(HubDbTableRowV3, Integer, Hash)>] HubDbTableRowV3 data, response status code and response headers
|
553
|
-
def replace_draft_table_row_with_http_info(
|
553
|
+
def replace_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
|
554
554
|
if @api_client.config.debugging
|
555
555
|
@api_client.config.logger.debug 'Calling API: RowsApi.replace_draft_table_row ...'
|
556
556
|
end
|
557
|
+
# verify the required parameter 'table_id_or_name' is set
|
558
|
+
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
559
|
+
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.replace_draft_table_row"
|
560
|
+
end
|
557
561
|
# verify the required parameter 'row_id' is set
|
558
562
|
if @api_client.config.client_side_validation && row_id.nil?
|
559
563
|
fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.replace_draft_table_row"
|
@@ -563,16 +567,12 @@ module Hubspot
|
|
563
567
|
fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.replace_draft_table_row, must conform to the pattern #{pattern}."
|
564
568
|
end
|
565
569
|
|
566
|
-
# verify the required parameter '
|
567
|
-
if @api_client.config.client_side_validation &&
|
568
|
-
fail ArgumentError, "Missing the required parameter '
|
569
|
-
end
|
570
|
-
# verify the required parameter 'hub_db_table_row_v3_input' is set
|
571
|
-
if @api_client.config.client_side_validation && hub_db_table_row_v3_input.nil?
|
572
|
-
fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_input' when calling RowsApi.replace_draft_table_row"
|
570
|
+
# verify the required parameter 'hub_db_table_row_v3_request' is set
|
571
|
+
if @api_client.config.client_side_validation && hub_db_table_row_v3_request.nil?
|
572
|
+
fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_request' when calling RowsApi.replace_draft_table_row"
|
573
573
|
end
|
574
574
|
# resource path
|
575
|
-
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + '
|
575
|
+
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)).sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s))
|
576
576
|
|
577
577
|
# query parameters
|
578
578
|
query_params = opts[:query_params] || {}
|
@@ -588,7 +588,7 @@ module Hubspot
|
|
588
588
|
form_params = opts[:form_params] || {}
|
589
589
|
|
590
590
|
# http body (model)
|
591
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
591
|
+
post_body = opts[:body] || @api_client.object_to_http_body(hub_db_table_row_v3_request)
|
592
592
|
|
593
593
|
# return_type
|
594
594
|
return_type = opts[:return_type] || 'HubDbTableRowV3'
|
@@ -614,27 +614,31 @@ module Hubspot
|
|
614
614
|
|
615
615
|
# Updates an existing row
|
616
616
|
# 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.
|
617
|
-
# @param row_id [String] The ID of the row
|
618
617
|
# @param table_id_or_name [String] The ID or name of the table
|
619
|
-
# @param
|
618
|
+
# @param row_id [String] The ID of the row
|
619
|
+
# @param hub_db_table_row_v3_request [HubDbTableRowV3Request] The JSON object of the row with necessary fields that needs to be updated.
|
620
620
|
# @param [Hash] opts the optional parameters
|
621
621
|
# @return [HubDbTableRowV3]
|
622
|
-
def update_draft_table_row(
|
623
|
-
data, _status_code, _headers = update_draft_table_row_with_http_info(
|
622
|
+
def update_draft_table_row(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
|
623
|
+
data, _status_code, _headers = update_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts)
|
624
624
|
data
|
625
625
|
end
|
626
626
|
|
627
627
|
# Updates an existing row
|
628
628
|
# 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.
|
629
|
-
# @param row_id [String] The ID of the row
|
630
629
|
# @param table_id_or_name [String] The ID or name of the table
|
631
|
-
# @param
|
630
|
+
# @param row_id [String] The ID of the row
|
631
|
+
# @param hub_db_table_row_v3_request [HubDbTableRowV3Request] The JSON object of the row with necessary fields that needs to be updated.
|
632
632
|
# @param [Hash] opts the optional parameters
|
633
633
|
# @return [Array<(HubDbTableRowV3, Integer, Hash)>] HubDbTableRowV3 data, response status code and response headers
|
634
|
-
def update_draft_table_row_with_http_info(
|
634
|
+
def update_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
|
635
635
|
if @api_client.config.debugging
|
636
636
|
@api_client.config.logger.debug 'Calling API: RowsApi.update_draft_table_row ...'
|
637
637
|
end
|
638
|
+
# verify the required parameter 'table_id_or_name' is set
|
639
|
+
if @api_client.config.client_side_validation && table_id_or_name.nil?
|
640
|
+
fail ArgumentError, "Missing the required parameter 'table_id_or_name' when calling RowsApi.update_draft_table_row"
|
641
|
+
end
|
638
642
|
# verify the required parameter 'row_id' is set
|
639
643
|
if @api_client.config.client_side_validation && row_id.nil?
|
640
644
|
fail ArgumentError, "Missing the required parameter 'row_id' when calling RowsApi.update_draft_table_row"
|
@@ -644,16 +648,12 @@ module Hubspot
|
|
644
648
|
fail ArgumentError, "invalid value for 'row_id' when calling RowsApi.update_draft_table_row, must conform to the pattern #{pattern}."
|
645
649
|
end
|
646
650
|
|
647
|
-
# verify the required parameter '
|
648
|
-
if @api_client.config.client_side_validation &&
|
649
|
-
fail ArgumentError, "Missing the required parameter '
|
650
|
-
end
|
651
|
-
# verify the required parameter 'hub_db_table_row_v3_input' is set
|
652
|
-
if @api_client.config.client_side_validation && hub_db_table_row_v3_input.nil?
|
653
|
-
fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_input' when calling RowsApi.update_draft_table_row"
|
651
|
+
# verify the required parameter 'hub_db_table_row_v3_request' is set
|
652
|
+
if @api_client.config.client_side_validation && hub_db_table_row_v3_request.nil?
|
653
|
+
fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_request' when calling RowsApi.update_draft_table_row"
|
654
654
|
end
|
655
655
|
# resource path
|
656
|
-
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + '
|
656
|
+
local_var_path = '/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft'.sub('{' + 'tableIdOrName' + '}', CGI.escape(table_id_or_name.to_s)).sub('{' + 'rowId' + '}', CGI.escape(row_id.to_s))
|
657
657
|
|
658
658
|
# query parameters
|
659
659
|
query_params = opts[:query_params] || {}
|
@@ -669,7 +669,7 @@ module Hubspot
|
|
669
669
|
form_params = opts[:form_params] || {}
|
670
670
|
|
671
671
|
# http body (model)
|
672
|
-
post_body = opts[:body] || @api_client.object_to_http_body(
|
672
|
+
post_body = opts[:body] || @api_client.object_to_http_body(hub_db_table_row_v3_request)
|
673
673
|
|
674
674
|
# return_type
|
675
675
|
return_type = opts[:return_type] || 'HubDbTableRowV3'
|