Class: KlaviyoAPI::CustomObjectsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/api/custom_objects_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomObjectsApi 



18
19
20
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#bulk_create_data_source_records(data_source_record_bulk_create_job_create_query, opts = {}) ⇒ nil Also known as: create_data_source_record_bulk_create_job

Bulk Create Data Source Records Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](developers.klaviyo.com/en/reference/custom_objects_api_overview).

*Rate limits*:
Burst: 3/s
Steady: 15/m Scopes: custom-objects:write



26
27
28
29
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 26

def bulk_create_data_source_records(data_source_record_bulk_create_job_create_query, opts = {})
  bulk_create_data_source_records_with_http_info(data_source_record_bulk_create_job_create_query, opts)
  nil
end

#bulk_create_data_source_records_with_http_info(data_source_record_bulk_create_job_create_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_data_source_record_bulk_create_job_with_http_info

Bulk Create Data Source Records Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](developers.klaviyo.com/en/reference/custom_objects_api_overview).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;15/m&#x60; Scopes: &#x60;custom-objects:write&#x60;



39
40
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
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 39

def bulk_create_data_source_records_with_http_info(data_source_record_bulk_create_job_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.bulk_create_data_source_records ...'
  end
  # verify the required parameter 'data_source_record_bulk_create_job_create_query' is set
  if @api_client.config.client_side_validation && data_source_record_bulk_create_job_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'data_source_record_bulk_create_job_create_query' when calling CustomObjectsApi.bulk_create_data_source_records"
  end
  # resource path
  local_var_path = '/api/data-source-record-bulk-create-jobs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-01-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(data_source_record_bulk_create_job_create_query)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"CustomObjectsApi.bulk_create_data_source_records",
    :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: CustomObjectsApi#bulk_create_data_source_records\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_data_source(data_source_create_query, opts = {}) ⇒ Hash<String, Object>

Create Data Source Create a new data source in an account

*Rate limits*:
Burst: 3/s
Steady: 60/m Scopes: custom-objects:write



102
103
104
105
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 102

def create_data_source(data_source_create_query, opts = {})
  data, _status_code, _headers = create_data_source_with_http_info(data_source_create_query, opts)
  data
end

#create_data_source_record(data_source_record_create_job_create_query, opts = {}) ⇒ nil Also known as: create_data_source_record_create_job

Create Data Source Record Create a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](developers.klaviyo.com/en/reference/custom_objects_api_overview).

*Rate limits*:
Burst: 75/s
Steady: 700/m Scopes: custom-objects:write



172
173
174
175
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 172

def create_data_source_record(data_source_record_create_job_create_query, opts = {})
  create_data_source_record_with_http_info(data_source_record_create_job_create_query, opts)
  nil
end

#create_data_source_record_with_http_info(data_source_record_create_job_create_query, opts = {}) ⇒ Array<(nil, Integer, Hash)> Also known as: create_data_source_record_create_job_with_http_info

Create Data Source Record Create a data source record import job to create a single record. The maximum allowed payload size per-record is 512KB. To learn more, see our [Custom Objects API overview](developers.klaviyo.com/en/reference/custom_objects_api_overview).&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;75/s&#x60;&lt;br&gt;Steady: &#x60;700/m&#x60; Scopes: &#x60;custom-objects:write&#x60;



185
186
187
188
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
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 185

def create_data_source_record_with_http_info(data_source_record_create_job_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_data_source_record ...'
  end
  # verify the required parameter 'data_source_record_create_job_create_query' is set
  if @api_client.config.client_side_validation && data_source_record_create_job_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'data_source_record_create_job_create_query' when calling CustomObjectsApi.create_data_source_record"
  end
  # resource path
  local_var_path = '/api/data-source-record-create-jobs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-01-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(data_source_record_create_job_create_query)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"CustomObjectsApi.create_data_source_record",
    :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: CustomObjectsApi#create_data_source_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_data_source_with_http_info(data_source_create_query, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Create Data Source Create a new data source in an account&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;custom-objects:write&#x60;



112
113
114
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
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 112

def create_data_source_with_http_info(data_source_create_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.create_data_source ...'
  end
  # verify the required parameter 'data_source_create_query' is set
  if @api_client.config.client_side_validation && data_source_create_query.nil?
    fail ArgumentError, "Missing the required parameter 'data_source_create_query' when calling CustomObjectsApi.create_data_source"
  end
  # resource path
  local_var_path = '/api/data-sources'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-01-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/vnd.api+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(data_source_create_query)

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"CustomObjectsApi.create_data_source",
    :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: CustomObjectsApi#create_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_data_source(id, opts = {}) ⇒ nil

Delete Data Source Delete a data source in an account.

*Rate limits*:
Burst: 3/s
Steady: 60/m Scopes: custom-objects:write



248
249
250
251
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 248

def delete_data_source(id, opts = {})
  delete_data_source_with_http_info(id, opts)
  nil
end

#delete_data_source_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Data Source Delete a data source in an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;custom-objects:write&#x60;



258
259
260
261
262
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
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 258

def delete_data_source_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.delete_data_source ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.delete_data_source"
  end
  # resource path
  local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-01-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

  # 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] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"CustomObjectsApi.delete_data_source",
    :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: CustomObjectsApi#delete_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_data_source(id, opts = {}) ⇒ Hash<String, Object>

Get Data Source Retrieve a data source in an account.

*Rate limits*:
Burst: 3/s
Steady: 60/m Scopes: custom-objects:read

Options Hash (opts):



314
315
316
317
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 314

def get_data_source(id, opts = {})
  data, _status_code, _headers = get_data_source_with_http_info(id, opts)
  data
end

#get_data_source_with_http_info(id, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Data Source Retrieve a data source in an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;custom-objects:read&#x60;

Options Hash (opts):



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
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
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 325

def get_data_source_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_source ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling CustomObjectsApi.get_data_source"
  end
  allowable_values = ["title", "visibility", "description"]
  if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/data-sources/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-01-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"CustomObjectsApi.get_data_source",
    :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: CustomObjectsApi#get_data_source\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_data_sources(opts = {}) ⇒ Hash<String, Object>

Get Data Sources Get all data sources in an account.

*Rate limits*:
Burst: 3/s
Steady: 60/m Scopes: custom-objects:read

Options Hash (opts):



387
388
389
390
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 387

def get_data_sources(opts = {})
  data, _status_code, _headers = get_data_sources_with_http_info(opts)
  data
end

#get_data_sources_with_http_info(opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Get Data Sources Get all data sources in an account.&lt;br&gt;&lt;br&gt;*Rate limits*:&lt;br&gt;Burst: &#x60;3/s&#x60;&lt;br&gt;Steady: &#x60;60/m&#x60; Scopes: &#x60;custom-objects:read&#x60;

Options Hash (opts):



399
400
401
402
403
404
405
406
407
408
409
410
411
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
 
# File 'lib/klaviyo-api-sdk/api/custom_objects_api.rb', line 399

def get_data_sources_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomObjectsApi.get_data_sources ...'
  end
  allowable_values = ["title", "visibility", "description"]
  if @api_client.config.client_side_validation && opts[:'fields_data_source'] && !opts[:'fields_data_source'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"fields_data_source\", must include one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling CustomObjectsApi.get_data_sources, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/data-sources'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields[data-source]'] = @api_client.build_collection_param(opts[:'fields_data_source'], :csv) if !opts[:'fields_data_source'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # klaviyo api revision
  header_params['revision'] =  ENV['KLAVIYO_API_REVISION'] || ENV['API_REVISION'] || "2026-01-15"
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.api+json'])

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Hash<String, Object>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Klaviyo-API-Key', 'OAuth']

  new_options = opts.merge(
    :operation => :"CustomObjectsApi.get_data_sources",
    :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: CustomObjectsApi#get_data_sources\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end