Class: Hubspot::Cms::Hubdb::RowsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/hubdb/api/rows_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RowsApi

Returns a new instance of RowsApi.



21
22
23
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 21

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#clone_draft_table_row(table_id_or_name, row_id, opts = {}) ⇒ HubDbTableRowV3

Clone a row Clones a single row in the ‘draft` version of the table.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



30
31
32
33
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 30

def clone_draft_table_row(table_id_or_name, row_id, opts = {})
  data, _status_code, _headers = clone_draft_table_row_with_http_info(table_id_or_name, row_id, opts)
  data
end

#clone_draft_table_row_with_http_info(table_id_or_name, row_id, opts = {}) ⇒ Array<(HubDbTableRowV3, Integer, Hash)>

Clone a row Clones a single row in the &#x60;draft&#x60; version of the table.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HubDbTableRowV3, Integer, Hash)>) —

    HubDbTableRowV3 data, response status code and response headers



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 41

def clone_draft_table_row_with_http_info(table_id_or_name, row_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RowsApi.clone_draft_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.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

  # resource path
  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))

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'HubDbTableRowV3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.clone_draft_table_row",
    :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

#create_table_row(table_id_or_name, hub_db_table_row_v3_request, opts = {}) ⇒ HubDbTableRowV3

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 `publish` endpoint to push these changes to published version.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the target table.

  • hub_db_table_row_v3_request (HubDbTableRowV3Request) —

    The row definition JSON, formatted as described above.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



104
105
106
107
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 104

def create_table_row(table_id_or_name, hub_db_table_row_v3_request, opts = {})
  data, _status_code, _headers = create_table_row_with_http_info(table_id_or_name, hub_db_table_row_v3_request, opts)
  data
end

#create_table_row_with_http_info(table_id_or_name, hub_db_table_row_v3_request, opts = {}) ⇒ Array<(HubDbTableRowV3, Integer, Hash)>

Add a new row to a table Add a new row to a HubDB table. New rows will be added to the &#x60;draft&#x60; version of the table. Use &#x60;publish&#x60; endpoint to push these changes to published version.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the target table.

  • hub_db_table_row_v3_request (HubDbTableRowV3Request) —

    The row definition JSON, formatted as described above.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HubDbTableRowV3, Integer, Hash)>) —

    HubDbTableRowV3 data, response status code and response headers



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 115

def create_table_row_with_http_info(table_id_or_name, hub_db_table_row_v3_request, 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_request' is set
  if @api_client.config.client_side_validation && hub_db_table_row_v3_request.nil?
    fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_request' 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(hub_db_table_row_v3_request)

  # return_type
  return_type = opts[:debug_return_type] || 'HubDbTableRowV3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.create_table_row",
    :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_draft_table_row_by_id(table_id_or_name, row_id, opts = {}) ⇒ HubDbTableRowV3

Get a row from the draft table Get a single row by ID from a table’s ‘draft` version.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



178
179
180
181
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 178

def get_draft_table_row_by_id(table_id_or_name, row_id, opts = {})
  data, _status_code, _headers = get_draft_table_row_by_id_with_http_info(table_id_or_name, row_id, opts)
  data
end

#get_draft_table_row_by_id_with_http_info(table_id_or_name, row_id, opts = {}) ⇒ Array<(HubDbTableRowV3, Integer, Hash)>

Get a row from the draft table Get a single row by ID from a table&#39;s &#x60;draft&#x60; version.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HubDbTableRowV3, Integer, Hash)>) —

    HubDbTableRowV3 data, response status code and response headers



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 189

def get_draft_table_row_by_id_with_http_info(table_id_or_name, row_id, 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 '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
  # 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

  # resource path
  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))

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'HubDbTableRowV3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.get_draft_table_row_by_id",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RowsApi#get_draft_table_row_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_table_row(table_id_or_name, row_id, opts = {}) ⇒ HubDbTableRowV3

Get a table row 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.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



252
253
254
255
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 252

def get_table_row(table_id_or_name, row_id, opts = {})
  data, _status_code, _headers = get_table_row_with_http_info(table_id_or_name, row_id, opts)
  data
end

#get_table_row_with_http_info(table_id_or_name, row_id, opts = {}) ⇒ Array<(HubDbTableRowV3, Integer, Hash)>

Get a table row Get a single row by ID from a table&#39;s &#x60;published&#x60; version. Note: This endpoint can be accessed without any authentication, if the table is set to be allowed for public access.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HubDbTableRowV3, Integer, Hash)>) —

    HubDbTableRowV3 data, response status code and response headers



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 263

def get_table_row_with_http_info(table_id_or_name, row_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RowsApi.get_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.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

  # resource path
  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))

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'HubDbTableRowV3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.get_table_row",
    :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_table_rows(table_id_or_name, opts = {}) ⇒ CollectionResponseWithTotalHubDbTableRowV3ForwardPaging

Get rows for a table 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](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.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table to query.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sort (Array<String>) —

    Specifies the column names to sort the results by. See the above description for more details.

  • :after (String) —

    The cursor token value to get the next set of results. You can get this from the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to return. Default is &#x60;1000&#x60;.

  • :properties (Array<String>) —

    Specify the column names to get results containing only the required columns instead of all column details.

Returns:



329
330
331
332
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 329

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_table_rows_with_http_info(table_id_or_name, opts = {}) ⇒ Array<(CollectionResponseWithTotalHubDbTableRowV3ForwardPaging, Integer, Hash)>

Get rows for a table Returns a set of rows in the &#x60;published&#x60; 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 &#x60;column1__gt&#x3D;5&amp;sort&#x3D;-column1&#x60;, API returns the rows with values for column &#x60;column1&#x60; greater than 5 and in the descending order of &#x60;column1&#x60; values. Refer to the [overview section](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.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table to query.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sort (Array<String>) —

    Specifies the column names to sort the results by. See the above description for more details.

  • :after (String) —

    The cursor token value to get the next set of results. You can get this from the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to return. Default is &#x60;1000&#x60;.

  • :properties (Array<String>) —

    Specify the column names to get results containing only the required columns instead of all column details.

Returns:



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 343

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[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :csv) if !opts[:'properties'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CollectionResponseWithTotalHubDbTableRowV3ForwardPaging'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.get_table_rows",
    :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

#purge_draft_table_row(table_id_or_name, row_id, opts = {}) ⇒ nil

Permanently deletes a row Permanently deletes a row from a table’s ‘draft` version.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


401
402
403
404
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 401

def purge_draft_table_row(table_id_or_name, row_id, opts = {})
  purge_draft_table_row_with_http_info(table_id_or_name, row_id, opts)
  nil
end

#purge_draft_table_row_with_http_info(table_id_or_name, row_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Permanently deletes a row Permanently deletes a row from a table&#39;s &#x60;draft&#x60; version.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 412

def purge_draft_table_row_with_http_info(table_id_or_name, row_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RowsApi.purge_draft_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.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

  # resource path
  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))

  # 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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.purge_draft_table_row",
    :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

#read_draft_table_rows(table_id_or_name, opts = {}) ⇒ CollectionResponseWithTotalHubDbTableRowV3ForwardPaging

Get rows from draft table 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](developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table to query.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sort (Array<String>) —

    Specifies the column names to sort the results by.

  • :after (String) —

    The cursor token value to get the next set of results. You can get this from the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to return. Default is &#x60;1000&#x60;.

  • :properties (Array<String>) —

    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.

Returns:



478
479
480
481
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 478

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

#read_draft_table_rows_with_http_info(table_id_or_name, opts = {}) ⇒ Array<(CollectionResponseWithTotalHubDbTableRowV3ForwardPaging, Integer, Hash)>

Get rows from draft table Returns rows in the &#x60;draft&#x60; 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 &#x60;column1__gt&#x3D;5&amp;sort&#x3D;-column1&#x60;, API returns the rows with values for column &#x60;column1&#x60; greater than 5 and in the descending order of &#x60;column1&#x60; values. Refer to the [overview section](developers.hubspot.com/docs/api/cms/hubdb#filtering-and-sorting-table-rows) for detailed filtering and sorting options.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table to query.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :sort (Array<String>) —

    Specifies the column names to sort the results by.

  • :after (String) —

    The cursor token value to get the next set of results. You can get this from the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :limit (Integer) —

    The maximum number of results to return. Default is &#x60;1000&#x60;.

  • :properties (Array<String>) —

    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.

Returns:



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 492

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[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :csv) if !opts[:'properties'].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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CollectionResponseWithTotalHubDbTableRowV3ForwardPaging'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.read_draft_table_rows",
    :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

#replace_draft_table_row(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {}) ⇒ HubDbTableRowV3

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.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • hub_db_table_row_v3_request (HubDbTableRowV3Request) —

    The JSON object of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



551
552
553
554
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 551

def replace_draft_table_row(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
  data, _status_code, _headers = replace_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts)
  data
end

#replace_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {}) ⇒ Array<(HubDbTableRowV3, Integer, Hash)>

Replaces an existing row Replace a single row in the table&#39;s &#x60;draft&#x60; version. All the column values must be specified. If a column has a value in the target table and this request doesn&#39;t define that value, it will be deleted. See the &#x60;Create a row&#x60; endpoint for instructions on how to format the JSON row definitions.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • hub_db_table_row_v3_request (HubDbTableRowV3Request) —

    The JSON object of the row

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HubDbTableRowV3, Integer, Hash)>) —

    HubDbTableRowV3 data, response status code and response headers



563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 563

def replace_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RowsApi.replace_draft_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.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 'hub_db_table_row_v3_request' is set
  if @api_client.config.client_side_validation && hub_db_table_row_v3_request.nil?
    fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_request' when calling RowsApi.replace_draft_table_row"
  end
  # resource path
  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))

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(hub_db_table_row_v3_request)

  # return_type
  return_type = opts[:debug_return_type] || 'HubDbTableRowV3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.replace_draft_table_row",
    :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

#update_draft_table_row(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {}) ⇒ HubDbTableRowV3

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.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • hub_db_table_row_v3_request (HubDbTableRowV3Request) —

    The JSON object of the row with necessary fields that needs to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



636
637
638
639
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 636

def update_draft_table_row(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
  data, _status_code, _headers = update_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts)
  data
end

#update_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {}) ⇒ Array<(HubDbTableRowV3, Integer, Hash)>

Updates an existing row Sparse updates a single row in the table&#39;s &#x60;draft&#x60; version. All the column values need not be specified. Only the columns or fields that needs to be modified can be specified. See the &#x60;Create a row&#x60; endpoint for instructions on how to format the JSON row definitions.

Parameters:

  • table_id_or_name (String) —

    The ID or name of the table

  • row_id (String) —

    The ID of the row

  • hub_db_table_row_v3_request (HubDbTableRowV3Request) —

    The JSON object of the row with necessary fields that needs to be updated.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(HubDbTableRowV3, Integer, Hash)>) —

    HubDbTableRowV3 data, response status code and response headers



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/hubspot/codegen/cms/hubdb/api/rows_api.rb', line 648

def update_draft_table_row_with_http_info(table_id_or_name, row_id, hub_db_table_row_v3_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RowsApi.update_draft_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.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 'hub_db_table_row_v3_request' is set
  if @api_client.config.client_side_validation && hub_db_table_row_v3_request.nil?
    fail ArgumentError, "Missing the required parameter 'hub_db_table_row_v3_request' when calling RowsApi.update_draft_table_row"
  end
  # resource path
  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))

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(hub_db_table_row_v3_request)

  # return_type
  return_type = opts[:debug_return_type] || 'HubDbTableRowV3'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"RowsApi.update_draft_table_row",
    :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